oracle.cabo.ui.beans.form
Class ShuttleBean

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.ShuttleBean

All Implemented Interfaces:

MutableUINode, UIConstants, UINode

public class ShuttleBean

extends MarlinBean

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

The ShuttleBean provides a mechanism for moving items between two lists and reordering one of these lists. Often the shuttle will be used to select items from one list by placing them in the other. However, the shuttle can be used to operate on lists in other ways as well.

Attributes

The shuttle is required to have a name, from which the names of elements within the shuttle are derived. Set the NAME_ATTR attribute to the name of the shuttle.

Each list in the shuttle is required to have a header, the text of which should be set as the LEADING_HEADER_ATTR and the TRAILING_HEADER_ATTR.

Each container in the shuttle can have an area to display item descriptions below the list. To indicate whether or not a container should have such an area set the attributes LEADING_DESC_SHOWN_ATTR and the TRAILING_DESC_SHOWN_ATTR.

By default the trailing list of the shuttle has reorder icons next to it. To remove these icons so that the list cannot be reordered with them, set the REORDERABLE_ATTR to false.

To set the height of both lists in number of items, set the attribute SIZE_ATTR. Note that the size must be between 10 and 20 items. If the attribute is not set, a size is determined based on the lengths of both lists and the minimum and maximum values.

Shuttle Lists

The shuttle requires that two of its named children be specified. These are the LEADING_CHILD and the TRAILING_CHILD. Both children must be ListBeans which have the list contents (OptionBeans) as children. The leading child can be thought of as the "from" list and the trailing child as the "to" list when the shuttle is used to select items from a list. The shuttle has no indexed children.

The main function of the shuttle is to move items from one list to the other. The user can select one or multiple items in one list and, by choosing the appropriate icon between the lists, can move the items between lists. Clicking the "Move" icon or link moves the selected items in the leading list to the trailing list. Clicking the "Remove" icon or link moves the selected items in the trailing list to the leading list. Clicking the "Move All" icon or link moves all the items in the leading list to the trailing list. Clicking the "Remove All" icon or link moves all the items in the trailing list to the leading list.

The shuttle also allows the reordering of the trailing list. Using the icons on the side of the trailing list, one can move the selected items up to the top of the list, up one slot in the list, down to the bottom of the list, or down one slot in the list.

Note that when displayed, the lists will have a horizontal line below all items in the list. This additional item is present to maintain correct sizing of the lists; it cannot be acted upon like the other items in the lists.

Shuttle Footers

The shuttle allows the user to place buttons (ButtonBean) or icons (ImageBean) below each of the lists. These buttons or icons will take up only one row below the lists (no wrapping), and can have a maximum height of 26 pixels if the layout of the shuttle is to remain consistent. The buttons and icons should be placed within a FlowLayoutBean, and the layout bean should be added to the shuttle as the LEADING_FOOTER_CHILD or the TRAILING_FOOTER_CHILD depending on which list the buttons should go under. Leave the appropriate named child as null if no footer is required under a list. These buttons and icons can be used to perform operations upon the shuttle using a ShuttleProxy as described below.

Shuttle Filter

The shuttle allows the user to place a filter above the list in the leading container. The filter is added as the FILTER_CHILD. The filter can be used to perform operations upon the shuttle using a ShuttleProxy as described below.

Retrieving the Contents of the Lists

The shuttle is used when the contents (the options) of each list, not the selected items in the lists, are required upon submission. The contents of each list are stored as the value of hidden elements within the shuttle. These are passed along when the form is submitted through "-shuttleName-:Leading:items" and "-shuttleName-:Trailing:items," where -shuttleName- is the name given to the shuttle through its NAME_ATTR attribute. Each option is separated by a semicolon (;). The final option is also followed by a semicolon. The order of the options is consistent with their order in the lists. Each option is identified by it's value. If no value is set, the text of the option is given instead.

JavaScript proxies

In some cases, developers will need to use JavaScript to manipulate or use the contents of the lists. This may be required as actions for the buttons or icons in the shuttle footers or outside the shuttle all together. Thus, a set of Javascript utility methods are available that operate on the lists. These are located in the shuttle.js Javascript library, which is automatically loaded if you use the shuttle.

These methods can be accessed by creating a ShuttleProxy instance based on the shuttle name and form name.

                 // create the proxy object
                 var proxy2 = new ShuttleProxy("testShuttle2", "testForm2");
               

