oracle.cabo.ui.beans.templates
Class ListOfValuesBean
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.templates.ListOfValuesBean
- All Implemented Interfaces:
- MutableUINode, UIConstants, UINode
- public class ListOfValuesBean
- extends MarlinBean
The listOfValues element describes the contents of a LOV dialog window.
This element is designed to work with the lovInput element.
The listOfValues element defines a layout which displays a header with
general instructions, a search criteria block, and a results table.
Together these sections allow the user to search out and choose
appropriate values.
The listOfValues element accepts an arbitrary UINode as it's content. The
visible contents of this element should be limited to a single proxied,
form-submitted table. This table should display all valid values,
determined by using the the current search criteria as a filter on the
entire valid value data set. All management of the table is left up to the
developer. The listOfValues merely displays the table as provided. If
tracking of more information is desired, the developer may supply one or
more formValue elements (hidden fields) in a flowLayout along with the
Table.
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 original lovInput field should
remain unchanged), select one or several of the rows presented, navigate
to other rows in the table, search on another category, or enter new
search string/filter criteria.
The LOV window presents a search block which allows the user to set the
parameters of their search. This block supports four distinct modes.
The mode is set using the
searchAreaMode
attribute. The search area block will be rendered with a 'Search' label, a
'Go' button, and various input fields. The input fields vary depending on
the
searchAreaMode
as follows:
- Basic Search: A single search text input
field is rendered.
- Filter Search: A single search text field,
and a category choice pulldown is rendered. The category choice allows
the user to select the column to which their entered search text should
be applied. The category choice is supplied by the developer in the
filterChoice
named child. If the
filterChoice
named child is not supplied, this mode will render exactly the same as
Basic
mode.
- Simple Search: This mode renders
just as in the filter search mode,
but an 'Advanced Search' toggle button is also rendered at the
edge of the search block (more on this button below).
- Advanced Search: This mode renders an
arbitrary layout of text and input elements. A 'Simple Search' toggle
button is also rendered at edge of the search block (more on this
button below). The layout of elements is supplied by the developer in
the
advancedChoices
named child.
In all modes, a 'Go' button is rendered as the last element in the search
Area. When the search area 'Go' button is clicked, an
lovFilter
event is generated with all form elements, the only parameters of
interest are:
-
searchText
is the value or partial value being searched for. It should be used to
filter the dataset used to build the LOV table
-
<choiceelementname>
This parameter names the selected option of the
filterChoice
named child element. Note: The actual parameter name is not
'<choiceelementname>', but the name
attribute of the choice element defined as the
filterChoice
named child.
-
source
identifies the
lovInput
field, on the main page, that brought up this LOV window. This allows
you to track the progress of an LOV search from beginning to end.
-
searchAreaMode
identifies the current search block mode.
As mentioned above, a toggle button will be rendered in both
the
simple
and
advanced
modes. When this button is clicked, a
lovSearchMode
event will be fired. The purpose of this event is to allow the developer
to toggle the state of the
searchAreaMode
between
simple
and
advanced
modes. The only parameters of interest are:
-
source
identifies the
lovInput
field, on the main page, that brought up this LOV window. This allows
you to track the progress of an LOV search from beginning to end.
-
searchAreaMode
identifies the target search block mode (e.g. if the
searchAreaMode
is currently set to 'advanced' a 'Simple Search' button will be
displayed. Clicking it will generate a
lovSearchMode
event with a
searchAreaMode
parameter of 'simple').
Once the LOV dialog window is displayed, the end user can do one of eight
things:
-
Change the search filter category (using the
filterChoice
pulldown)
-
Edit the search filter text
-
Select/deselect one or more of the displayed table rows
-
Click one of the search block buttons (the 'Go' button or one
of the
searchAreaMode
toggle buttons).
-
Perform a table operation (e.g. navigate to another rowset if the
dataset has more rows than will display in one page of the table).
-
Click the 'Select' button
-
Click the 'Cancel' button
-
Close the LOV window.
Only the last five actions will generate events to the server. The search
block toggle buttons were described above. All of the remaining events
will contain any provided hidden fields as parameters. Every event will
also have the following parameters:
-
<choiceelementname>
This parameter names the selected option of the
filterChoice
named child element. The actual parameter name that comes back with the
submission is the name attribute of the choice element defined as
the
filterChoice
named child.
-
searchText
is the value or partial value being searched for.
In addition, every event will get the normal table related
parameters such as value, size,
<tableName>:length,
<tableName>:selectMode, and possibly
<tableName>:selected:<selectionNumber>.
The five event-generating user actions have the following effects:
-
Search block buttons: As described above, an
lovFilter
event is generated when the 'Go' button is clicked. All table parameters
and hidden fields are provided. No additional useable parameters are
sent. The client should update the table row data provider based on the
searchText and <choiceElementName> parameters. When one of the
toggle buttons is clicked, the
lovSearchMode
event is generated. All table parameters and hidden fields are provided.
-
Table operation: There is nothing LOV-specific about the table. It can
generate any event that any other table can.
-
'Select' button: an
lovSelect
event is generated. All table parameters and hidden fields are
provided. The
source
parameter will provide the element ID attribute. The user is done, the
client must update, gather and store all remaining selection
information.
After the lovSelect event is queued, the LOV window will be closed. On
closing, the lovWindow will send an
lovUpdate
event. This event tells the developer that the LOV window
has gone away, and it's time to update all data providers. This event
submits the form on the main page in which the original LovInput
element was drawn. The
source
parameter will contain the name attribute of the original
lovInput element.
-
'Cancel' button or window close: The LOV window is closed. No further
events are generated. The lovInput field should remain unchanged.
A typical usage scenario would go something like the following. Again, the
listOfValues element is designed to work with the lovInput element. This
usage scenario explains steps taken in response to attributes on both
elements.
-
The user alters the lovInput text field and/or clicks the search icon.
-
The onLovValidate callback fires. Clients can add/delete/update any
of the parameters that will go on the validation URL. If the user clicks
the search icon without changing the text, the LOV window will be
brought up directly without an onLovValidate event.
-
If onLovValidate returns false, we go back to the main page with
no changes.
-
Otherwise the lovValidate event is sent to the server. The event will
have two parameters. The source parameter will contain the name of the
lovInput element, and searchText will contain the data from the text
input field of the lovInput. The URL used to send this event will
include any parameters the client added or changed in the onLovValidate
callback.
-
The lovValidate handler does a preliminary check and sets the
lovInput's
showWindow
attribute data provider to return true or false.
-
If the
showWindow
attribute is set to false, then the main page is re-drawn (presumably
with values updated in the lovValidate event handler), no LOV window
is raised.
-
If the
showWindow
attribute is set to true, then a javascript call, which calls the open
LOV Window function in the LovInput support library, is sent to the
browser.
-
If an onLovInit callback has been provided, it is called. It has
the same interface as onLovValidate. The client can add/delete/update
any parameters that will go on the LOV window URL.
-
The LOV Window is opened with the URL provided as the destination
attribute to the lovInput element, and any parameters you may have added
in the onLovInit callback. The LOV window has a main table section in
the form. This is the indexed child of the listOfValues element. The
contents can be an arbitrary UINode, but the only visible element must
be a table. You can add hidden fields here, and they will come back on
any button press or table operation.
-
The user clicks Select, and the lovSelect event is fired. The handler
for this event should update any providers.
-
If the user clicks Cancel or closes the window, no event will be fired,
no redraw will take place. All values should remain what they were prior
to the LOV window opening.
-
The LOV window is closed, the lovUpdate event is fired. The lovUpdate
handler should do any cleanup needed. If the client has any dependent
fields that need to be re-drawn along with the main lovInput field, they
should be added to the list of partial targets in the lovUpdate handler
(only in a partial page update environment).
-
The main window is re-drawn using the updated values.
The validation step can be skipped entirely by returning false from the
onLovValidate callback, or setting the lovInput's unvalidated attribute
to true. Similarly, the client can stop the LOV window from opening by
returning false from the onLovInit callback.
Any main page re-draws are done with a partial page refresh if possible.
In the non-partial-page world, no validation is done, and the user
has to explicitly click the search icon (there is no onChange event
handler). All main page re-draws are full re-draws.
Multiple windows are not available on most pda browsers,
so the application must navigate to/from the lovInput page.
It is necessary to forward or redirect from the listOfValues page back
the lovInput page on the server. It is up to the application to know where
to forward or redirect. On pda there is no support to do a search
from the listOfValues page.
Example:
<listOfValues title="LOV field #1"
id="lovHandler"
searchAreaMode="filter"
searchText="${uix.data.fieldData['current'].fieldText}">
<headerInstructions>
<styledText text="Some appropriate instructions about this LOV..."
styleClass="OraInstructionText"/>
</headerInstructions>
<!-- This choice just pulls out the column headers -->
<filterChoice>
<choice name="categoryChoice"
multiple="false"
selectedValue="${uix.data.generalParams.categoryChoice}">
<contents childData="${uix.data.categoryData['.']}">
<option text="${uix.current['.']}"/>
</contents>
</choice>
</filterChoice>
<searchInstructions>
<styledText text="Some appropriate instructions about searching..."
styleClass="OraInstructionText"/>
</searchInstructions>
<contents>
<flowLayout>
<contents>
<table name="lovTbl"
id="lovTbl"
etc... a normal table ...>
<contents>
<!-- Populate the table with data -->
<text text="${uix.current.peak}"/>
etc...
<!-- This element supplies a rowid to show how extra -->
<!-- data could be put on the form. This value will be -->
<!-- submitted with every operation on this table. -->
<formValue name="rowid" value="${uix.current.rowid}"/>
</contents>
</table>
<!-- or the extra data could be supplied outside the table -->
<formValue name="extraData" value="something useful"/>
</contents>
</flowLayout>
</contents>
</contents>
</listOfValues>
Fields inherited from interface oracle.cabo.ui.UIConstants |
ABBREVIATION_ATTR, ABOUT_CHILD, ACCESS_KEY_ATTR, ADD_NAME, ADD_ROWS_EVENT, ADD_TABLE_ROW_NAME, ADVANCED_CHOICES_CHILD, AGENT_NAME, ALL_DETAILS_ENABLED_ATTR, ALLOWS_TRANSPARENT_ATTR, ALTERNATE_CONTENT_CHILD, ALTERNATE_TEXT_ATTR, ANCESTOR_ATTRIBUTE_NAME, ANCESTOR_ID_ATTR, ANCESTOR_PATH_ATTR, ANCHOR_ATTR, AND_NAME, ANNOTATION_ATTR, APPLICATION_SWITCHER_NAME, ARRAY_NODE_LIST_NAME, ATTRIBUTE_MAP_NAME, AUTOFLIP_ATTR, AUTOMATIC_ATTR, AUTOSTART_ATTR, BACKGROUND_ATTR, BACKGROUND_DARK, BACKGROUND_LIGHT, BACKGROUND_MEDIUM, BACKGROUND_TRANSPARENT, 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_CRUMB_TEXT_ATTR, BREAD_CRUMBS_NAME, BROWSE_EVENT, BROWSE_MENU_NAME, BULLETED_LIST_NAME, BUNDLE_NAME, BUTTON_NAME, BUTTONS_CHILD, BYTE_LENGTH_NAME, CALENDAR_ID_ATTR, 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_BLOCK_SIZE_ATTR, CHILD_DATA_ATTR, CHILD_LIST_NAME, CHILD_MAP_NAME, CHILD_NAME_ATTR, CHILD_TYPE_TEXT, CHILD_TYPE_TEXT_ATTR, CHOICE_NAME, CHROME_TYPE_ATTR, COBRANDING_CHILD, COLLAPSE_ALL_EVENT, COLLAPSE_DESTINATION_KEY, COLOR_BUTTON_NAME, COLOR_DATA_ATTR, COLOR_FIELD_NAME, COLOR_NAME, COLOR_PALETTE_NAME, COLOR_PICKER_NAME, COLOR_SWATCH_NAME, 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, COMPACT_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, CONFIG_NAME_PARAM, 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, CONTEXT_URI_PARAM, CONTROLS_ALL, CONTROLS_ATTR, CONTROLS_MINIMAL, CONTROLS_NONE, CONTROLS_NONE_VISIBLE, CONTROLS_TYPICAL, CONVERT_NAME, CONVERT_PARAM, COPYRIGHT_CHILD, CORPORATE_BRANDING_CHILD, CURRENT_DATA_ATTR, CURRENT_INDEX_ATTR, CURRENT_THROWABLE_PROPERTY, CUSTOM_COLOR_DATA_ATTR, 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, DATE_STYLE_PARAM, DECIMAL_NAME, DEFAULT_CASE_ATTR, DEFAULT_CONTENTS_ATTR, DEFAULT_NAME, DEFAULTING_NAME, DESCRIPTION_ATTR, 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, EDGE_STAMP_CHILD, EMBEDDED_ATTR, ENC_PARAM, ENCODED_PARAMETER_NAME, END_CHILD, ENTER_CLIENT_ACTION_ATTR, EVENT_ATTR, EVENT_PARAM, EXCEPTIONS_CAUGHT_PROPERTY, EXPAND_ALL_EVENT, EXPAND_DESTINATION_KEY, EXPAND_EVENT, EXPANDABLE_ALWAYS, EXPANDABLE_COLLAPSED, EXPANDABLE_EXPANDED, EXPANDABLE_KEY, EXPANDABLE_NO, EXPRESSION_LANGUAGE_ATTRIBUTE_NAME, 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_CHILD, 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, GRAPH_DIAGRAM_NAME, GRAPH_EDGE_NAME, GRAPH_NODE_NAME, GRAPH_VIEW_STATE_ATTR, 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_ATTR, 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, ICON_KEY_NAME, ICON_NAME, ICON_REQUIRED, ICON_SHORT_DESC_KEY, ID_ATTR, IF_NAME, IMAGE_ATTR, IMAGE_MAP_TYPE_ATTR, IMAGE_MAP_TYPE_NONE, IMAGE_MAP_TYPE_SERVER, IMAGE_NAME, IMPORT_SCRIPT_NAME, IN_CONTEXT_BRANDING_CHILD, IN_CONTEXT_BRANDING_STYLE, INCLUDE_NAME, INCOMPLETE_DATA_SET, INITIAL_FOCUS_CONTEXT_PROPERTY, INITIAL_FOCUS_ID_ATTR, INLINE_DATE_PICKER_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, INSTRUCTION_STYLE, ITEM_TITLE_ATTR, ITEMS_CHILD, JSP_PARAM, 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, LOC_PARAM, LOCATION_CHILD, LOCATION_PARAM, LONG_DESC_ATTR, LONG_DESC_URL_ATTR, LOV_BUTTON_NAME, LOV_CHOICE_NAME, LOV_EVENT, LOV_FIELD_NAME, LOV_FILTER_EVENT, LOV_INPUT_NAME, LOV_LIBRARY_NAME, LOV_SEARCH_TEXT, LOV_SELECT_COLUMN_NAME, MAILTO_NAME, MAIN_VIEW_HEIGHT_ATTR, MAIN_VIEW_WIDTH_ATTR, MARLIN_NAMESPACE, MAX_VALUE_ATTR, MAX_VALUE_PARAM, 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_COLOR_FIELD_NAME, MESSAGE_COMPONENT_LAYOUT_NAME, MESSAGE_DATA_ATTR, MESSAGE_DATA_TEXT_NAME, MESSAGE_DATE_FIELD_NAME, MESSAGE_FILE_UPLOAD_NAME, MESSAGE_FORMAT_NAME, MESSAGE_LAYOUT_NAME, MESSAGE_LIST_NAME, MESSAGE_LOV_CHOICE_NAME, MESSAGE_LOV_FIELD_NAME, MESSAGE_LOV_INPUT_NAME, MESSAGE_PROMPT_NAME, MESSAGE_RADIO_BUTTON_NAME, MESSAGE_RADIO_GROUP_NAME, MESSAGE_RADIO_SET_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, MIN_VALUE_PARAM, MINIMUM_WIDTH_ATTR, MODEL_ATTR, MONTH_PARAM, MULTIPLE_ATTR, MULTIPLE_SELECTION_NAME, NAME_ATTR, NAME_TRANSFORMED_ATTR, NAME_VALUES_ATTR, NAMED_SOURCE_ATTR, NAMES_ATTR, NAVIGATE_EVENT, NAVIGATION_BAR_NAME, NAVIGATION_EXCLUDE_NAMES_ATTR, NAVIGATION_FORM_NAME_ATTR, NAVIGATOR_HEIGHT_ATTR, NAVIGATOR_WIDTH_ATTR, NEXT_EVENT, NO_BANDING, NODE_ATTR, NODE_PARAM, NODE_STAMP_CHILD, NODES_ATTR, NODES_KEY, NOT_NAME, NULL_NAME, NUMBER_FORMAT, ON_BLUR_ATTR, ON_BLUR_VALIDATER_ATTR, ON_CHANGE_ATTR, ON_CLICK_ATTR, ON_CLICK_KEY, ON_COLOR_SELECT_ATTR, ON_DEMAND, 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_NAME, PAGE_STAMP_STYLE, PAGE_STATUS_CHILD, PALETTE_ID_ATTR, PALETTE_NAME, PARAM_NAME_EXCHANGES_ATTR, PARSE_NAME, PARTIAL_CONTENT_NAME, PARTIAL_KEEP_ALIVE_PROPERTY, 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, PATTERN_ATTR, PATTERN_PARAM, PATTERNS_ATTR, PERCENT_COMPLETE_ATTR, PERCENT_UNKNOWN, PICKER_ID_ATTR, PLAY_COUNT_ATTR, PLAYER_ATTR, PLAYER_LINK, PLAYER_QUICKTIME, PLAYER_REAL, PLAYER_WINDOWS, PORTLET_NAME, POST_TEXT_ATTR, PRE_TEXT_ATTR, PREVIOUS_EVENT, PRIMARY_CLIENT_ACTION_ATTR, PRIVACY_CHILD, PROCESS_STEPS_NAME, PROCESSING_LAYOUT_NAME, PROCESSING_NAME, PRODUCT_BRANDING_CHILD, PRODUCT_BRANDING_NAME, PROMPT_ATTR, PROMPT_CHILD, PROMPT_WIDTH_ATTR, 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, SCROLLED_VALUE_PARAM, SCROLLING_ATTR, SCROLLING_AUTO, SCROLLING_NO, SCROLLING_YES, SEARCH_AREA_MODE_ATTR, SEARCH_DESC_ATTR, SEARCH_INSTRUCTIONS_CHILD, SEARCH_TEXT_ATTR, SECRET_ATTR, SELECT_ATTR, SELECT_MODE_KEY, SELECT_OPTION_NAME, SELECTED_ATTR, SELECTED_INDEX_ATTR, SELECTED_KEY, SELECTED_VALUE_ATTR, SELECTION_ATTR, SELECTION_PARAM, SEPARATOR_CHILD, SEPARATOR_NAME, SERVER_VALIDATER_ATTR, SERVLET_INCLUDE_NAME, SET_CONTEXT_PROPERTY_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, 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_CHECK_ATTR, STATE_PARAM, STATE_ROLE, STEPS_COMPLETE_ATTR, STRUCTURAL_ROLE, STYLE_CLASS_ATTR, STYLE_SHEET_NAME, STYLE_USAGE_ATTR, STYLED_ITEM_NAME, STYLED_LIST_NAME, STYLED_TEXT_NAME, SUB_TAB_BAR_NAME, SUB_TAB_LAYOUT_NAME, SUB_TABS_CHILD, SUB_TRAIN_ATTR, SUBMIT_BUTTON_NAME, SUBMIT_PREPARE_ATTR, SUMMARY_ATTR, SWITCH_APP_EVENT, SWITCH_APP_TYPE_BACK, SWITCH_APP_TYPE_GOTO, SWITCHER_NAME, TAB_BAR_NAME, TABLE_ACTIONS_CHILD, TABLE_BANDING_KEY, TABLE_DATA_ATTR, TABLE_FILTER_CHILD, TABLE_FOOTER_NAME, 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, TOK_PARAM, TOP_CHILD, TOTAL_CHILD, TOTAL_ROW_NAME, TRAILING_CHILD, TRAILING_DESC_SHOWN_ATTR, TRAILING_FOOTER_CHILD, TRAILING_HEADER_ATTR, TRAIN_NAME, TREE_DATA_ATTR, TREE_NAME, TRUNCATE_AT_ATTR, TRUNCATE_NAME, TRY_NAME, TYPE_ATTR, TYPE_PARAM, TYPE_POST, TYPE_PRE, TYPE_TEXT_ATTR, TZ_OFFSET_PARAM, UNDISCLOSED_TEXT_ATTR, UNKNOWN_ROLE, UNVALIDATED_ATTR, UPDATE_EVENT, URI_PARAM, URL_INCLUDE_NAME, USE_SEPARATE_ROWS_ATTR, 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, YEAR_PARAM |
Constructor Summary |
|
ListOfValuesBean()
Construct an instance of the ListOfValuesBean. |
protected |
ListOfValuesBean(boolean ignored,
java.lang.String localName)
Construct an instance of the ListOfValuesBean. |
Method Summary |
UINode |
getAdvancedChoices()
A layout of text input and choice fields. |
static UINode |
getAdvancedChoices(MutableUINode bean)
A layout of text input and choice fields. |
java.lang.String |
getDestination()
Gets The URL to which the form will be submitted. |
static java.lang.String |
getDestination(MutableUINode bean)
Gets The URL to which the form will be submitted. |
UINode |
getFilterChoice()
This choice node should list all the table headers by which a user could
search for their desired value. |
static UINode |
getFilterChoice(MutableUINode bean)
This choice node should list all the table headers by which a user could
search for their desired value. |
UINode |
getHeaderInstructions()
A short instructional text which will display in the header
block of the LOV window. |
static UINode |
getHeaderInstructions(MutableUINode bean)
A short instructional text which will display in the header
block of the LOV window. |
UINode |
getMessages()
A message box to display any relevant error messages. |
static UINode |
getMessages(MutableUINode bean)
A message box to display any relevant error messages. |
java.lang.String |
getSearchAreaMode()
Gets How to display the search area. |
static java.lang.String |
getSearchAreaMode(MutableUINode bean)
Gets How to display the search area. |
UINode |
getSearchInstructions()
A short instructional text which will display in the search block
of the LOV window. |
static UINode |
getSearchInstructions(MutableUINode bean)
A short instructional text which will display in the search block
of the LOV window. |
java.lang.String |
getSearchText()
Gets The string that is being searched on. |
static java.lang.String |
getSearchText(MutableUINode bean)
Gets The string that is being searched on. |
java.lang.String |
getStateCheck()
Gets The name of a javascript function that will be called immediately prior to
the onLovSelect callback, and prior to the delivery of the lovSelect event. |
static java.lang.String |
getStateCheck(MutableUINode bean)
Gets The name of a javascript function that will be called immediately prior to
the onLovSelect callback, and prior to the delivery of the lovSelect event. |
java.lang.String |
getTitle()
Gets the field to which this list of values applies. |
static java.lang.String |
getTitle(MutableUINode bean)
Gets the field to which this list of values applies. |
static void |
setAdvancedChoices(MutableUINode bean,
UINode advancedChoicesNode)
A layout of text input and choice fields. |
void |
setAdvancedChoices(UINode advancedChoicesNode)
A layout of text input and choice fields. |
static void |
setDestination(MutableUINode bean,
java.lang.String destination)
Sets The URL to which the form will be submitted. |
void |
setDestination(java.lang.String destination)
Sets The URL to which the form will be submitted. |
static void |
setFilterChoice(MutableUINode bean,
UINode filterChoiceNode)
This choice node should list all the table headers by which a user could
search for their desired value. |
void |
setFilterChoice(UINode filterChoiceNode)
This choice node should list all the table headers by which a user could
search for their desired value. |
static void |
setHeaderInstructions(MutableUINode bean,
UINode headerInstructionsNode)
A short instructional text which will display in the header
block of the LOV window. |
void |
setHeaderInstructions(UINode headerInstructionsNode)
A short instructional text which will display in the header
block of the LOV window. |
static void |
setMessages(MutableUINode bean,
UINode messagesNode)
A message box to display any relevant error messages. |
void |
setMessages(UINode messagesNode)
A message box to display any relevant error messages. |
static void |
setSearchAreaMode(MutableUINode bean,
java.lang.String searchAreaMode)
Sets How to display the search area. |
void |
setSearchAreaMode(java.lang.String searchAreaMode)
Sets How to display the search area. |
static void |
setSearchInstructions(MutableUINode bean,
UINode searchInstructionsNode)
A short instructional text which will display in the search block
of the LOV window. |
void |
setSearchInstructions(UINode searchInstructionsNode)
A short instructional text which will display in the search block
of the LOV window. |
static void |
setSearchText(MutableUINode bean,
java.lang.String searchText)
Sets The string that is being searched on. |
void |
setSearchText(java.lang.String searchText)
Sets The string that is being searched on. |
static void |
setStateCheck(MutableUINode bean,
java.lang.String stateCheck)
Sets The name of a javascript function that will be called immediately prior to
the onLovSelect callback, and prior to the delivery of the lovSelect event. |
void |
setStateCheck(java.lang.String stateCheck)
Sets The name of a javascript function that will be called immediately prior to
the onLovSelect callback, and prior to the delivery of the lovSelect event. |
static void |
setTitle(MutableUINode bean,
java.lang.String title)
Sets the field to which this list of values applies. |
void |
setTitle(java.lang.String title)
Sets the field to which this list of values applies. |
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 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 |
ListOfValuesBean
public ListOfValuesBean()
- Construct an instance of the ListOfValuesBean.
ListOfValuesBean
protected ListOfValuesBean(boolean ignored,
java.lang.String localName)
- Construct an instance of the ListOfValuesBean.
Provided for subclasses that need distinct local names..
getHeaderInstructions
public final UINode getHeaderInstructions()
- A short instructional text which will display in the header
block of the LOV window. This must be a styledText node, it is expected to
have a class of "OraInstructionText."
setHeaderInstructions
public final void setHeaderInstructions(UINode headerInstructionsNode)
- A short instructional text which will display in the header
block of the LOV window. This must be a styledText node, it is expected to
have a class of "OraInstructionText."
getSearchInstructions
public final UINode getSearchInstructions()
- A short instructional text which will display in the search block
of the LOV window. This must be a styledText node, it is expected to
have a class of "OraInstructionText."
setSearchInstructions
public final void setSearchInstructions(UINode searchInstructionsNode)
- A short instructional text which will display in the search block
of the LOV window. This must be a styledText node, it is expected to
have a class of "OraInstructionText."
getFilterChoice
public final UINode getFilterChoice()
- This choice node should list all the table headers by which a user could
search for their desired value. For instance, when searching for a
department, the location and name columns might be valid filter columns,
the developer may wish to display the department number, but not allow the
user to filter by it. In this case this choice would contain only
"Department" and "Location" items, not "Department Number". If there is
only one logical filter column, this node can be omitted.
setFilterChoice
public final void setFilterChoice(UINode filterChoiceNode)
- This choice node should list all the table headers by which a user could
search for their desired value. For instance, when searching for a
department, the location and name columns might be valid filter columns,
the developer may wish to display the department number, but not allow the
user to filter by it. In this case this choice would contain only
"Department" and "Location" items, not "Department Number". If there is
only one logical filter column, this node can be omitted.
getMessages
public final UINode getMessages()
- A message box to display any relevant error messages.
setMessages
public final void setMessages(UINode messagesNode)
- A message box to display any relevant error messages.
getAdvancedChoices
public final UINode getAdvancedChoices()
- A layout of text input and choice fields. This layout is displayed only
when the searchAreaMode attribute is set to "advanced". This will generally
be a set of textInput fields and/or choice elements allowing the user to do
multi-column searches. The dialog layout is designed to work best with a
labeledFieldLayout here.
setAdvancedChoices
public final void setAdvancedChoices(UINode advancedChoicesNode)
- A layout of text input and choice fields. This layout is displayed only
when the searchAreaMode attribute is set to "advanced". This will generally
be a set of textInput fields and/or choice elements allowing the user to do
multi-column searches. The dialog layout is designed to work best with a
labeledFieldLayout here.
getStateCheck
public final java.lang.String getStateCheck()
- Gets The name of a javascript function that will be called immediately prior to
the onLovSelect callback, and prior to the delivery of the lovSelect event.
Normally the LOV window will close immediately after the delivery of the
lovSelect event. However, if this attribute is supplied, and the named
method returns FALSE, the window will not be closed. This facility provides
the client a means to check the state of the table selections. If the user
has not made any selections from the table data (in the currently displayed
rowset or from one previously displayed), the client may wish for the LOV
window to remain displayed, but with an error message displayed (using the
named child).
setStateCheck
public final void setStateCheck(java.lang.String stateCheck)
- Sets The name of a javascript function that will be called immediately prior to
the onLovSelect callback, and prior to the delivery of the lovSelect event.
Normally the LOV window will close immediately after the delivery of the
lovSelect event. However, if this attribute is supplied, and the named
method returns FALSE, the window will not be closed. This facility provides
the client a means to check the state of the table selections. If the user
has not made any selections from the table data (in the currently displayed
rowset or from one previously displayed), the client may wish for the LOV
window to remain displayed, but with an error message displayed (using the
named child).
getTitle
public final java.lang.String getTitle()
- Gets the field to which this list of values applies. This attribute is merely
informational for the end user. It will appear in the uppermost header in
the displayed dialog (Search and Select: __title__).
This is a required property on the bean.
setTitle
public final void setTitle(java.lang.String title)
- Sets the field to which this list of values applies. This attribute is merely
informational for the end user. It will appear in the uppermost header in
the displayed dialog (Search and Select: __title__).
This is a required property on the bean.
getSearchAreaMode
public final java.lang.String getSearchAreaMode()
- Gets How to display the search area. Recognized values are: 'basic', 'filter',
'simple', and 'advanced'. The default is 'basic'.
For backwards compatibility, if a filterChoice child is present and
searchAreaMode is not set, the search block will be rendered in 'filter'
mode. This fallback is deprecated. The suggested approach is: always set
searchAreaMode to the mode desired. In a future release the default will
ALWAYS be 'basic' no matter which named children are present.
setSearchAreaMode
public final void setSearchAreaMode(java.lang.String searchAreaMode)
- Sets How to display the search area. Recognized values are: 'basic', 'filter',
'simple', and 'advanced'. The default is 'basic'.
For backwards compatibility, if a filterChoice child is present and
searchAreaMode is not set, the search block will be rendered in 'filter'
mode. This fallback is deprecated. The suggested approach is: always set
searchAreaMode to the mode desired. In a future release the default will
ALWAYS be 'basic' no matter which named children are present.
getSearchText
public final java.lang.String getSearchText()
- Gets The string that is being searched on. It is the responsibility of
the developer supplying the resultsTable to actually fill in the
table based on this value. This value will be displayed in a textInput
field. When the end-user clicks the 'GO' button, a "lovFilter" event
will be generated, and the new searchText will be in the "searchText"
parameter.
setSearchText
public final void setSearchText(java.lang.String searchText)
- Sets The string that is being searched on. It is the responsibility of
the developer supplying the resultsTable to actually fill in the
table based on this value. This value will be displayed in a textInput
field. When the end-user clicks the 'GO' button, a "lovFilter" event
will be generated, and the new searchText will be in the "searchText"
parameter.
getDestination
public final java.lang.String getDestination()
- Gets The URL to which the form will be submitted. This will usually be null, or
point back to the main page from which the LOV was called (the default).
setDestination
public final void setDestination(java.lang.String destination)
- Sets The URL to which the form will be submitted. This will usually be null, or
point back to the main page from which the LOV was called (the default).
getHeaderInstructions
public static UINode getHeaderInstructions(MutableUINode bean)
- A short instructional text which will display in the header
block of the LOV window. This must be a styledText node, it is expected to
have a class of "OraInstructionText."
setHeaderInstructions
public static void setHeaderInstructions(MutableUINode bean,
UINode headerInstructionsNode)
- A short instructional text which will display in the header
block of the LOV window. This must be a styledText node, it is expected to
have a class of "OraInstructionText."
getSearchInstructions
public static UINode getSearchInstructions(MutableUINode bean)
- A short instructional text which will display in the search block
of the LOV window. This must be a styledText node, it is expected to
have a class of "OraInstructionText."
setSearchInstructions
public static void setSearchInstructions(MutableUINode bean,
UINode searchInstructionsNode)
- A short instructional text which will display in the search block
of the LOV window. This must be a styledText node, it is expected to
have a class of "OraInstructionText."
getFilterChoice
public static UINode getFilterChoice(MutableUINode bean)
- This choice node should list all the table headers by which a user could
search for their desired value. For instance, when searching for a
department, the location and name columns might be valid filter columns,
the developer may wish to display the department number, but not allow the
user to filter by it. In this case this choice would contain only
"Department" and "Location" items, not "Department Number". If there is
only one logical filter column, this node can be omitted.
setFilterChoice
public static void setFilterChoice(MutableUINode bean,
UINode filterChoiceNode)
- This choice node should list all the table headers by which a user could
search for their desired value. For instance, when searching for a
department, the location and name columns might be valid filter columns,
the developer may wish to display the department number, but not allow the
user to filter by it. In this case this choice would contain only
"Department" and "Location" items, not "Department Number". If there is
only one logical filter column, this node can be omitted.
getMessages
public static UINode getMessages(MutableUINode bean)
- A message box to display any relevant error messages.
setMessages
public static void setMessages(MutableUINode bean,
UINode messagesNode)
- A message box to display any relevant error messages.
getAdvancedChoices
public static UINode getAdvancedChoices(MutableUINode bean)
- A layout of text input and choice fields. This layout is displayed only
when the searchAreaMode attribute is set to "advanced". This will generally
be a set of textInput fields and/or choice elements allowing the user to do
multi-column searches. The dialog layout is designed to work best with a
labeledFieldLayout here.
setAdvancedChoices
public static void setAdvancedChoices(MutableUINode bean,
UINode advancedChoicesNode)
- A layout of text input and choice fields. This layout is displayed only
when the searchAreaMode attribute is set to "advanced". This will generally
be a set of textInput fields and/or choice elements allowing the user to do
multi-column searches. The dialog layout is designed to work best with a
labeledFieldLayout here.
getStateCheck
public static java.lang.String getStateCheck(MutableUINode bean)
- Gets The name of a javascript function that will be called immediately prior to
the onLovSelect callback, and prior to the delivery of the lovSelect event.
Normally the LOV window will close immediately after the delivery of the
lovSelect event. However, if this attribute is supplied, and the named
method returns FALSE, the window will not be closed. This facility provides
the client a means to check the state of the table selections. If the user
has not made any selections from the table data (in the currently displayed
rowset or from one previously displayed), the client may wish for the LOV
window to remain displayed, but with an error message displayed (using the
named child).
setStateCheck
public static void setStateCheck(MutableUINode bean,
java.lang.String stateCheck)
- Sets The name of a javascript function that will be called immediately prior to
the onLovSelect callback, and prior to the delivery of the lovSelect event.
Normally the LOV window will close immediately after the delivery of the
lovSelect event. However, if this attribute is supplied, and the named
method returns FALSE, the window will not be closed. This facility provides
the client a means to check the state of the table selections. If the user
has not made any selections from the table data (in the currently displayed
rowset or from one previously displayed), the client may wish for the LOV
window to remain displayed, but with an error message displayed (using the
named child).
getTitle
public static java.lang.String getTitle(MutableUINode bean)
- Gets the field to which this list of values applies. This attribute is merely
informational for the end user. It will appear in the uppermost header in
the displayed dialog (Search and Select: __title__).
This is a required property on the bean.
setTitle
public static void setTitle(MutableUINode bean,
java.lang.String title)
- Sets the field to which this list of values applies. This attribute is merely
informational for the end user. It will appear in the uppermost header in
the displayed dialog (Search and Select: __title__).
This is a required property on the bean.
getSearchAreaMode
public static java.lang.String getSearchAreaMode(MutableUINode bean)
- Gets How to display the search area. Recognized values are: 'basic', 'filter',
'simple', and 'advanced'. The default is 'basic'.
For backwards compatibility, if a filterChoice child is present and
searchAreaMode is not set, the search block will be rendered in 'filter'
mode. This fallback is deprecated. The suggested approach is: always set
searchAreaMode to the mode desired. In a future release the default will
ALWAYS be 'basic' no matter which named children are present.
setSearchAreaMode
public static void setSearchAreaMode(MutableUINode bean,
java.lang.String searchAreaMode)
- Sets How to display the search area. Recognized values are: 'basic', 'filter',
'simple', and 'advanced'. The default is 'basic'.
For backwards compatibility, if a filterChoice child is present and
searchAreaMode is not set, the search block will be rendered in 'filter'
mode. This fallback is deprecated. The suggested approach is: always set
searchAreaMode to the mode desired. In a future release the default will
ALWAYS be 'basic' no matter which named children are present.
getSearchText
public static java.lang.String getSearchText(MutableUINode bean)
- Gets The string that is being searched on. It is the responsibility of
the developer supplying the resultsTable to actually fill in the
table based on this value. This value will be displayed in a textInput
field. When the end-user clicks the 'GO' button, a "lovFilter" event
will be generated, and the new searchText will be in the "searchText"
parameter.
setSearchText
public static void setSearchText(MutableUINode bean,
java.lang.String searchText)
- Sets The string that is being searched on. It is the responsibility of
the developer supplying the resultsTable to actually fill in the
table based on this value. This value will be displayed in a textInput
field. When the end-user clicks the 'GO' button, a "lovFilter" event
will be generated, and the new searchText will be in the "searchText"
parameter.
getDestination
public static java.lang.String getDestination(MutableUINode bean)
- Gets The URL to which the form will be submitted. This will usually be null, or
point back to the main page from which the LOV was called (the default).
setDestination
public static void setDestination(MutableUINode bean,
java.lang.String destination)
- Sets The URL to which the form will be submitted. This will usually be null, or
point back to the main page from which the LOV was called (the default).