Oracle UIX API Reference
Release 2.1.22.0.0
B12196-01

oracle.cabo.ui.beans.form
Class TextInputBean

java.lang.Object
  |
  +--oracle.cabo.ui.DeprecatedUINode
        |
        +--oracle.cabo.ui.BaseUINode
              |
              +--oracle.cabo.ui.BaseMutableUINode
                    |
                    +--oracle.cabo.ui.beans.BaseWebBean
                          |
                          +--oracle.cabo.ui.beans.MarlinBean
                                |
                                +--oracle.cabo.ui.beans.form.FormElementBean
                                      |
                                      +--oracle.cabo.ui.beans.form.TextInputBean
All Implemented Interfaces:
MutableUINode, UIConstants, UINode
Direct Known Subclasses:
DateFieldBean, LovFieldBean, LovInputBean, MessageTextInputBean, TextInputBean

public class TextInputBean
extends FormElementBean

User interface single- and multi-line text controls, including password fields.

The textinput control creates a browser input text widget. Depending on the numer of rows, this control either maps to a textfield (for single row controls) or textarea (for multiple row text controls). If the input should be hidden from the user while displayed, such as for passwords, the secret property should be used.

Text will be entered in numeric format (right aligned for most locales) if a DecimalValidater is attached.

Example:

Simple text input box with the some default text.

    <form name="myform" method="GET">
     <contents>
      <textInput text="Some text " name="textbtn1"/>
     </contents>
    </form>

A slightly more interesting example showing a text box twenty five characters in length with hidden input text.

    <form name="myform" method="GET">
     <contents>
      <textInput name="SecretTextVar"
                 columns="25"
                 required="no"
                 secret="true"
                 text="secret text:"/>
     </contents>
    </form>

A text input box which will display three rows of wrapped input text, with a vertical scrollbar. If the text is changed, an alert will say so.

    <form name="myform" method="GET">
     <contents>
      <textInput name="ChangeNotifiedTextBox"
                 rows="3"
                 wrap="soft"
                 onChange="alert('ChangeNotifiedTextBox has changed.')"
                 text="Alert on change."/>
     </contents>
    </form>

A text input, the contents of which will be in numeric format (right aligned for most locales). The validater ensures the contents is a number as user leaves box.

    <form name="myform" method="GET">
      <contents>
        <textInput name="numeric format" required="yes">
            <onBlurValidater>
                <decimal/>
            </onBlurValidater>
            <contents/>
        </textInput>
      </contents>
    </form>

It does not support any children.