Once the proxy is created, you can use it to gain information about the lists or to manipulate the lists in the shuttle. The proxy provides the following functions:

• move(fromLeadingList, allItems) : moves items from one list to the other. If fromLeadingList is true, the items move from the leading list to the trailing list. If fromLeadingList is false, the items move the opposite direction. If allItems is true, all the items are moved, otherwise only the selected items are moved.
• reorderList(down, allTheWay, leadingList) : reorders a list. If down is true, the items move down in the list, otherwise they move up. If allTheWay is true, the items move all the way to the top or bottom of the list depending on the value of down. If leadingList is true, the leading list is reordered, otherwise the trailing list is reordered.
• getItems(leadingList) : returns an array of option objects that make up a list. If leadingList is true, the array has the leading list's options, otherwise the items are from the trailing list. Note that the array will not include the horizontal bar at the end of the lists.
• getSelectedItems(leadingList) : returns an array of option objects that are selected in a list. If leadingList is true, the array has the leading list's options, otherwise the items are from the trailingList. Note that the array will not include the horizontal bar at the end of the lists.
• getItemCount(leadingList) : returns the number of items in a list. If leadingList is true, the number returned is the number of items in the leading list. Otherwise, the number returned is the number of items in the trailing list. Note that the horizontal bar at the end of the lists is not included in this count -- you only get the number of actual items.
• getSelectedItemCount(leadingList) : returns the number of selected items in a list. If leadingList is true, the number returned is the number of selected items in the leading list. Otherwise, the number returned is the number of selected items in the trailing list. Note that the horizontal bar at the end of the lists is not included in this count -- you only get the number of actual items.
• addItem(leadingList, index, text, value, description) : adds an item at the given index to a list. The item is added to the leading list if leadingList is true, otherwise it is added to the trailing list. The index should be 0 based. Thus, to insert an item at the end of a list, set index to shuttleProxy.getItemCount(leadinglist). The text parameter specifies the display text for the item, while the value parameter specifies the value that represents this item upon form submission. The description parameter specifies a description of the item. The description parameter can be omitted.
• deleteItemByValue(leadingList, value) : deletes an item from a list. The item is deleted from the leading list if leadingList is true, otherwise it is deleted from the trailing list. The item deleted is the first item with the value (not text) of value.
• deleteSelectedItems(leadingList) : deletes items from a list. The items are deleted from the leading list if leadingList is true, otherwise they are deleted from the trailing list. The items deleted are the items that are selected in the appropriate list.

Example:

A basic shuttle with a button on the bottom of the trailing container.

    <shuttle name="shuttle1"
             leadingHeader="Header 1"
             trailingHeader="Header 2"
             size="5">
      <leading>
        <list>
          <contents>
            <option text="option 1"/>
            <option text="option 2"/>
            <option text="option 3"/>
            <option text="This is a very very long option 4"/>
          </contents>
        </list>
      </leading>
 
      <trailing>
        <list>
          <contents>
            <option text="2option 1"/>
            <option text="2option 2"/>
            <option text="2option 3"/>
            <option text="2option 4"/>
            <option text="2option 5"/>
          </contents>
        </list>
      </trailing>
 
      <trailingFooter>
        <flowLayout>
          <contents>
            <button text="A button"/>
          </contents>
        </flowLayout>
      </trailingFooter>
 
      <contents/>
    </shuttle>

A reorder list with descriptions and a filter.

    <shuttle name="shuttle2" leadingDescShown="true" leadingHeader="Reorder List">
 
      <filter>
        <rowLayout valign="center">
          <contents>
            <messagePrompt prompt="Filter"/>
            <spacer width="5" height="1"/>
            <choice name="binkyLovesWinky">
              <contents>
                <option text="filter 1" value="filter 1"/>
                <option text="filter 2" value="filter 2"/>
                <option text="filter 3" value="filter 3"/>
                <option text="filter 4" value="filter 4"/>
                <option text="filter 5" value="filter 5"/>
                <option text="filter 6" value="filter 6"/>
              </contents>
            </choice>
            <spacer width="3" height="1"/>
            <button text="Go" destination="#"/>
          </contents>
        </rowLayout>
      </filter>
      <leading>
        <list>
          <contents>
            <option text="choice 1" longDesc="choice 1 description"/>
            <option text="choice 2" longDesc="choice 2 description"/>
            <option text="choice 3" longDesc="choice 3 description"/>
            <option text="choice 4" longDesc="choice 4 description"/>
            <option text="choice 5" longDesc="choice 5 description"/>
            <option text="choice 6" longDesc="choice 6 description"/>
            <option text="choice 7" longDesc="choice 7 description"/>
            <option text="choice 8" longDesc="choice 8 description"/>
            <option text="choice 9" longDesc="choice 9 description"/>
            <option text="choice 10" longDesc="choice 10 description"/>
            <option text="choice 11" longDesc="choice 11 description"/>
            <option text="choice 12 is longer!" longDesc="choice 12 description"/>
          </contents>
        </list>
      </leading>
      <contents/>
    </shuttle>

