Oracle UIX API Reference
Release 2.1.22.0.0
B12196-01

oracle.cabo.ui.beans.form
Class LovInputBean

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
                                            |
                                            +--oracle.cabo.ui.beans.form.LovInputBean
All Implemented Interfaces:
MutableUINode, UIConstants, UINode
Direct Known Subclasses:
MessageLovInputBean

public class LovInputBean
extends TextInputBean

This bean is not supported on the following agent types: pda.

The LOV Input is used as a text field for launching a List Of Values window. This element is designed to work in conjunction with the listOfValues element. See listOfValues for more information.

This element displays a textInput field, and a search icon. If the icon is clicked (or the text is changed in a partial page refresh environment), a sequence of callbacks and events is started leading to the validation of the text in the field and/or the raising of an LOV window. The validation portion of this sequence can be disabled completely by setting the unvalidated attribute to false.

First, the onLovInit callback will be executed. If the callback returns true, a modal window will be opened displaying the page designated in the lovInput element's destination attribute. The URL to open this page will contain any parameters added/changed/updated in the onLovInit callback. When opened, the destination page will recieve an lovFilter event with two parameters of interest:

When the LOV window opens, the user is presented with a table of prospective completions based on their originally entered text. The user may choose to cancel (in which case the lovInput's textInput field should remain unchanged), select one of the rows presented, navigate to other rows in the table, search on another category, or enter a new search string. See the listOfValues element for more details.

When the LOV window closes the onLovSelect callback will be executed if provided. Then, an lovClose event is generated.

When partial page rendering is enabled, the lovInput element is extended a bit.

First, the onLovValidate callback is executed if the user clicks the search icon, or makes any change to the text in the input field (although if the field ends up as completely whitespace, the validateBlanks attribute controls validation). The client can use this callback to gather any extra data from the page. The parameters that will be sent back on an event URL are available for any additions, updates and/or deletions. If the onLovValidate callback returns false, validation processing stops. Otherwise if the onLovValidate callback returns true, an lovValidate event is generated with two parameters of interest:

In the lovValidate handler, the client should check for valid input, or a unique match (e.g. if the user enters "san fran" and your data value is California cities, the only possible match is "San Francisco"). If the data is valid, the "showWindow" attribute should be set to false (and, in the partial but unique match case, the provider for the text field should be updated to provide the full value "San Francisco" in the example above). Otherwise "showWindow" should be set to true. The default for "showWindow" is false, so "showWindow" can be provided in an EventResult only when needed.

When the lovInput gets a partial refresh request, it will check the "showWindow" attribute. If "showWindow" is false, the text field will simply be re-rendered. If "showWindow" is true, the LOV window will be opened as above.

If the user clicks the lovInput seach icon when they have made no changes to the text in the input field, no validate event will be generated. The LOV window will be created directly.

Example:

This example shows two lovInput elements which have their LOV window definitions (presumably using listOfValues) in LOVdialogs.uix. When the window for lov1 is closed, the myCallBack function will be executed. The second example shows the partial page version with validation and a pre-validate callback.

 <form name="form1">
  <contents>
   <script>
    <contents>
     function SelectCallBack(lovWin, field, event)
     {
       // This function will be called after the select button has been clicked.
       // - lovWin points to the not-yet-closed LOV dialog window.
       // - field points to the lovInput field that triggered this
       //   LOV dialog.
       // - event is the window close event
       //
       var fldNam = field.name;
       var val = field.value;
       var str = "SelectCallback called\nfieldName: '" + fldNam
                  + "'\nvalue: '" + val;
 
       confirm(str);
 
       // Now we could gather values from the LOV Window (using the lovwin
       // object), and use them build a string to set into the original
       // LovInput text field using: field.value = newValue;
       return true;
     }
     function _printCallbackParams(params, CBName)
     {
       // This function just raises a confirm dialog listing
       // key:value pairs in the params object
       var str = CBName + ' called with:'
       for (var key in params)
       {
        str += "\nparameter: '" + key +
               "', value '" + params[key] + "'";
       }
       return confirm(str);
     }
     function InitCallBack(params)
     {
       // If passed as the onLovInit attribute, this function is called
       // after the LOV icon is clicked, but before the LOV dialog window
       // is launched. This gives the developer a change to change the
       // parameters that are going to the dialog window.
       // The params object contains all the parameters which will end up
       // on the URL.
 
       // Add our own parameter. This will end up as a parameter on the
       // LOV dialog window URL.
       // (http://...?...&myParam=foo)
       params["myParam"] = "foo";
 
       return _printCallbackParams(params, 'InitCallback');
       // return true;
     }
     function ValidateCallBack(params)
     {
       // If passed as the onLovValidate attribute, this function is called
       // before the lovValidate event is fired.
       // This gives the developer a chance to add, subtract or change
       // parameters that will be sent with the lovValidate event
       return _printCallbackParams(params, 'pre-validate Callback');
     }
    </contents>
   </script>
   <stackLayout>
    <contents>
     <flowLayout>
      <contents>
       <styledText text="value 1: "/>
       <lovInput name="lov1"
                 shortDesc="Click to select a predefined value"
                 onLovInit="initCallBack"
                 onLovSelect="selectCallBack"
                 destination="LOVwindows.uix"/>
      </contents>
     </flowLayout>
     <flowLayout>
      <contents>
       <styledText text="value 2: "/>
       <lovInput name="lov2"
                 id="Lov-target2"
                 data:showWindow="isNotValid@someEventResult"
                 shortDesc="Click to select a predefined value"
                 onLovInit="initCallBack"
                 onLovSelect="selectCallBack"
                 onLovValidate="validateCallBack"
                 destination="LOVwindows.uix"/>
      </contents>
     </flowLayout>
    </contents>
   </stackLayout>
  </contents>
 </form>


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
  LovInputBean()
          Construct an instance of the LovInputBean.
protected LovInputBean(boolean ignored, java.lang.String localName)
          Construct an instance of the LovInputBean.
 
Method Summary
 java.lang.String getDestination()
          Gets The path to the page that will populate the LOV window.
static java.lang.String getDestination(MutableUINode bean)
          Gets The path to the page that will populate the LOV window.
 java.lang.String getOnLovInit()
          Gets The name of a JavaScript function that will be called before the LOV window is opened.
static java.lang.String getOnLovInit(MutableUINode bean)
          Gets The name of a JavaScript function that will be called before the LOV window is opened.
 java.lang.String getOnLovSelect()
          Gets The name of a JavaScript function that will be called after the LOV window is closed.
static java.lang.String getOnLovSelect(MutableUINode bean)
          Gets The name of a JavaScript function that will be called after the LOV window is closed.
 java.lang.String getOnLovValidate()
          Gets The name of a JavaScript function that will be called immediately prior to the sending of the lovValidate event.
static java.lang.String getOnLovValidate(MutableUINode bean)
          Gets The name of a JavaScript function that will be called immediately prior to the sending of the lovValidate event.
 java.lang.String getPartialRenderMode()
          Gets
static java.lang.String getPartialRenderMode(MutableUINode bean)
          Gets
 java.lang.String[] getPartialTargets()
          Gets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple".
static java.lang.String[] getPartialTargets(MutableUINode bean)
          Gets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple".
 boolean isShowWindow()
          Gets The "showWindow" attribute is set to false if the value in the text field is considered valid.
static boolean isShowWindow(MutableUINode bean)
          Gets The "showWindow" attribute is set to false if the value in the text field is considered valid.
 boolean isUnvalidated()
          Gets Setting this value to TRUE will inhibit the validation step.
static boolean isUnvalidated(MutableUINode bean)
          Gets Setting this value to TRUE will inhibit the validation step.
 boolean isValidateBlanks()
          Gets By default, no lovValidate event is fired if the input field is blank or all whitespace (even if it has changed from valid text to whitespace).
static boolean isValidateBlanks(MutableUINode bean)
          Gets By default, no lovValidate event is fired if the input field is blank or all whitespace (even if it has changed from valid text to whitespace).
static void setDestination(MutableUINode bean, java.lang.String destination)
          Sets The path to the page that will populate the LOV window.
 void setDestination(java.lang.String destination)
          Sets The path to the page that will populate the LOV window.
static void setOnLovInit(MutableUINode bean, java.lang.String onLovInit)
          Sets The name of a JavaScript function that will be called before the LOV window is opened.
 void setOnLovInit(java.lang.String onLovInit)
          Sets The name of a JavaScript function that will be called before the LOV window is opened.
static void setOnLovSelect(MutableUINode bean, java.lang.String onLovSelect)
          Sets The name of a JavaScript function that will be called after the LOV window is closed.
 void setOnLovSelect(java.lang.String onLovSelect)
          Sets The name of a JavaScript function that will be called after the LOV window is closed.
static void setOnLovValidate(MutableUINode bean, java.lang.String onLovValidate)
          Sets The name of a JavaScript function that will be called immediately prior to the sending of the lovValidate event.
 void setOnLovValidate(java.lang.String onLovValidate)
          Sets The name of a JavaScript function that will be called immediately prior to the sending of the lovValidate event.
static void setPartialRenderMode(MutableUINode bean, java.lang.String partialRenderMode)
          Sets
 void setPartialRenderMode(java.lang.String partialRenderMode)
          Sets
static void setPartialTargets(MutableUINode bean, java.lang.String[] partialTargets)
          Sets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple".
 void setPartialTargets(java.lang.String[] partialTargets)
          Sets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple".
 void setShowWindow(boolean showWindow)
          Sets The "showWindow" attribute is set to false if the value in the text field is considered valid.
static void setShowWindow(MutableUINode bean, boolean showWindow)
          Sets The "showWindow" attribute is set to false if the value in the text field is considered valid.
 void setUnvalidated(boolean unvalidated)
          Sets Setting this value to TRUE will inhibit the validation step.
static void setUnvalidated(MutableUINode bean, boolean unvalidated)
          Sets Setting this value to TRUE will inhibit the validation step.
 void setValidateBlanks(boolean validateBlanks)
          Sets By default, no lovValidate event is fired if the input field is blank or all whitespace (even if it has changed from valid text to whitespace).
static void setValidateBlanks(MutableUINode bean, boolean validateBlanks)
          Sets By default, no lovValidate event is fired if the input field is blank or all whitespace (even if it has changed from valid text to whitespace).
 
Methods inherited from class oracle.cabo.ui.beans.form.TextInputBean
getColumns, getColumns, getMaximumLength, getMaximumLength, getOnBlurValidater, getOnBlurValidater, getOnChange, getOnChange, getOnSelect, getOnSelect, getOnSubmitValidater, getOnSubmitValidater, getRequired, getRequired, getRows, getRows, getText, getText, getWrap, getWrap, isSecret, isSecret, setColumns, setColumns, setMaximumLength, setMaximumLength, setOnBlurValidater, setOnBlurValidater, setOnChange, setOnChange, setOnSelect, setOnSelect, setOnSubmitValidater, setOnSubmitValidater, setRequired, setRequired, setRows, setRows, setSecret, setSecret, setText, setText, setTextBinding, setTextBinding, setTextBinding, setTextBinding, setTextBinding, setTextBinding, setTranslatableText, setTranslatableText, setWrap, setWrap
 
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

LovInputBean

public LovInputBean()
Construct an instance of the LovInputBean.

LovInputBean

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

getDestination

public final java.lang.String getDestination()
Gets The path to the page that will populate the LOV window.

setDestination

public final void setDestination(java.lang.String destination)
Sets The path to the page that will populate the LOV window.

getOnLovInit

public final java.lang.String getOnLovInit()
Gets The name of a JavaScript function that will be called before the LOV window is opened. The signature is:

function initCallBack(params)

The params argument is a simple Object consisting of all the parameters that will be on the URL used to open the LOV window. The developer may add, delete or update any of the parameters in this callback.

setOnLovInit

public final void setOnLovInit(java.lang.String onLovInit)
Sets The name of a JavaScript function that will be called before the LOV window is opened. The signature is:

function initCallBack(params)

The params argument is a simple Object consisting of all the parameters that will be on the URL used to open the LOV window. The developer may add, delete or update any of the parameters in this callback.

getOnLovValidate

public final java.lang.String getOnLovValidate()
Gets The name of a JavaScript function that will be called immediately prior to the sending of the lovValidate event. The signature is:

function initCallBack(params)

The params argument is a simple Object consisting of all the parameters that will be on the URL used to send the event The developer may add, delete or update any parameters in this callback.

setOnLovValidate

public final void setOnLovValidate(java.lang.String onLovValidate)
Sets The name of a JavaScript function that will be called immediately prior to the sending of the lovValidate event. The signature is:

function initCallBack(params)

The params argument is a simple Object consisting of all the parameters that will be on the URL used to send the event The developer may add, delete or update any parameters in this callback.

getOnLovSelect

public final java.lang.String getOnLovSelect()
Gets The name of a JavaScript function that will be called after the LOV window is closed. The signature is:

function selectCallBack(Win, field, event)

where the arguments are:

setOnLovSelect

public final void setOnLovSelect(java.lang.String onLovSelect)
Sets The name of a JavaScript function that will be called after the LOV window is closed. The signature is:

function selectCallBack(Win, field, event)

where the arguments are:

isShowWindow

public final boolean isShowWindow()
Gets The "showWindow" attribute is set to false if the value in the text field is considered valid. If "showWindow" is true during a partial page refresh of the LovInput node, then a script will be built to bring up an LOV window. If "showWindow" is false then no special processing will be done.

setShowWindow

public final void setShowWindow(boolean showWindow)
Sets The "showWindow" attribute is set to false if the value in the text field is considered valid. If "showWindow" is true during a partial page refresh of the LovInput node, then a script will be built to bring up an LOV window. If "showWindow" is false then no special processing will be done.

isUnvalidated

public final boolean isUnvalidated()
Gets Setting this value to TRUE will inhibit the validation step. No onChange handler will be generated, and no lovValidate event will be generated. The end user will still be able to bring up an LOV window, but only by clicking on the search icon (this is the default behavior in environments that do not support partial page refresh).

setUnvalidated

public final void setUnvalidated(boolean unvalidated)
Sets Setting this value to TRUE will inhibit the validation step. No onChange handler will be generated, and no lovValidate event will be generated. The end user will still be able to bring up an LOV window, but only by clicking on the search icon (this is the default behavior in environments that do not support partial page refresh).

isValidateBlanks

public final boolean isValidateBlanks()
Gets By default, no lovValidate event is fired if the input field is blank or all whitespace (even if it has changed from valid text to whitespace). Setting this attribute to TRUE will cause an lovValidate event to be fired when the field changes to empty or just whitespace.

setValidateBlanks

public final void setValidateBlanks(boolean validateBlanks)
Sets By default, no lovValidate event is fired if the input field is blank or all whitespace (even if it has changed from valid text to whitespace). Setting this attribute to TRUE will cause an lovValidate event to be fired when the field changes to empty or just whitespace.

getPartialRenderMode

public final java.lang.String getPartialRenderMode()
Gets

The partialRenderMode attribute is used to control the lovInput component's partial page rendering behavior. partialRenderMode defaults to "none", in which case auto-validation is disabled (no lovValidate events are sent) and lovUpdate events are sent using a full page submit. When partialRenderMode is set to "self" or "multiple", the lovValidate and lovUpdate events are sent as partial page events, which allows the specified partial targets to be updated without redrawing the entire page.

In order to enable partial page rendering, the lovInput component's id attribute must be set, the lovInput component must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the lovInput component will use the partial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, auto-validation is disabled and updates are performed via full page rendering.


setPartialRenderMode

public final void setPartialRenderMode(java.lang.String partialRenderMode)
Sets

The partialRenderMode attribute is used to control the lovInput component's partial page rendering behavior. partialRenderMode defaults to "none", in which case auto-validation is disabled (no lovValidate events are sent) and lovUpdate events are sent using a full page submit. When partialRenderMode is set to "self" or "multiple", the lovValidate and lovUpdate events are sent as partial page events, which allows the specified partial targets to be updated without redrawing the entire page.

In order to enable partial page rendering, the lovInput component's id attribute must be set, the lovInput component must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the lovInput component will use the partial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, auto-validation is disabled and updates are performed via full page rendering.


getPartialTargets

public final java.lang.String[] getPartialTargets()
Gets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". The ID of the lovInput is automatically included in the set of partial targets and as such should not be specified explicitly in the partialTargets list.

setPartialTargets

public final void setPartialTargets(java.lang.String[] partialTargets)
Sets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". The ID of the lovInput is automatically included in the set of partial targets and as such should not be specified explicitly in the partialTargets list.

getDestination

public static java.lang.String getDestination(MutableUINode bean)
Gets The path to the page that will populate the LOV window.

setDestination

public static void setDestination(MutableUINode bean,
                                  java.lang.String destination)
Sets The path to the page that will populate the LOV window.

getOnLovInit

public static java.lang.String getOnLovInit(MutableUINode bean)
Gets The name of a JavaScript function that will be called before the LOV window is opened. The signature is:

function initCallBack(params)

The params argument is a simple Object consisting of all the parameters that will be on the URL used to open the LOV window. The developer may add, delete or update any of the parameters in this callback.

setOnLovInit

public static void setOnLovInit(MutableUINode bean,
                                java.lang.String onLovInit)
Sets The name of a JavaScript function that will be called before the LOV window is opened. The signature is:

function initCallBack(params)

The params argument is a simple Object consisting of all the parameters that will be on the URL used to open the LOV window. The developer may add, delete or update any of the parameters in this callback.

getOnLovValidate

public static java.lang.String getOnLovValidate(MutableUINode bean)
Gets The name of a JavaScript function that will be called immediately prior to the sending of the lovValidate event. The signature is:

function initCallBack(params)

The params argument is a simple Object consisting of all the parameters that will be on the URL used to send the event The developer may add, delete or update any parameters in this callback.

setOnLovValidate

public static void setOnLovValidate(MutableUINode bean,
                                    java.lang.String onLovValidate)
Sets The name of a JavaScript function that will be called immediately prior to the sending of the lovValidate event. The signature is:

function initCallBack(params)

The params argument is a simple Object consisting of all the parameters that will be on the URL used to send the event The developer may add, delete or update any parameters in this callback.

getOnLovSelect

public static java.lang.String getOnLovSelect(MutableUINode bean)
Gets The name of a JavaScript function that will be called after the LOV window is closed. The signature is:

function selectCallBack(Win, field, event)

where the arguments are:

setOnLovSelect

public static void setOnLovSelect(MutableUINode bean,
                                  java.lang.String onLovSelect)
Sets The name of a JavaScript function that will be called after the LOV window is closed. The signature is:

function selectCallBack(Win, field, event)

where the arguments are:

isShowWindow

public static boolean isShowWindow(MutableUINode bean)
Gets The "showWindow" attribute is set to false if the value in the text field is considered valid. If "showWindow" is true during a partial page refresh of the LovInput node, then a script will be built to bring up an LOV window. If "showWindow" is false then no special processing will be done.

setShowWindow

public static void setShowWindow(MutableUINode bean,
                                 boolean showWindow)
Sets The "showWindow" attribute is set to false if the value in the text field is considered valid. If "showWindow" is true during a partial page refresh of the LovInput node, then a script will be built to bring up an LOV window. If "showWindow" is false then no special processing will be done.

isUnvalidated

public static boolean isUnvalidated(MutableUINode bean)
Gets Setting this value to TRUE will inhibit the validation step. No onChange handler will be generated, and no lovValidate event will be generated. The end user will still be able to bring up an LOV window, but only by clicking on the search icon (this is the default behavior in environments that do not support partial page refresh).

setUnvalidated

public static void setUnvalidated(MutableUINode bean,
                                  boolean unvalidated)
Sets Setting this value to TRUE will inhibit the validation step. No onChange handler will be generated, and no lovValidate event will be generated. The end user will still be able to bring up an LOV window, but only by clicking on the search icon (this is the default behavior in environments that do not support partial page refresh).

isValidateBlanks

public static boolean isValidateBlanks(MutableUINode bean)
Gets By default, no lovValidate event is fired if the input field is blank or all whitespace (even if it has changed from valid text to whitespace). Setting this attribute to TRUE will cause an lovValidate event to be fired when the field changes to empty or just whitespace.

setValidateBlanks

public static void setValidateBlanks(MutableUINode bean,
                                     boolean validateBlanks)
Sets By default, no lovValidate event is fired if the input field is blank or all whitespace (even if it has changed from valid text to whitespace). Setting this attribute to TRUE will cause an lovValidate event to be fired when the field changes to empty or just whitespace.

getPartialRenderMode

public static java.lang.String getPartialRenderMode(MutableUINode bean)
Gets

The partialRenderMode attribute is used to control the lovInput component's partial page rendering behavior. partialRenderMode defaults to "none", in which case auto-validation is disabled (no lovValidate events are sent) and lovUpdate events are sent using a full page submit. When partialRenderMode is set to "self" or "multiple", the lovValidate and lovUpdate events are sent as partial page events, which allows the specified partial targets to be updated without redrawing the entire page.

In order to enable partial page rendering, the lovInput component's id attribute must be set, the lovInput component must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the lovInput component will use the partial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, auto-validation is disabled and updates are performed via full page rendering.


setPartialRenderMode

public static void setPartialRenderMode(MutableUINode bean,
                                        java.lang.String partialRenderMode)
Sets

The partialRenderMode attribute is used to control the lovInput component's partial page rendering behavior. partialRenderMode defaults to "none", in which case auto-validation is disabled (no lovValidate events are sent) and lovUpdate events are sent using a full page submit. When partialRenderMode is set to "self" or "multiple", the lovValidate and lovUpdate events are sent as partial page events, which allows the specified partial targets to be updated without redrawing the entire page.

In order to enable partial page rendering, the lovInput component's id attribute must be set, the lovInput component must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the lovInput component will use the partial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, auto-validation is disabled and updates are performed via full page rendering.


getPartialTargets

public static java.lang.String[] getPartialTargets(MutableUINode bean)
Gets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". The ID of the lovInput is automatically included in the set of partial targets and as such should not be specified explicitly in the partialTargets list.

setPartialTargets

public static void setPartialTargets(MutableUINode bean,
                                     java.lang.String[] partialTargets)
Sets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". The ID of the lovInput is automatically included in the set of partial targets and as such should not be specified explicitly in the partialTargets list.

Oracle UIX API Reference
Release 2.1.22.0.0
B12196-01

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