Fields inherited from interface oracle.cabo.ui.UIConstants
ABOUT_CHILD, ACCESS_KEY_ATTR, ADD_NAME, ADD_ROWS_EVENT, ADD_TABLE_ROW_NAME, AGENT_NAME, ALL_DETAILS_ENABLED_ATTR, ALTERNATE_CONTENT_CHILD, ALTERNATE_TEXT_ATTR, ANCESTOR_ATTRIBUTE_NAME, ANCESTOR_ID_ATTR, ANCESTOR_PATH_ATTR, ANCHOR_ATTR, AND_NAME, APPLICATION_SWITCHER_NAME, ARRAY_NODE_LIST_NAME, ATTRIBUTE_MAP_NAME, AUTOFLIP_ATTR, AUTOMATIC_ATTR, AUTOSTART_ATTR, BACKGROUND_ATTR, BACKGROUND_DARK, BACKGROUND_LIGHT, BACKGROUND_MEDIUM, BANDING_INTERVAL_KEY, BANDING_SHADE_DARK, BANDING_SHADE_KEY, BANDING_SHADE_LIGHT, BEAN_NAME, BETWEEN_TEXT_ATTR, BLOCK_SIZE_ATTR, BODY_NAME, BORDER_LAYOUT_NAME, BORDER_WIDTH_ATTR, BOTTOM_CHILD, BOUND_ATTRIBUTE_NAME, BOUND_MESSAGE_NAME, BOUND_TEXT_NAME, BOUND_VALUE_PROVIDER_NAME, BREAD_CRUMBS_NAME, BROWSE_EVENT, BROWSE_MENU_NAME, BULLETED_LIST_NAME, BUNDLE_NAME, BUTTON_NAME, BYTE_LENGTH_NAME, CALENDAR_NAME, CANCEL_EVENT, CASE_NAME, CATCH_CHILD, CATEGORIES_CHILD, CATEGORY_TITLE_ATTR, CELL_FORMAT_NAME, CELL_NO_WRAP_FORMAT_KEY, CELL_PADDING_ATTR, CELL_SPACING_ATTR, CENTER_CHILD, CHECK_BOX_NAME, CHECKED_ATTR, CHILD_DATA_ATTR, CHILD_LIST_NAME, CHILD_MAP_NAME, CHILD_NAME_ATTR, CHOICE_NAME, COBRANDING_CHILD, COLLAPSE_ALL_EVENT, COLLAPSE_DESTINATION_KEY, COLUMN_BANDING, COLUMN_DATA_FORMAT_KEY, COLUMN_FOOTER_CHILD, COLUMN_FORMAT_ATTR, COLUMN_FORMATS_ATTR, COLUMN_GROUP_NAME, COLUMN_HEADER_CHILD, COLUMN_HEADER_DATA_ATTR, COLUMN_HEADER_FORMAT_ATTR, COLUMN_HEADER_FORMATS_ATTR, COLUMN_HEADER_STAMP_CHILD, COLUMN_NAME, COLUMN_SPAN_ATTR, COLUMNS_ATTR, COMPARISON_NAME, COMPARISON_TYPE_EQUALS, COMPARISON_TYPE_GREATER_THAN, COMPARISON_TYPE_GREATER_THAN_OR_EQUALS, COMPARISON_TYPE_LESS_THAN, COMPARISON_TYPE_LESS_THAN_OR_EQUALS, COMPARISON_TYPE_NOT_EQUALS, COMPOSITE_ROLE, CONCAT_NAME, CONCISE_MESSAGE_CHILD, CONSUMER_NAME, CONTENT_CONTAINER_NAME, CONTENT_FOOTER_CHILD, CONTENT_FOOTER_NAME, CONTENT_FORM_CHILD, CONTENT_LINK_CHILD, CONTENT_STYLE_CLASS_ATTR, CONTENT_TYPE_ATTR, CONTENTS_NAME, CONTEXT_POPPING_NAME, CONTEXT_PROPERTY_NAME, CONTEXT_SWITCHER_CHILD, CONTROLS_ALL, CONTROLS_ATTR, CONTROLS_MINIMAL, CONTROLS_NONE, CONTROLS_NONE_VISIBLE, CONTROLS_TYPICAL, COPYRIGHT_CHILD, CORPORATE_BRANDING_CHILD, CURRENT_DATA_ATTR, CURRENT_THROWABLE_PROPERTY, DATA_KEY, DATA_NAME, DATA_NAME_ATTR, DATA_NAMESPACE_ATTR, DATA_OBJECT_NAME, DATA_SCOPE_NAME, DATE_BUTTON_NAME, DATE_EVENT, DATE_FIELD_NAME, DATE_FORMAT_NAME, DATE_NAME, DECIMAL_NAME, DEFAULT_CASE_ATTR, DEFAULT_CONTENTS_ATTR, DEFAULT_NAME, DEFAULTING_NAME, DESCRIPTION_KEY, DESTINATION_ATTR, DESTINATION_KEY, DESTINATION_TEXT_KEY, DETAIL_CHILD, DETAIL_DISCLOSURE_ATTR, DETAIL_SELECTOR_NAME, DETAILED_MESSAGE_CHILD, DIRECTION_ATTR, DIRTY_ATTR, DISABLED_ATTR, DISCLOSED_ATTR, DISCLOSED_KEY, DISCLOSED_TEXT_ATTR, DISPLAY_EXCEPTION_NAME, DISPLAY_GRID_KEY, DOCUMENT_NAME, ENCODED_PARAMETER_NAME, END_CHILD, EVENT_PARAM, EXCEPTIONS_CAUGHT_PROPERTY, EXPAND_ALL_EVENT, EXPAND_DESTINATION_KEY, EXPAND_EVENT, EXPANDABLE_COLLAPSED, EXPANDABLE_EXPANDED, EXPANDABLE_KEY, EXPANDABLE_NO, FACET_DEFAULT, FACET_EMAIL, FACET_PORTLET, FACET_PRINTABLE, FIELD_WIDTH_ATTR, FILE_UPLOAD_NAME, FILTER_CHILD, FILTER_CHOICE_CHILD, FIXED_NAME, FLOW_LAYOUT_NAME, FOCUS_EVENT, FOOTER_NAME, FOOTNOTE_CHILD, FORM_DATA_ATTR, FORM_NAME, FORM_NAME_ATTR, FORM_NAME_PROPERTY, FORM_PARAMETER_NAME, FORM_SUBMITTED_ATTR, FORM_VALUE_NAME, FORMAT_NAME, FORMATTED_TEXT_NAME, FRAME_BORDER_LAYOUT_NAME, FRAME_NAME, GENERATES_CONTENT_ATTR, GLOBAL_BUTTON_BAR_NAME, GLOBAL_BUTTON_NAME, GLOBAL_BUTTONS_CHILD, GLOBAL_HEADER_NAME, GOTO_EVENT, H_ALIGN_ATTR, H_ALIGN_CENTER, H_ALIGN_END, H_ALIGN_LEFT, H_ALIGN_RIGHT, H_ALIGN_START, H_GRID_NAME, HARD_WRAP, HEAD_NAME, HEADER_INSTRUCTIONS_CHILD, HEADER_NAME, HEADERS_ATTR, HEIGHT_ATTR, HIDE_EVENT, HIDE_SHOW_HEADER_NAME, HIDE_SHOW_NAME, ICON_ATTR, ICON_BUTTON_FORMAT, ICON_KEY, ID_ATTR, IF_NAME, IMAGE_ATTR, IMAGE_MAP_TYPE_ATTR, IMAGE_MAP_TYPE_NONE, IMAGE_MAP_TYPE_SERVER, IMAGE_NAME, IMPORT_SCRIPT_NAME, INCLUDE_NAME, INLINE_MESSAGE_NAME, INLINE_NAME, INLINE_STYLE_ATTR, INNER_BOTTOM_CHILD, INNER_END_CHILD, INNER_HEIGHT_ATTR, INNER_LEFT_CHILD, INNER_RIGHT_CHILD, INNER_START_CHILD, INNER_TOP_CHILD, INNER_WIDTH_ATTR, INSERTED_NODE_LIST_NAME, INSTANCE_NAME, ITEM_TITLE_ATTR, ITEMS_CHILD, LABEL_CHILD, LABEL_WIDTH_ATTR, LABELED_FIELD_LAYOUT_NAME, LABELED_NODE_ID_ATTR, LANGUAGE_ATTR, LARGE_ADVERTISEMENT_CHILD, LEADING_CHILD, LEADING_DESC_SHOWN_ATTR, LEADING_FOOTER_CHILD, LEADING_HEADER_ATTR, LEFT_CHILD, LINK_NAME, LIST_NAME, LIST_OF_VALUES_NAME, LIST_STYLE_ATTR, LIST_STYLE_CIRCLE, LIST_STYLE_DECIMAL, LIST_STYLE_DISC, LIST_STYLE_LOWER_ALPHA, LIST_STYLE_NONE, LIST_STYLE_SQUARE, LIST_STYLE_UPPER_ALPHA, LOCATION_CHILD, LOCATION_PARAM, LONG_DESC_ATTR, LONG_DESC_URL_ATTR, LOV_EVENT, LOV_FIELD_NAME, LOV_FILTER_EVENT, LOV_INPUT_NAME, LOV_LIBRARY_NAME, LOV_SEARCH_TEXT, MAILTO_NAME, MARLIN_NAMESPACE, MAX_VALUE_ATTR, MAX_VALUE_UNKNOWN, MAX_VISITED_ATTR, MAXIMUM_LENGTH_ATTR, MEDIA_NAME, MEDIUM_ADVERTISEMENT_CHILD, MESSAGE_ATTR, MESSAGE_BOX_NAME, MESSAGE_CHECK_BOX_NAME, MESSAGE_CHOICE_NAME, MESSAGE_DATE_FIELD_NAME, MESSAGE_FILE_UPLOAD_NAME, MESSAGE_FORMAT_NAME, MESSAGE_LIST_NAME, MESSAGE_LOV_FIELD_NAME, MESSAGE_LOV_INPUT_NAME, MESSAGE_PROMPT_NAME, MESSAGE_RADIO_BUTTON_NAME, MESSAGE_RADIO_GROUP_NAME, MESSAGE_STYLED_TEXT_NAME, MESSAGE_TEXT_INPUT_NAME, MESSAGE_TEXT_NAME, MESSAGE_TYPE_ATTR, MESSAGE_TYPE_CONFIRMATION, MESSAGE_TYPE_ERROR, MESSAGE_TYPE_INFO, MESSAGE_TYPE_NONE, MESSAGE_TYPE_PROCESSING, MESSAGE_TYPE_WARNING, MESSAGES_CHILD, META_CONTAINER_CHILD, METHOD_ATTR, METHOD_NAME, MIN_VALUE_ATTR, MINIMUM_WIDTH_ATTR, MULTIPLE_ATTR, MULTIPLE_SELECTION_NAME, NAME_ATTR, NAME_TRANSFORMED_ATTR, NAME_VALUES_ATTR, NAMED_SOURCE_ATTR, NAMES_ATTR, NAVIGATE_EVENT, NAVIGATION_BAR_NAME, NAVIGATION_FORM_NAME_ATTR, NO_BANDING, NODE_ATTR, NODE_PARAM, NODE_STAMP_CHILD, NODES_ATTR, NODES_KEY, NOT_NAME, NUMBER_FORMAT, ON_BLUR_ATTR, ON_BLUR_VALIDATER_ATTR, ON_CHANGE_ATTR, ON_CLICK_ATTR, ON_CLICK_KEY, ON_DOUBLE_CLICK_ATTR, ON_FOCUS_ATTR, ON_KEY_DOWN_ATTR, ON_KEY_PRESS_ATTR, ON_KEY_UP_ATTR, ON_LOAD_ATTR, ON_LOV_INIT_ATTR, ON_LOV_SELECT_ATTR, ON_LOV_VALIDATE_ATTR, ON_MOUSE_DOWN_ATTR, ON_MOUSE_MOVE_ATTR, ON_MOUSE_OUT_ATTR, ON_MOUSE_OVER_ATTR, ON_MOUSE_UP_ATTR, ON_NAVIGATE_ATTR, ON_SELECT_ATTR, ON_SUBMIT_ATTR, ON_SUBMIT_VALIDATER_ATTR, ON_SWITCH_APP_ATTR, ON_UNLOAD_ATTR, OPTION_NAME, OR_NAME, ORIENTATION_ATTR, ORIENTATION_BOTTOM, ORIENTATION_DEFAULT, ORIENTATION_HORIZONTAL, ORIENTATION_TOP, ORIENTATION_VERTICAL, PAGE_BUTTON_BAR_NAME, PAGE_BUTTONS_CHILD, PAGE_HEADER_CHILD, PAGE_HEADER_LAYOUT_NAME, PAGE_LAYOUT_NAME, PAGE_STATUS_CHILD, PARSE_NAME, PARTIAL_CONTENT_NAME, PARTIAL_LINK_NAME, PARTIAL_NODE_ID_ATTR, PARTIAL_PAGE_CONTEXT_PROPERTY, PARTIAL_PARAM, PARTIAL_RENDER_ENABLED_ATTR, PARTIAL_RENDER_MODE_ATTR, PARTIAL_RENDER_MODE_MULTIPLE, PARTIAL_RENDER_MODE_NONE, PARTIAL_RENDER_MODE_SELF, PARTIAL_ROOT_NAME, PARTIAL_SUBMIT_BUTTON_NAME, PARTIAL_TARGET_IDS_ATTR, PARTIAL_TARGETS_ATTR, PARTIAL_TARGETS_PARAM, PERCENT_COMPLETE_ATTR, PERCENT_UNKNOWN, PLAY_COUNT_ATTR, PLAYER_ATTR, PLAYER_LINK, PLAYER_QUICKTIME, PLAYER_REAL, PLAYER_WINDOWS, PORTLET_NAME, POST_TEXT_ATTR, PRE_TEXT_ATTR, PRIMARY_CLIENT_ACTION_ATTR, PRIVACY_CHILD, PROCESS_STEPS_NAME, PROCESSING_LAYOUT_NAME, PROCESSING_NAME, PRODUCT_BRANDING_CHILD, PRODUCT_BRANDING_NAME, PROMPT_ATTR, PROMPT_CHILD, PROVIDER_ATTR, PROXIED_ATTR, PROXY_ATTR, QUICK_LINKS_NAME, QUICK_LINKS_SHOWN_ATTR, QUICK_SEARCH_CHILD, RADIO_BUTTON_NAME, RADIO_GROUP_NAME, RADIO_GROUP_TYPE_CHOICE, RADIO_GROUP_TYPE_RADIO, RADIO_OPTION_NAME, RADIO_SET_NAME, RAW_TEXT_NAME, READ_ONLY_ATTR, REFRESH_EVENT, REG_EXP_NAME, RENDERED_ATTR, REORDERABLE_ATTR, REQUIRED_ATTR, REQUIRED_NO, REQUIRED_UI_ONLY, REQUIRED_VALIDATER_ONLY, REQUIRED_YES, RESET_BUTTON_NAME, RETURN_NAVIGATION_CHILD, RIGHT_CHILD, ROOT_ATTRIBUTE_MAP_NAME, ROOT_CHILD_EXISTS_NAME, ROOT_CHILD_LIST_NAME, ROOT_CHILD_MAP_NAME, ROOT_CHILD_NAME, ROOT_PARAM, ROW_BANDING, ROW_FORMATS_ATTR, ROW_HEADER_DATA_ATTR, ROW_HEADER_FORMATS_ATTR, ROW_HEADER_STAMP_CHILD, ROW_LAYOUT_NAME, ROW_SPAN_ATTR, ROWS_ATTR, SAMPLE_NAME, SCRIPT_NAME, SCROLLED_VALUE_ATTR, SCROLLING_ATTR, SCROLLING_AUTO, SCROLLING_NO, SCROLLING_YES, SEARCH_INSTRUCTIONS_CHILD, SEARCH_TEXT_ATTR, SECRET_ATTR, SELECT_ATTR, SELECTED_ATTR, SELECTED_INDEX_ATTR, SELECTED_KEY, SELECTED_VALUE_ATTR, SELECTION_ATTR, SELECTION_PARAM, SEPARATOR_CHILD, SEPARATOR_NAME, SERVER_VALIDATER_ATTR, SERVLET_INCLUDE_NAME, SHORT_DESC_ATTR, SHORT_TEXT_ATTR, SHOW_ALL_ACTIVE, SHOW_ALL_ATTR, SHOW_ALL_NO, SHOW_ALL_YES, SHOW_EVENT, SHOW_WINDOW_ATTR, SHUTTLE_NAME, SIDE_BAR_NAME, SIDE_NAV_NAME, SINGLE_SELECTION_NAME, SINGLE_STEP, SIZE_ATTR, SIZE_PARAM, SLIM_ATTR, SOFT_WRAP, SORT_EVENT, SORT_STATE_ASCENDING, SORT_STATE_DESCENDING, SORTABLE_ASCENDING, SORTABLE_ATTR, SORTABLE_DESCENDING, SORTABLE_HEADER_NAME, SORTABLE_NO, SORTABLE_YES, SOURCE_ATTR, SOURCE_PARAM, SPACER_NAME, STACK_LAYOUT_NAME, STANDBY_TEXT_ATTR, START_CHILD, STATE_PARAM, STATE_ROLE, STEPS_COMPLETE_ATTR, STRUCTURAL_ROLE, STYLE_CLASS_ATTR, STYLE_SHEET_NAME, STYLED_ITEM_NAME, STYLED_LIST_NAME, STYLED_TEXT_NAME, SUB_TAB_BAR_NAME, SUB_TAB_LAYOUT_NAME, SUB_TABS_CHILD, SUBMIT_BUTTON_NAME, SUMMARY_ATTR, SWITCH_APP_EVENT, SWITCH_APP_TYPE_BACK, SWITCH_APP_TYPE_GOTO, SWITCHER_NAME, TAB_BAR_NAME, TABLE_BANDING_KEY, TABLE_DATA_ATTR, TABLE_FILTER_CHILD, TABLE_FORMAT_ATTR, TABLE_LAYOUT_NAME, TABLE_NAME, TABLE_NAME_ATTR, TABLE_SELECTION_CHILD, TABS_CHILD, TARGET_FRAME_ATTR, TARGET_FRAME_KEY, TEMPLATE_DEFINITION_NAME, TEMPLATE_IMPORT_NAME, TEMPLATE_LIBRARY_NAME, TEMPLATES_NAME, TEXT_ATTR, TEXT_FORMAT, TEXT_INPUT_NAME, TEXT_KEY, TEXT_NAME, THREADED_ATTR, THREADED_LAYOUT_NAME, TIME_INTERVAL_ATTR, TIP_ATTR, TIP_NAME, TITLE_ATTR, TOP_CHILD, TOTAL_ROW_NAME, TRAILING_CHILD, TRAILING_DESC_SHOWN_ATTR, TRAILING_FOOTER_CHILD, TRAILING_HEADER_ATTR, TRAIN_NAME, TREE_DATA_ATTR, TREE_NAME, TRY_NAME, TYPE_ATTR, TYPE_PARAM, TYPE_POST, TYPE_PRE, TYPE_TEXT_ATTR, UNDISCLOSED_TEXT_ATTR, UNKNOWN_ROLE, UNVALIDATED_ATTR, UPDATE_EVENT, URI_PARAM, URL_INCLUDE_NAME, USER_INFO_CHILD, USER_INVISIBLE_ROLE, USES_UPLOAD_ATTR, UTF8_LENGTH_NAME, V_ALIGN_ABSMIDDLE, V_ALIGN_ATTR, V_ALIGN_BOTTOM, V_ALIGN_MIDDLE, V_ALIGN_TOP, VALID_ATTR, VALIDATE_BLANKS_ATTR, VALUE_ATTR, VALUE_COLUMNS_ATTR, VALUE_PARAM, VALUE_SHOW_ALL, WIDTH_ATTR, WIDTH_KEY, WML_NAME, WRAP_ATTR, WRAPPING_DISABLED_ATTR
 