See Also:

UIConstants, ListBean, FlowLayoutBean, ButtonBean, ImageBean

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

	ShuttleBean() Construct an instance of the ShuttleBean.
protected	ShuttleBean(boolean ignored, java.lang.String localName) Construct an instance of the ShuttleBean.
	ShuttleBean(java.lang.String name, java.lang.String leadingHeader, java.lang.String trailingHeader) Construct an instance of the ShuttleBean.
	ShuttleBean(java.lang.String name, java.lang.String leadingHeader, java.lang.String trailingHeader, int size) Construct an instance of the ShuttleBean.
	ShuttleBean(java.lang.String name, java.lang.String leadingHeader, java.lang.String trailingHeader, int size, UINode leadingNode, UINode trailingNode) Construct an instance of the ShuttleBean.

Method Summary

UINode	getFilter() the filter above the leading list.
static UINode	getFilter(MutableUINode bean) the filter above the leading list.
UINode	getLeading() the leading list of the shuttle.
static UINode	getLeading(MutableUINode bean) the leading list of the shuttle.
UINode	getLeadingFooter() the footer of buttons/images under the leading list.
static UINode	getLeadingFooter(MutableUINode bean) the footer of buttons/images under the leading list.
java.lang.String	getLeadingHeader() Gets the header of the leading list of the shuttle.
static java.lang.String	getLeadingHeader(MutableUINode bean) Gets the header of the leading list of the shuttle.
java.lang.String	getName() Gets the name used to identify the shuttle.
static java.lang.String	getName(MutableUINode bean) Gets the name used to identify the shuttle.
int	getSize() Gets the height in item number of each list in the shuttle.
static int	getSize(MutableUINode bean) Gets the height in item number of each list in the shuttle.
UINode	getTrailing() the trailing list of the shuttle.
static UINode	getTrailing(MutableUINode bean) the trailing list of the shuttle.
UINode	getTrailingFooter() the footer of buttons/images under the trailing list.
static UINode	getTrailingFooter(MutableUINode bean) the footer of buttons/images under the trailing list.
java.lang.String	getTrailingHeader() Gets the header of the trailing list of the shuttle.
static java.lang.String	getTrailingHeader(MutableUINode bean) Gets the header of the trailing list of the shuttle.
boolean	isLeadingDescShown() Gets whether or not the leading list has an area to display descriptions.
static boolean	isLeadingDescShown(MutableUINode bean) Gets whether or not the leading list has an area to display descriptions.
boolean	isReorderable() Gets a boolean value indicating whether or not the reorder icons should appear next to the trailing list.
static boolean	isReorderable(MutableUINode bean) Gets a boolean value indicating whether or not the reorder icons should appear next to the trailing list.
boolean	isTrailingDescShown() Gets whether or not the trailing list has an area to display descriptions.
static boolean	isTrailingDescShown(MutableUINode bean) Gets whether or not the trailing list has an area to display descriptions.
static void	setFilter(MutableUINode bean, UINode filterNode) the filter above the leading list.
void	setFilter(UINode filterNode) the filter above the leading list.
static void	setLeading(MutableUINode bean, UINode leadingNode) the leading list of the shuttle.
void	setLeading(UINode leadingNode) the leading list of the shuttle.
void	setLeadingDescShown(boolean leadingDescShown) Sets whether or not the leading list has an area to display descriptions.
static void	setLeadingDescShown(MutableUINode bean, boolean leadingDescShown) Sets whether or not the leading list has an area to display descriptions.
static void	setLeadingFooter(MutableUINode bean, UINode leadingFooterNode) the footer of buttons/images under the leading list.
void	setLeadingFooter(UINode leadingFooterNode) the footer of buttons/images under the leading list.
static void	setLeadingHeader(MutableUINode bean, java.lang.String leadingHeader) Sets the header of the leading list of the shuttle.
void	setLeadingHeader(java.lang.String leadingHeader) Sets the header of the leading list of the shuttle.
void	setLeadingHeaderBinding(BoundValue boundValue) Binds the the header of the leading list of the shuttle.
static void	setLeadingHeaderBinding(MutableUINode bean, BoundValue boundValue) Binds the the header of the leading list of the shuttle.
static void	setLeadingHeaderBinding(MutableUINode bean, java.lang.Object selectKey) Binds the the header of the leading list of the shuttle.
static void	setLeadingHeaderBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the the header of the leading list of the shuttle.
void	setLeadingHeaderBinding(java.lang.Object selectKey) Binds the the header of the leading list of the shuttle.
void	setLeadingHeaderBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the the header of the leading list of the shuttle.
static void	setName(MutableUINode bean, java.lang.String name) Sets the name used to identify the shuttle.
void	setName(java.lang.String name) Sets the name used to identify the shuttle.
void	setReorderable(boolean reorderable) Sets a boolean value indicating whether or not the reorder icons should appear next to the trailing list.
static void	setReorderable(MutableUINode bean, boolean reorderable) Sets a boolean value indicating whether or not the reorder icons should appear next to the trailing list.
void	setReorderableBinding(BoundValue boundValue) Binds the a boolean value indicating whether or not the reorder icons should appear next to the trailing list.
static void	setReorderableBinding(MutableUINode bean, BoundValue boundValue) Binds the a boolean value indicating whether or not the reorder icons should appear next to the trailing list.
static void	setReorderableBinding(MutableUINode bean, java.lang.Object selectKey) Binds the a boolean value indicating whether or not the reorder icons should appear next to the trailing list.
static void	setReorderableBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the a boolean value indicating whether or not the reorder icons should appear next to the trailing list.
void	setReorderableBinding(java.lang.Object selectKey) Binds the a boolean value indicating whether or not the reorder icons should appear next to the trailing list.
void	setReorderableBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the a boolean value indicating whether or not the reorder icons should appear next to the trailing list.
void	setSize(int size) Sets the height in item number of each list in the shuttle.
static void	setSize(MutableUINode bean, int size) Sets the height in item number of each list in the shuttle.
void	setSizeBinding(BoundValue boundValue) Binds the the height in item number of each list in the shuttle.
static void	setSizeBinding(MutableUINode bean, BoundValue boundValue) Binds the the height in item number of each list in the shuttle.
static void	setSizeBinding(MutableUINode bean, java.lang.Object selectKey) Binds the the height in item number of each list in the shuttle.
static void	setSizeBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the the height in item number of each list in the shuttle.
void	setSizeBinding(java.lang.Object selectKey) Binds the the height in item number of each list in the shuttle.
void	setSizeBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the the height in item number of each list in the shuttle.
static void	setTrailing(MutableUINode bean, UINode trailingNode) the trailing list of the shuttle.
void	setTrailing(UINode trailingNode) the trailing list of the shuttle.
void	setTrailingDescShown(boolean trailingDescShown) Sets whether or not the trailing list has an area to display descriptions.
static void	setTrailingDescShown(MutableUINode bean, boolean trailingDescShown) Sets whether or not the trailing list has an area to display descriptions.
static void	setTrailingFooter(MutableUINode bean, UINode trailingFooterNode) the footer of buttons/images under the trailing list.
void	setTrailingFooter(UINode trailingFooterNode) the footer of buttons/images under the trailing list.
static void	setTrailingHeader(MutableUINode bean, java.lang.String trailingHeader) Sets the header of the trailing list of the shuttle.
void	setTrailingHeader(java.lang.String trailingHeader) Sets the header of the trailing list of the shuttle.
void	setTrailingHeaderBinding(BoundValue boundValue) Binds the the header of the trailing list of the shuttle.
static void	setTrailingHeaderBinding(MutableUINode bean, BoundValue boundValue) Binds the the header of the trailing list of the shuttle.
static void	setTrailingHeaderBinding(MutableUINode bean, java.lang.Object selectKey) Binds the the header of the trailing list of the shuttle.
static void	setTrailingHeaderBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the the header of the trailing list of the shuttle.
void	setTrailingHeaderBinding(java.lang.Object selectKey) Binds the the header of the trailing list of the shuttle.
void	setTrailingHeaderBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the the header of the trailing list of the shuttle.
static void	setTranslatableLeadingHeader(MutableUINode bean, java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the header of the leading list of the shuttle.
void	setTranslatableLeadingHeader(java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the header of the leading list of the shuttle.
static void	setTranslatableTrailingHeader(MutableUINode bean, java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the header of the trailing list of the shuttle.
void	setTranslatableTrailingHeader(java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the header of the trailing list of the shuttle.

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

ShuttleBean

public ShuttleBean()

Construct an instance of the ShuttleBean.

ShuttleBean

public ShuttleBean(java.lang.String name,
                   java.lang.String leadingHeader,
                   java.lang.String trailingHeader)

Construct an instance of the ShuttleBean.

Parameters:

name - the name used to identify the shuttle.

leadingHeader - the header of the leading list of the shuttle.

trailingHeader - the header of the trailing list of the shuttle.

ShuttleBean

public ShuttleBean(java.lang.String name,
                   java.lang.String leadingHeader,
                   java.lang.String trailingHeader,
                   int size)

Construct an instance of the ShuttleBean.

Parameters:

name - the name used to identify the shuttle.

leadingHeader - the header of the leading list of the shuttle.

trailingHeader - the header of the trailing list of the shuttle.

size - the height in item number of each list in the shuttle.

ShuttleBean

public ShuttleBean(java.lang.String name,
                   java.lang.String leadingHeader,
                   java.lang.String trailingHeader,
                   int size,
                   UINode leadingNode,
                   UINode trailingNode)

Construct an instance of the ShuttleBean.

Parameters:

name - the name used to identify the shuttle.

leadingHeader - the header of the leading list of the shuttle.

trailingHeader - the header of the trailing list of the shuttle.

size - the height in item number of each list in the shuttle.

leadingNode - the leading list of the shuttle.

trailingNode - the trailing list of the shuttle.

ShuttleBean

protected ShuttleBean(boolean ignored,
                      java.lang.String localName)

Construct an instance of the ShuttleBean. Provided for subclasses that need distinct local names..

Method Detail

getLeading

public final UINode getLeading()

the leading list of the shuttle.

This is a required property on the bean.

setLeading

public final void setLeading(UINode leadingNode)

the leading list of the shuttle.

This is a required property on the bean.

getTrailing

public final UINode getTrailing()

the trailing list of the shuttle.

setTrailing

public final void setTrailing(UINode trailingNode)

the trailing list of the shuttle.

getFilter

public final UINode getFilter()

the filter above the leading list.

setFilter

public final void setFilter(UINode filterNode)

the filter above the leading list.

getLeadingFooter

public final UINode getLeadingFooter()

the footer of buttons/images under the leading list.

setLeadingFooter

public final void setLeadingFooter(UINode leadingFooterNode)

the footer of buttons/images under the leading list.

getTrailingFooter

public final UINode getTrailingFooter()

the footer of buttons/images under the trailing list.

setTrailingFooter

public final void setTrailingFooter(UINode trailingFooterNode)

the footer of buttons/images under the trailing list.

getName

public final java.lang.String getName()

Gets the name used to identify the shuttle.

This is a required property on the bean.

setName

public final void setName(java.lang.String name)

Sets the name used to identify the shuttle.

This is a required property on the bean.

getLeadingHeader

public final java.lang.String getLeadingHeader()

Gets the header of the leading list of the shuttle.

setLeadingHeader

public final void setLeadingHeader(java.lang.String leadingHeader)

Sets the header of the leading list of the shuttle.

setTranslatableLeadingHeader

public final void setTranslatableLeadingHeader(java.lang.String bundleName,
                                               java.lang.String key)

Binds to a ResourceBundle the the header of the leading list of the shuttle.

Parameters:

bundleName - the name of the ResourceBundle

key - the key of the string to retrieve from the ResourceBundle

setLeadingHeaderBinding

public final void setLeadingHeaderBinding(BoundValue boundValue)

Binds the the header of the leading list of the shuttle.

Parameters:

boundValue - a BoundValue implementation to be used to retrieve the value.

setLeadingHeaderBinding

public final void setLeadingHeaderBinding(java.lang.Object selectKey)

Binds the the header of the leading list of the shuttle.

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setLeadingHeaderBinding

public final void setLeadingHeaderBinding(java.lang.String dataNamespace,
                                          java.lang.String dataName,
                                          java.lang.Object selectKey)

Binds the the header of the leading list of the shuttle.

Parameters:

dataNamespace - the namespace to be passed to RenderingContext.getDataObject()

dataName - the name to be passed to RenderingContext.getDataObject()

selectKey - the key to be passed to selectValue() on the DataObject.

getTrailingHeader

public final java.lang.String getTrailingHeader()

Gets the header of the trailing list of the shuttle.

setTrailingHeader

public final void setTrailingHeader(java.lang.String trailingHeader)

Sets the header of the trailing list of the shuttle.

setTranslatableTrailingHeader

public final void setTranslatableTrailingHeader(java.lang.String bundleName,
                                                java.lang.String key)

Binds to a ResourceBundle the the header of the trailing list of the shuttle.

Parameters:

bundleName - the name of the ResourceBundle

key - the key of the string to retrieve from the ResourceBundle

setTrailingHeaderBinding

public final void setTrailingHeaderBinding(BoundValue boundValue)

Binds the the header of the trailing list of the shuttle.

Parameters:

boundValue - a BoundValue implementation to be used to retrieve the value.

setTrailingHeaderBinding

public final void setTrailingHeaderBinding(java.lang.Object selectKey)

Binds the the header of the trailing list of the shuttle.

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setTrailingHeaderBinding

public final void setTrailingHeaderBinding(java.lang.String dataNamespace,
                                           java.lang.String dataName,
                                           java.lang.Object selectKey)

Binds the the header of the trailing list of the shuttle.

Parameters:

dataNamespace - the namespace to be passed to RenderingContext.getDataObject()

dataName - the name to be passed to RenderingContext.getDataObject()

selectKey - the key to be passed to selectValue() on the DataObject.

isLeadingDescShown

public final boolean isLeadingDescShown()

Gets whether or not the leading list has an area to display descriptions.

setLeadingDescShown

public final void setLeadingDescShown(boolean leadingDescShown)

Sets whether or not the leading list has an area to display descriptions.

isTrailingDescShown

public final boolean isTrailingDescShown()

Gets whether or not the trailing list has an area to display descriptions.

setTrailingDescShown

public final void setTrailingDescShown(boolean trailingDescShown)

Sets whether or not the trailing list has an area to display descriptions.

getSize

public final int getSize()

Gets the height in item number of each list in the shuttle. The size must be between 10 and 20 items. If the attribute is not set, a size is determined based on the lengths of both lists.

setSize

public final void setSize(int size)

Sets the height in item number of each list in the shuttle. The size must be between 10 and 20 items. If the attribute is not set, a size is determined based on the lengths of both lists.

setSizeBinding

public final void setSizeBinding(BoundValue boundValue)

Binds the the height in item number of each list in the shuttle. The size must be between 10 and 20 items. If the attribute is not set, a size is determined based on the lengths of both lists.

Parameters:

boundValue - a BoundValue implementation to be used to retrieve the value.

setSizeBinding

public final void setSizeBinding(java.lang.Object selectKey)

Binds the the height in item number of each list in the shuttle. The size must be between 10 and 20 items. If the attribute is not set, a size is determined based on the lengths of both lists.

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setSizeBinding

public final void setSizeBinding(java.lang.String dataNamespace,
                                 java.lang.String dataName,
                                 java.lang.Object selectKey)

Binds the the height in item number of each list in the shuttle. The size must be between 10 and 20 items. If the attribute is not set, a size is determined based on the lengths of both lists.

Parameters:

dataNamespace - the namespace to be passed to RenderingContext.getDataObject()

dataName - the name to be passed to RenderingContext.getDataObject()

selectKey - the key to be passed to selectValue() on the DataObject.

isReorderable

public final boolean isReorderable()

Gets a boolean value indicating whether or not the reorder icons should appear next to the trailing list.

setReorderable

public final void setReorderable(boolean reorderable)

Sets a boolean value indicating whether or not the reorder icons should appear next to the trailing list.

setReorderableBinding

public final void setReorderableBinding(BoundValue boundValue)

Binds the a boolean value indicating whether or not the reorder icons should appear next to the trailing list.

Parameters:

boundValue - a BoundValue implementation to be used to retrieve the value.

setReorderableBinding

public final void setReorderableBinding(java.lang.Object selectKey)

Binds the a boolean value indicating whether or not the reorder icons should appear next to the trailing list.

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setReorderableBinding

public final void setReorderableBinding(java.lang.String dataNamespace,
                                        java.lang.String dataName,
                                        java.lang.Object selectKey)

Binds the a boolean value indicating whether or not the reorder icons should appear next to the trailing list.

Parameters:

dataNamespace - the namespace to be passed to RenderingContext.getDataObject()

dataName - the name to be passed to RenderingContext.getDataObject()

selectKey - the key to be passed to selectValue() on the DataObject.

getLeading

public static UINode getLeading(MutableUINode bean)

the leading list of the shuttle.

This is a required property on the bean.

setLeading

public static void setLeading(MutableUINode bean,
                              UINode leadingNode)

the leading list of the shuttle.

This is a required property on the bean.

getTrailing

public static UINode getTrailing(MutableUINode bean)

the trailing list of the shuttle.

setTrailing

public static void setTrailing(MutableUINode bean,
                               UINode trailingNode)

the trailing list of the shuttle.

getFilter

public static UINode getFilter(MutableUINode bean)

the filter above the leading list.

setFilter

public static void setFilter(MutableUINode bean,
                             UINode filterNode)

the filter above the leading list.

getLeadingFooter

public static UINode getLeadingFooter(MutableUINode bean)

the footer of buttons/images under the leading list.

setLeadingFooter

public static void setLeadingFooter(MutableUINode bean,
                                    UINode leadingFooterNode)

the footer of buttons/images under the leading list.

getTrailingFooter

public static UINode getTrailingFooter(MutableUINode bean)

the footer of buttons/images under the trailing list.

setTrailingFooter

public static void setTrailingFooter(MutableUINode bean,
                                     UINode trailingFooterNode)

the footer of buttons/images under the trailing list.

getName

public static java.lang.String getName(MutableUINode bean)

Gets the name used to identify the shuttle.

This is a required property on the bean.

setName

public static void setName(MutableUINode bean,
                           java.lang.String name)

Sets the name used to identify the shuttle.

This is a required property on the bean.

getLeadingHeader

public static java.lang.String getLeadingHeader(MutableUINode bean)

Gets the header of the leading list of the shuttle.

setLeadingHeader

public static void setLeadingHeader(MutableUINode bean,
                                    java.lang.String leadingHeader)

Sets the header of the leading list of the shuttle.

setTranslatableLeadingHeader

public static void setTranslatableLeadingHeader(MutableUINode bean,
                                                java.lang.String bundleName,
                                                java.lang.String key)

Binds to a ResourceBundle the the header of the leading list of the shuttle.

Parameters:

bundleName - the name of the ResourceBundle

key - the key of the string to retrieve from the ResourceBundle

setLeadingHeaderBinding

public static void setLeadingHeaderBinding(MutableUINode bean,
                                           BoundValue boundValue)

Binds the the header of the leading list of the shuttle.

Parameters:

boundValue - a BoundValue implementation to be used to retrieve the value.

setLeadingHeaderBinding

public static void setLeadingHeaderBinding(MutableUINode bean,
                                           java.lang.Object selectKey)

Binds the the header of the leading list of the shuttle.

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setLeadingHeaderBinding

public static void setLeadingHeaderBinding(MutableUINode bean,
                                           java.lang.String dataNamespace,
                                           java.lang.String dataName,
                                           java.lang.Object selectKey)

Binds the the header of the leading list of the shuttle.

Parameters:

dataNamespace - the namespace to be passed to RenderingContext.getDataObject()

dataName - the name to be passed to RenderingContext.getDataObject()

selectKey - the key to be passed to selectValue() on the DataObject.

getTrailingHeader

public static java.lang.String getTrailingHeader(MutableUINode bean)

Gets the header of the trailing list of the shuttle.

setTrailingHeader

public static void setTrailingHeader(MutableUINode bean,
                                     java.lang.String trailingHeader)

Sets the header of the trailing list of the shuttle.

setTranslatableTrailingHeader

public static void setTranslatableTrailingHeader(MutableUINode bean,
                                                 java.lang.String bundleName,
                                                 java.lang.String key)

Binds to a ResourceBundle the the header of the trailing list of the shuttle.

Parameters:

bundleName - the name of the ResourceBundle

key - the key of the string to retrieve from the ResourceBundle

setTrailingHeaderBinding

public static void setTrailingHeaderBinding(MutableUINode bean,
                                            BoundValue boundValue)

Binds the the header of the trailing list of the shuttle.

Parameters:

boundValue - a BoundValue implementation to be used to retrieve the value.

setTrailingHeaderBinding

public static void setTrailingHeaderBinding(MutableUINode bean,
                                            java.lang.Object selectKey)

Binds the the header of the trailing list of the shuttle.

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setTrailingHeaderBinding

public static void setTrailingHeaderBinding(MutableUINode bean,
                                            java.lang.String dataNamespace,
                                            java.lang.String dataName,
                                            java.lang.Object selectKey)

Binds the the header of the trailing list of the shuttle.

Parameters:

dataNamespace - the namespace to be passed to RenderingContext.getDataObject()

dataName - the name to be passed to RenderingContext.getDataObject()

selectKey - the key to be passed to selectValue() on the DataObject.

isLeadingDescShown

public static boolean isLeadingDescShown(MutableUINode bean)

Gets whether or not the leading list has an area to display descriptions.

setLeadingDescShown

public static void setLeadingDescShown(MutableUINode bean,
                                       boolean leadingDescShown)

Sets whether or not the leading list has an area to display descriptions.

isTrailingDescShown

public static boolean isTrailingDescShown(MutableUINode bean)

Gets whether or not the trailing list has an area to display descriptions.

setTrailingDescShown

public static void setTrailingDescShown(MutableUINode bean,
                                        boolean trailingDescShown)

Sets whether or not the trailing list has an area to display descriptions.

getSize

public static int getSize(MutableUINode bean)

Gets the height in item number of each list in the shuttle. The size must be between 10 and 20 items. If the attribute is not set, a size is determined based on the lengths of both lists.

setSize

public static void setSize(MutableUINode bean,
                           int size)

Sets the height in item number of each list in the shuttle. The size must be between 10 and 20 items. If the attribute is not set, a size is determined based on the lengths of both lists.

setSizeBinding

public static void setSizeBinding(MutableUINode bean,
                                  BoundValue boundValue)

Binds the the height in item number of each list in the shuttle. The size must be between 10 and 20 items. If the attribute is not set, a size is determined based on the lengths of both lists.

Parameters:

boundValue - a BoundValue implementation to be used to retrieve the value.

setSizeBinding

public static void setSizeBinding(MutableUINode bean,
                                  java.lang.Object selectKey)

Binds the the height in item number of each list in the shuttle. The size must be between 10 and 20 items. If the attribute is not set, a size is determined based on the lengths of both lists.

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setSizeBinding

public static void setSizeBinding(MutableUINode bean,
                                  java.lang.String dataNamespace,
                                  java.lang.String dataName,
                                  java.lang.Object selectKey)

Binds the the height in item number of each list in the shuttle. The size must be between 10 and 20 items. If the attribute is not set, a size is determined based on the lengths of both lists.

Parameters:

dataNamespace - the namespace to be passed to RenderingContext.getDataObject()

dataName - the name to be passed to RenderingContext.getDataObject()

selectKey - the key to be passed to selectValue() on the DataObject.

isReorderable

public static boolean isReorderable(MutableUINode bean)

Gets a boolean value indicating whether or not the reorder icons should appear next to the trailing list.

setReorderable

public static void setReorderable(MutableUINode bean,
                                  boolean reorderable)

Sets a boolean value indicating whether or not the reorder icons should appear next to the trailing list.

setReorderableBinding

public static void setReorderableBinding(MutableUINode bean,
                                         BoundValue boundValue)

Binds the a boolean value indicating whether or not the reorder icons should appear next to the trailing list.

Parameters:

boundValue - a BoundValue implementation to be used to retrieve the value.

setReorderableBinding

public static void setReorderableBinding(MutableUINode bean,
                                         java.lang.Object selectKey)

Binds the a boolean value indicating whether or not the reorder icons should appear next to the trailing list.

Parameters:

selectKey - the key to be passed to selectValue() on the current DataObject, e.g., the DataObject for the current table row.

setReorderableBinding

public static void setReorderableBinding(MutableUINode bean,
                                         java.lang.String dataNamespace,
                                         java.lang.String dataName,
                                         java.lang.Object selectKey)

Binds the a boolean value indicating whether or not the reorder icons should appear next to the trailing list.

Parameters:

dataNamespace - the namespace to be passed to RenderingContext.getDataObject()

dataName - the name to be passed to RenderingContext.getDataObject()

selectKey - the key to be passed to selectValue() on the DataObject.