Constructor Summary
  TextInputBean()
          Construct an instance of the TextInputBean.
protected TextInputBean(boolean ignored, java.lang.String localName)
          Construct an instance of the TextInputBean.
  TextInputBean(java.lang.String name)
          Construct an instance of the TextInputBean.
  TextInputBean(java.lang.String name, java.lang.String text)
          Construct an instance of the TextInputBean.
  TextInputBean(java.lang.String name, java.lang.String text, int columns, int rows)
          Construct an instance of the TextInputBean.
 
Method Summary
 int getColumns()
          Gets the number of columns to display in the text control.
static int getColumns(MutableUINode bean)
          Gets the number of columns to display in the text control.
 int getMaximumLength()
          Gets the maximum number of characters per line that can be entered into the text control.
static int getMaximumLength(MutableUINode bean)
          Gets the maximum number of characters per line that can be entered into the text control.
 ClientValidater getOnBlurValidater()
          Gets ClientValidater to fire on the client whenever the TextInputBean loses keyboard focus.
static ClientValidater getOnBlurValidater(MutableUINode bean)
          Gets ClientValidater to fire on the client whenever the TextInputBean loses keyboard focus.
 java.lang.String getOnChange()
          Gets event handler for when the value is changed.
static java.lang.String getOnChange(MutableUINode bean)
          Gets event handler for when the value is changed.
 java.lang.String getOnSelect()
          Gets event handler for when text becomes selected.
static java.lang.String getOnSelect(MutableUINode bean)
          Gets event handler for when text becomes selected.
 ClientValidater getOnSubmitValidater()
          Gets ClientValidater to fire on the client whenever the form containing the TextInputBean is submitted.
static ClientValidater getOnSubmitValidater(MutableUINode bean)
          Gets ClientValidater to fire on the client whenever the form containing the TextInputBean is submitted.
 java.lang.String getRequired()
          Gets whether the associated control requires user input.
static java.lang.String getRequired(MutableUINode bean)
          Gets whether the associated control requires user input.
 int getRows()
          Gets the number of rows to display in the text control.
static int getRows(MutableUINode bean)
          Gets the number of rows to display in the text control.
 java.lang.String getText()
          Gets the text value of the input field.
static java.lang.String getText(MutableUINode bean)
          Gets the text value of the input field.
 java.lang.String getWrap()
          Gets the type of text wrapping to be used in a multi-row text control.
static java.lang.String getWrap(MutableUINode bean)
          Gets the type of text wrapping to be used in a multi-row text control.
 boolean isSecret()
          Gets a boolean value that only applies to single line text controls.
static boolean isSecret(MutableUINode bean)
          Gets a boolean value that only applies to single line text controls.
 void setColumns(int columns)
          Sets the number of columns to display in the text control.
static void setColumns(MutableUINode bean, int columns)
          Sets the number of columns to display in the text control.
 void setMaximumLength(int maximumLength)
          Sets the maximum number of characters per line that can be entered into the text control.
static void setMaximumLength(MutableUINode bean, int maximumLength)
          Sets the maximum number of characters per line that can be entered into the text control.
 void setOnBlurValidater(ClientValidater onBlurValidater)
          Sets ClientValidater to fire on the client whenever the TextInputBean loses keyboard focus.
static void setOnBlurValidater(MutableUINode bean, ClientValidater onBlurValidater)
          Sets ClientValidater to fire on the client whenever the TextInputBean loses keyboard focus.
static void setOnChange(MutableUINode bean, java.lang.String onChange)
          Sets event handler for when the value is changed.
 void setOnChange(java.lang.String onChange)
          Sets event handler for when the value is changed.
static void setOnSelect(MutableUINode bean, java.lang.String onSelect)
          Sets event handler for when text becomes selected.
 void setOnSelect(java.lang.String onSelect)
          Sets event handler for when text becomes selected.
 void setOnSubmitValidater(ClientValidater onSubmitValidater)
          Sets ClientValidater to fire on the client whenever the form containing the TextInputBean is submitted.
static void setOnSubmitValidater(MutableUINode bean, ClientValidater onSubmitValidater)
          Sets ClientValidater to fire on the client whenever the form containing the TextInputBean is submitted.
static void setRequired(MutableUINode bean, java.lang.String required)
          Sets whether the associated control requires user input.
 void setRequired(java.lang.String required)
          Sets whether the associated control requires user input.
 void setRows(int rows)
          Sets the number of rows to display in the text control.
static void setRows(MutableUINode bean, int rows)
          Sets the number of rows to display in the text control.
 void setSecret(boolean secret)
          Sets a boolean value that only applies to single line text controls.
static void setSecret(MutableUINode bean, boolean secret)
          Sets a boolean value that only applies to single line text controls.
static void setText(MutableUINode bean, java.lang.String text)
          Sets the text value of the input field.
 void setText(java.lang.String text)
          Sets the text value of the input field.
 void setTextBinding(BoundValue boundValue)
          Binds the the text value of the input field.
static void setTextBinding(MutableUINode bean, BoundValue boundValue)
          Binds the the text value of the input field.
static void setTextBinding(MutableUINode bean, java.lang.Object selectKey)
          Binds the the text value of the input field.
static void setTextBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
          Binds the the text value of the input field.
 void setTextBinding(java.lang.Object selectKey)
          Binds the the text value of the input field.
 void setTextBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey)
          Binds the the text value of the input field.
static void setTranslatableText(MutableUINode bean, java.lang.String bundleName, java.lang.String key)
          Binds to a ResourceBundle the the text value of the input field.
 void setTranslatableText(java.lang.String bundleName, java.lang.String key)
          Binds to a ResourceBundle the the text value of the input field.
static void setWrap(MutableUINode bean, java.lang.String wrap)
          Sets the type of text wrapping to be used in a multi-row text control.
 void setWrap(java.lang.String wrap)
          Sets the type of text wrapping to be used in a multi-row text control.
 
Methods inherited from class oracle.cabo.ui.beans.form.FormElementBean
getName, getName, getOnBlur, getOnBlur, getOnFocus, getOnFocus, isDisabled, isDisabled, isReadOnly, isReadOnly, setDisabled, setDisabled, setName, setName, setNameBinding, setNameBinding, setNameBinding, setNameBinding, setNameBinding, setNameBinding, setOnBlur, setOnBlur, setOnFocus, setOnFocus, setReadOnly, setReadOnly
 
Methods inherited from class oracle.cabo.ui.beans.MarlinBean
isEqualMarlinName
 
Methods inherited from class oracle.cabo.ui.beans.BaseWebBean
getDirection, getID, getID, getInlineStyle, getInlineStyle, getLanguage, getOnClick, getOnClick, getOnDoubleClick, getOnDoubleClick, getOnKeyDown, getOnKeyDown, getOnKeyPress, getOnKeyPress, getOnKeyUp, getOnKeyUp, getOnMouseDown, getOnMouseDown, getOnMouseMove, getOnMouseMove, getOnMouseOut, getOnMouseOut, getOnMouseOver, getOnMouseOver, getOnMouseUp, getOnMouseUp, getShortDesc, getShortDesc, getStyleClass, getStyleClass, isRendered, isRendered, resolveBoolean, resolveBoolean, resolveBoolean, resolveBoolean, resolveCharacter, resolveCharacter, resolveInteger, resolveInteger, resolveInteger, resolveInteger, resolveLong, resolveLong, resolveLong, resolveLong, resolveObject, resolveString, resolveString, setDirection, setID, setID, setInlineStyle, setInlineStyle, setLanguage, setOnClick, setOnClick, setOnDoubleClick, setOnDoubleClick, setOnKeyDown, setOnKeyDown, setOnKeyPress, setOnKeyPress, setOnKeyUp, setOnKeyUp, setOnMouseDown, setOnMouseDown, setOnMouseMove, setOnMouseMove, setOnMouseOut, setOnMouseOut, setOnMouseOver, setOnMouseOver, setOnMouseUp, setOnMouseUp, setRendered, setRendered, setShortDesc, setShortDesc, setStyleClass, setStyleClass
 
Methods inherited from class oracle.cabo.ui.BaseMutableUINode
addIndexedChild, addIndexedChild, addIndexedChild, addIndexedChildren, addIndexedChildren, clearIndexedChildren, createAttributeMap, createIndexedNodeList, createNamedChildMap, getAttributeMap, getAttributeMap, getAttributeValue, getAttributeValue, getIndexedChildCount, getIndexedNodeList, getIndexedNodeList, getNamedChildMap, getNamedChildMap, removeIndexedChild, replaceIndexedChild, setAttributeDictionary, setAttributeMap, setAttributeValue, setAttributeValue, setAttributeValue, setIndexedNodeList, setNamedChild, setNamedChildMap, setNodeID
 
Methods inherited from class oracle.cabo.ui.BaseUINode
getAttributeNames, getAttributeValue, getAttributeValueImpl, getChildArray, getChildNames, getIndexedChild, getIndexedChild, getIndexedChildCount, getLocalName, getNamedChild, getNamespaceURI, getNodeID, getNodeRole, getPreorderDescendentAttributeValue, getRawAttributeValue, getRenderedUINode, getRenderer, getRenderer, render, render, toString
 
Methods inherited from class oracle.cabo.ui.DeprecatedUINode
getAttributeValue, getChildNames, getNamedChild
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface oracle.cabo.ui.UINode
getAttributeNames, getAttributeValue, getAttributeValue, getChildNames, getChildNames, getIndexedChild, getIndexedChild, getIndexedChildCount, getLocalName, getNamedChild, getNamedChild, getNamespaceURI, getNodeID, getNodeRole, getRawAttributeValue, render, render
 

Constructor Detail

TextInputBean

public TextInputBean()
Construct an instance of the TextInputBean.

TextInputBean

public TextInputBean(java.lang.String name)
Construct an instance of the TextInputBean.
Parameters:
name - the name used to identify the element in client-to-client or client-to-server events.

TextInputBean

public TextInputBean(java.lang.String name,
                     java.lang.String text)
Construct an instance of the TextInputBean.
Parameters:
name - the name used to identify the element in client-to-client or client-to-server events.
text - the text value of the input field.

TextInputBean

public TextInputBean(java.lang.String name,
                     java.lang.String text,
                     int columns,
                     int rows)
Construct an instance of the TextInputBean.
Parameters:
name - the name used to identify the element in client-to-client or client-to-server events.
text - the text value of the input field.
columns - the number of columns to display in the text control.
rows - the number of rows to display in the text control.

TextInputBean

protected TextInputBean(boolean ignored,
                        java.lang.String localName)
Construct an instance of the TextInputBean. Provided for subclasses that need distinct local names..
Method Detail

getOnBlurValidater

public final ClientValidater getOnBlurValidater()
Gets ClientValidater to fire on the client whenever the TextInputBean loses keyboard focus.

setOnBlurValidater

public final void setOnBlurValidater(ClientValidater onBlurValidater)
Sets ClientValidater to fire on the client whenever the TextInputBean loses keyboard focus.

getOnSubmitValidater

public final ClientValidater getOnSubmitValidater()
Gets ClientValidater to fire on the client whenever the form containing the TextInputBean is submitted.

setOnSubmitValidater

public final void setOnSubmitValidater(ClientValidater onSubmitValidater)
Sets ClientValidater to fire on the client whenever the form containing the TextInputBean is submitted.

getText

public final java.lang.String getText()
Gets the text value of the input field.

setText

public final void setText(java.lang.String text)
Sets the text value of the input field.

setTranslatableText

public final void setTranslatableText(java.lang.String bundleName,
                                      java.lang.String key)
Binds to a ResourceBundle the the text value of the input field.
Parameters:
bundleName - the name of the ResourceBundle
key - the key of the string to retrieve from the ResourceBundle

setTextBinding

public final void setTextBinding(BoundValue boundValue)
Binds the the text value of the input field.
Parameters:
boundValue - a BoundValue implementation to be used to retrieve the value.

setTextBinding

public final void setTextBinding(java.lang.Object selectKey)
Binds the the text value of the input field.
Parameters:
selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setTextBinding

public final void setTextBinding(java.lang.String dataNamespace,
                                 java.lang.String dataName,
                                 java.lang.Object selectKey)
Binds the the text value of the input field.
Parameters:
dataNamespace - the namespace to be passed to RenderingContext.getDataObject()
dataName - the name to be passed to RenderingContext.getDataObject()
selectKey - the key to be passed to selectValue() on the DataObject.

getRows

public final int getRows()
Gets the number of rows to display in the text control. The default is one. Setting to more than one row precludes the use of some attributes, such as "secret".

setRows

public final void setRows(int rows)
Sets the number of rows to display in the text control. The default is one. Setting to more than one row precludes the use of some attributes, such as "secret".

getColumns

public final int getColumns()
Gets the number of columns to display in the text control. If no value is specified, a default of 30 columns is used. One column is approximately one character in the browser's current display font.

setColumns

public final void setColumns(int columns)
Sets the number of columns to display in the text control. If no value is specified, a default of 30 columns is used. One column is approximately one character in the browser's current display font.

getMaximumLength

public final int getMaximumLength()
Gets the maximum number of characters per line that can be entered into the text control. Note that this value is independent of the "cols" displayed.

setMaximumLength

public final void setMaximumLength(int maximumLength)
Sets the maximum number of characters per line that can be entered into the text control. Note that this value is independent of the "cols" displayed.

getWrap

public final java.lang.String getWrap()
Gets the type of text wrapping to be used in a multi-row text control. This attribute is ignored for single row controls. By default, multirow text does not wrap at the column edge, but instead scrolls horizontally. Setting the value for this attribute to "soft" indicates that the text should wrap visually, but not include carriage returns in the value. Setting it to "hard" specifies that the value of the text should include any carriage returns needed to wrap the lines.

setWrap

public final void setWrap(java.lang.String wrap)
Sets the type of text wrapping to be used in a multi-row text control. This attribute is ignored for single row controls. By default, multirow text does not wrap at the column edge, but instead scrolls horizontally. Setting the value for this attribute to "soft" indicates that the text should wrap visually, but not include carriage returns in the value. Setting it to "hard" specifies that the value of the text should include any carriage returns needed to wrap the lines.

isSecret

public final boolean isSecret()
Gets a boolean value that only applies to single line text controls. When set to "true", it hides the actual value of the text from the user.

setSecret

public final void setSecret(boolean secret)
Sets a boolean value that only applies to single line text controls. When set to "true", it hides the actual value of the text from the user.

getRequired

public final java.lang.String getRequired()
Gets whether the associated control requires user input. Three values are allowed: These interact with any ClientValidaters attached to the TextInputBean to determine whether field validation succeeds or fails.

The default of this attribute is "no".


setRequired

public final void setRequired(java.lang.String required)
Sets whether the associated control requires user input. Three values are allowed: These interact with any ClientValidaters attached to the TextInputBean to determine whether field validation succeeds or fails.

The default of this attribute is "no".


getOnChange

public final java.lang.String getOnChange()
Gets event handler for when the value is changed.

setOnChange

public final void setOnChange(java.lang.String onChange)
Sets event handler for when the value is changed.

getOnSelect

public final java.lang.String getOnSelect()
Gets event handler for when text becomes selected.

setOnSelect

public final void setOnSelect(java.lang.String onSelect)
Sets event handler for when text becomes selected.

getOnBlurValidater

public static ClientValidater getOnBlurValidater(MutableUINode bean)
Gets ClientValidater to fire on the client whenever the TextInputBean loses keyboard focus.

setOnBlurValidater

public static void setOnBlurValidater(MutableUINode bean,
                                      ClientValidater onBlurValidater)
Sets ClientValidater to fire on the client whenever the TextInputBean loses keyboard focus.

getOnSubmitValidater

public static ClientValidater getOnSubmitValidater(MutableUINode bean)
Gets ClientValidater to fire on the client whenever the form containing the TextInputBean is submitted.

setOnSubmitValidater

public static void setOnSubmitValidater(MutableUINode bean,
                                        ClientValidater onSubmitValidater)
Sets ClientValidater to fire on the client whenever the form containing the TextInputBean is submitted.

getText

public static java.lang.String getText(MutableUINode bean)
Gets the text value of the input field.

setText

public static void setText(MutableUINode bean,
                           java.lang.String text)
Sets the text value of the input field.

setTranslatableText

public static void setTranslatableText(MutableUINode bean,
                                       java.lang.String bundleName,
                                       java.lang.String key)
Binds to a ResourceBundle the the text value of the input field.
Parameters:
bundleName - the name of the ResourceBundle
key - the key of the string to retrieve from the ResourceBundle

setTextBinding

public static void setTextBinding(MutableUINode bean,
                                  BoundValue boundValue)
Binds the the text value of the input field.
Parameters:
boundValue - a BoundValue implementation to be used to retrieve the value.

setTextBinding

public static void setTextBinding(MutableUINode bean,
                                  java.lang.Object selectKey)
Binds the the text value of the input field.
Parameters:
selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setTextBinding

public static void setTextBinding(MutableUINode bean,
                                  java.lang.String dataNamespace,
                                  java.lang.String dataName,
                                  java.lang.Object selectKey)
Binds the the text value of the input field.
Parameters:
dataNamespace - the namespace to be passed to RenderingContext.getDataObject()
dataName - the name to be passed to RenderingContext.getDataObject()
selectKey - the key to be passed to selectValue() on the DataObject.

getRows

public static int getRows(MutableUINode bean)
Gets the number of rows to display in the text control. The default is one. Setting to more than one row precludes the use of some attributes, such as "secret".

setRows

public static void setRows(MutableUINode bean,
                           int rows)
Sets the number of rows to display in the text control. The default is one. Setting to more than one row precludes the use of some attributes, such as "secret".

getColumns

public static int getColumns(MutableUINode bean)
Gets the number of columns to display in the text control. If no value is specified, a default of 30 columns is used. One column is approximately one character in the browser's current display font.

setColumns

public static void setColumns(MutableUINode bean,
                              int columns)
Sets the number of columns to display in the text control. If no value is specified, a default of 30 columns is used. One column is approximately one character in the browser's current display font.

getMaximumLength

public static int getMaximumLength(MutableUINode bean)
Gets the maximum number of characters per line that can be entered into the text control. Note that this value is independent of the "cols" displayed.

setMaximumLength

public static void setMaximumLength(MutableUINode bean,
                                    int maximumLength)
Sets the maximum number of characters per line that can be entered into the text control. Note that this value is independent of the "cols" displayed.

getWrap

public static java.lang.String getWrap(MutableUINode bean)
Gets the type of text wrapping to be used in a multi-row text control. This attribute is ignored for single row controls. By default, multirow text does not wrap at the column edge, but instead scrolls horizontally. Setting the value for this attribute to "soft" indicates that the text should wrap visually, but not include carriage returns in the value. Setting it to "hard" specifies that the value of the text should include any carriage returns needed to wrap the lines.

setWrap

public static void setWrap(MutableUINode bean,
                           java.lang.String wrap)
Sets the type of text wrapping to be used in a multi-row text control. This attribute is ignored for single row controls. By default, multirow text does not wrap at the column edge, but instead scrolls horizontally. Setting the value for this attribute to "soft" indicates that the text should wrap visually, but not include carriage returns in the value. Setting it to "hard" specifies that the value of the text should include any carriage returns needed to wrap the lines.

isSecret

public static boolean isSecret(MutableUINode bean)
Gets a boolean value that only applies to single line text controls. When set to "true", it hides the actual value of the text from the user.

setSecret

public static void setSecret(MutableUINode bean,
                             boolean secret)
Sets a boolean value that only applies to single line text controls. When set to "true", it hides the actual value of the text from the user.

getRequired

public static java.lang.String getRequired(MutableUINode bean)
Gets whether the associated control requires user input. Three values are allowed: These interact with any ClientValidaters attached to the TextInputBean to determine whether field validation succeeds or fails.

The default of this attribute is "no".


setRequired

public static void setRequired(MutableUINode bean,
                               java.lang.String required)
Sets whether the associated control requires user input. Three values are allowed: These interact with any ClientValidaters attached to the TextInputBean to determine whether field validation succeeds or fails.

The default of this attribute is "no".


getOnChange

public static java.lang.String getOnChange(MutableUINode bean)
Gets event handler for when the value is changed.

setOnChange

public static void setOnChange(MutableUINode bean,
                               java.lang.String onChange)
Sets event handler for when the value is changed.

getOnSelect

public static java.lang.String getOnSelect(MutableUINode bean)
Gets event handler for when text becomes selected.

setOnSelect

public static void setOnSelect(MutableUINode bean,
                               java.lang.String onSelect)
Sets event handler for when text becomes selected.

Oracle UIX API Reference
Release 2.1.22.0.0
B12196-01

Copyright © 2002,2003, Oracle. All Rights Reserved.