oracle.cabo.ui.beans.nav
Class BrowseMenuBean

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.nav.BrowseMenuBean

All Implemented Interfaces:

MutableUINode, UIConstants, UINode

public class BrowseMenuBean

extends MarlinBean

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

The BrowseMenu is used in applications where information is in a hierarchical tree-like structure of categories (internal nodes) and items (leaves). The user can drill down through categories to find the item he/she is looking for. The BrowseMenu can contain any number of categories, subcategories and subsubcategories. The purpose of the BrowseMenu is to allow users to browse through complex sets of hierarchical objects, looking at one node at a time.

BrowseMenu Attributes and Children

The BrowseMenuBean supports the following attributes:

• TITLE - Sets the title of the BrowseMenu. This text will be displayed in the top header. If this attribute is not set the default text will be set to "Browse".
• CATEGORY_TITLE - Sets the title of the category section. This text will be displayed in the header above the categories. There are two ways to prevent this header from rendering. If the CATEGORIES named child is null or if its RENDERED attribute is set to false, the header will not render. Thus, for example, if there are no categories, you can arrange for this title not to be rendered.
• ITEM_TITLE - Sets the title of the items section. This text will be displayed in the header above the items. If this attribute is not set the default text will be set to "Items". There are two ways to prevent this header from rendering. If the ITEMS named child is null or if its RENDERED attribute is set to false, the header will not render. Thus, for example, if there are no items, you can arrange for this title not to be rendered.
• LONG_DESC - Sets the description seen just under the title to describe the current location. If this attribute is not set the default text will be set to the empty string.
• FORM_NAME - The name of the form to submit.
• FORM_SUBMITTED - Whether or not to use form submission. Form submission is not the default, thus if form submission is desired then this attribute ought to be explicitly set to true.

The BrowseMenuBean supports four named children:

• LOCATION - Bean to use to render locator element on top of BrowseMenu. If this child exists but is empty, the RENDERED attribute should be set to false so that the spacing is correctly displayed.
• CONTENT_LINK - Bean to use to link to content of the current category. If this child exists but is empty, the RENDERED attribute should be set to false so that the spacing is correctly displayed.
• CATEGORIES - Bean to use to render categories. The header displaying the text of the attribute CATEGORY_TITLE will be rendered only if this child is not null and if the RENDERED attribute of this child is true.
• ITEMS - Bean to use to render items. The header displaying the text of the attribute ITEM_TITLE will be rendered only if this child is not null and if the RENDERED attribute of this child is true.

The BrowseMenuBean is essentially a layout manager which places these named children at the appropriate locations. The BLAF guidlines show a BreadCrumbsBean as the location element, a LinkBean as the content link element, a BulletedListBean to display categories and another BulletedListBean to display items.

BrowseMenu Usage

The BrowseMenu is meant to help navigate hierarchical data, but the hierarchical data isn't added to the BrowseMenu itself. Instead, we provide the class BrowseNodeDataObject which can extract the appropriate information from data that is stored hierarchically. Furthermore, users who wish to use the BLAF guideline BrowseMenu can use BrowseMenuUtils.configureBrowseMenu to easily add the appropriate attributes and children to a BrowseMenu. Furthermore, BrowseNodeDataObject can be used to wire up the data. Please see BrowseMenuUtils and BrowseNodeDataObject for further information.

The BrowseMenuBean itself, however, expects the named children to contain all the appropriate data. As mentioned above the bean is really a layout manager. If you are not using BrowseMenuUtils you will need to construct beans with the appropriate data and add them as named children.

The expected behavior of BrowseMenu is that when you click on a category the BrowseMenu takes you to a view of the data at that level. This functionality is not provided by the BrowseMenuBean. BrowseMenuUtils in combination with BrowseNodeDataObject provides one default implementation of this functionality which can be used either in part or in full.

Example:

An example setup of the data and handler for an interactive browse menu. Replace the comment with one of the browse menu's below.

   <ctrl:content>
     <dataScope xmlns="http://xmlns.oracle.com/uix/ui">
       <provider>
         <data name="data:browseData">
           <method class="oracle.cabo.servlet.demo.BrowseMenuData"
                   method="getBrowseNodeDataObject"/>
         </data>
 
         <data name="data:Nodes">
           <inline>
             <nodes text="Shop"
                    destination="http://www.oracle.com"
                    expandable="expanded"
                    selected="true">
               <nodes text="Books"
                      destination="http://www.oracle.com"
                      expandable="expanded">
                 <nodes text="Sale"
                        destination="http://www.oracle.com"
                        expandable="expanded"
                        selected="true">
                   <nodes text="Millennium"
                          destination="http://www.oracle.com" />
                 </nodes>
                 <nodes text="Fiction"
                    destination="http://www.oracle.com"/>
                 <nodes text="Non-Fiction"
                    destination="http://www.oracle.com"/>
               </nodes>
               <nodes text="Hardware"
                  expandable="expanded" >
               <nodes text="Desktops"
                  destination="http://www.oracle.com"/>
               <nodes text="Notebooks"
                  destination="http://www.oracle.com"/>
               </nodes>
             </nodes>
           </inline>
         </data>
 
       </provider>
       <contents>
         <form name="myForm">
           <contents>
 
 
             <!-- REPLACE THIS COMMENT WITH
                      ONE OF THE EXAMPLES BELOW -->
 
 
 
           </contents>
         </form>
       </contents>
     </dataScope>
 
   </ctrl:content>
   <ctrl:handlers xmlns="http://xmlns.oracle.com/uix/controller">
 
     <event name="browse">
       <method class="oracle.cabo.servlet.demo.BrowseMenuData"
               method="browseEventHandler"/>
     </event>
 
   </ctrl:handlers>

An example of a browse menu.

   <browseMenu id="myBrowseMenu"
               data:title="text@data:browseData"
               data:longDesc="description@data:browseData"
               formSubmitted="true"
               formName="myForm">
     <location>
       <breadCrumbs data:rendered="renderLocation@data:browseData">
         <contents data:childData="locationData@data:browseData">
           <link data:text="text" data:destination="destination"/>
         </contents>
       </breadCrumbs>
     </location>
     <contentLink>
       <link data:text="destinationText@data:browseData"
             data:destination="destination@data:browseData"
             data:rendered="renderContentLink@data:browseData"/>
     </contentLink>
     <categories>
       <bulletedList data:rendered="renderCategories@data:browseData">
         <contents data:childData="categoriesData@data:browseData">
           <link data:text="text" data:destination="destination"/>
         </contents>
       </bulletedList>
     </categories>
     <items>
       <bulletedList data:rendered="renderItems@data:browseData">
         <contents data:childData="itemsData@data:browseData">
           <link data:text="text" data:destination="destination"/>
         </contents>
       </bulletedList>
     </items>
   </browseMenu>

An example of a browse menu which uses BrowseMenuUtils to configure the browse menu

   <browseMenu id="myBrowseMenu"
               formSubmitted="true"
               defaultContents="true"
               source="data:browseData"/>

See Also:

BrowseMenuUtils, BrowseNodeDataObject, UIConstants

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

	BrowseMenuBean() Construct an instance of the BrowseMenuBean.
protected	BrowseMenuBean(boolean ignored, java.lang.String localName) Construct an instance of the BrowseMenuBean.
	BrowseMenuBean(UINode locationNode, UINode contentLinkNode, UINode itemsNode, UINode categoriesNode) Construct an instance of the BrowseMenuBean.

Method Summary

UINode	getCategories() Bean to use to render categories.
static UINode	getCategories(MutableUINode bean) Bean to use to render categories.
java.lang.String	getCategoryTitle() Gets the title of the category section.
static java.lang.String	getCategoryTitle(MutableUINode bean) Gets the title of the category section.
UINode	getContentLink() Bean to use to link to category content.
static UINode	getContentLink(MutableUINode bean) Bean to use to link to category content.
java.lang.String	getFormName() Gets form to which browseMenu events should be submitted
static java.lang.String	getFormName(MutableUINode bean) Gets form to which browseMenu events should be submitted
UINode	getItems() Bean to use to render items.
static UINode	getItems(MutableUINode bean) Bean to use to render items.
java.lang.String	getItemTitle() Gets the title of the items section.
static java.lang.String	getItemTitle(MutableUINode bean) Gets the title of the items section.
UINode	getLocation() Bean to use to render locator element at top.
static UINode	getLocation(MutableUINode bean) Bean to use to render locator element at top.
java.lang.String	getLongDesc() Gets the description seen just under the title to describe the current location.
static java.lang.String	getLongDesc(MutableUINode bean) Gets the description seen just under the title to describe the current location.
java.lang.String	getTitle() Gets the title of the browse menu.
static java.lang.String	getTitle(MutableUINode bean) Gets the title of the browse menu.
boolean	isFormSubmitted() Gets Sets whether or not to use form submission
static boolean	isFormSubmitted(MutableUINode bean) Gets Sets whether or not to use form submission
boolean	isUnvalidated() Gets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server.
static boolean	isUnvalidated(MutableUINode bean) Gets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server.
static void	setCategories(MutableUINode bean, UINode categoriesNode) Bean to use to render categories.
void	setCategories(UINode categoriesNode) Bean to use to render categories.
static void	setCategoryTitle(MutableUINode bean, java.lang.String categoryTitle) Sets the title of the category section.
void	setCategoryTitle(java.lang.String categoryTitle) Sets the title of the category section.
static void	setContentLink(MutableUINode bean, UINode contentLinkNode) Bean to use to link to category content.
void	setContentLink(UINode contentLinkNode) Bean to use to link to category content.
static void	setFormName(MutableUINode bean, java.lang.String formName) Sets form to which browseMenu events should be submitted
void	setFormName(java.lang.String formName) Sets form to which browseMenu events should be submitted
void	setFormSubmitted(boolean formSubmitted) Sets Sets whether or not to use form submission
static void	setFormSubmitted(MutableUINode bean, boolean formSubmitted) Sets Sets whether or not to use form submission
static void	setItems(MutableUINode bean, UINode itemsNode) Bean to use to render items.
void	setItems(UINode itemsNode) Bean to use to render items.
static void	setItemTitle(MutableUINode bean, java.lang.String itemTitle) Sets the title of the items section.
void	setItemTitle(java.lang.String itemTitle) Sets the title of the items section.
static void	setLocation(MutableUINode bean, UINode locationNode) Bean to use to render locator element at top.
void	setLocation(UINode locationNode) Bean to use to render locator element at top.
static void	setLongDesc(MutableUINode bean, java.lang.String longDesc) Sets the description seen just under the title to describe the current location.
void	setLongDesc(java.lang.String longDesc) Sets the description seen just under the title to describe the current location.
static void	setTitle(MutableUINode bean, java.lang.String title) Sets the title of the browse menu.
void	setTitle(java.lang.String title) Sets the title of the browse menu.
static void	setTranslatableCategoryTitle(MutableUINode bean, java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the title of the category section.
void	setTranslatableCategoryTitle(java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the title of the category section.
static void	setTranslatableItemTitle(MutableUINode bean, java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the title of the items section.
void	setTranslatableItemTitle(java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the title of the items section.
static void	setTranslatableTitle(MutableUINode bean, java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the title of the browse menu.
void	setTranslatableTitle(java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the title of the browse menu.
void	setUnvalidated(boolean unvalidated) Sets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server.
static void	setUnvalidated(MutableUINode bean, boolean unvalidated) Sets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server.

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

BrowseMenuBean

public BrowseMenuBean()

Construct an instance of the BrowseMenuBean.

BrowseMenuBean

public BrowseMenuBean(UINode locationNode,
                      UINode contentLinkNode,
                      UINode itemsNode,
                      UINode categoriesNode)

Construct an instance of the BrowseMenuBean.

Parameters:

locationNode - Bean to use to render locator element at top.

contentLinkNode - Bean to use to link to category content.

itemsNode - Bean to use to render items.

categoriesNode - Bean to use to render categories.

BrowseMenuBean

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

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

Method Detail

getContentLink

public final UINode getContentLink()

Bean to use to link to category content.

setContentLink

public final void setContentLink(UINode contentLinkNode)

Bean to use to link to category content.

getItems

public final UINode getItems()

Bean to use to render items.

setItems

public final void setItems(UINode itemsNode)

Bean to use to render items.

getCategories

public final UINode getCategories()

Bean to use to render categories.

setCategories

public final void setCategories(UINode categoriesNode)

Bean to use to render categories.

getLocation

public final UINode getLocation()

Bean to use to render locator element at top.

setLocation

public final void setLocation(UINode locationNode)

Bean to use to render locator element at top.

getTitle

public final java.lang.String getTitle()

Gets the title of the browse menu. This text will be displayed in the top header. If this attribute is not set the default text will be set to "Browse".

setTitle

public final void setTitle(java.lang.String title)

Sets the title of the browse menu. This text will be displayed in the top header. If this attribute is not set the default text will be set to "Browse".

setTranslatableTitle

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

Binds to a ResourceBundle the the title of the browse menu. This text will be displayed in the top header. If this attribute is not set the default text will be set to "Browse".

Parameters:

bundleName - the name of the ResourceBundle

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

getCategoryTitle

public final java.lang.String getCategoryTitle()

Gets the title of the category section. This text will be displayed in the header above the categories. If this attribute is not set the default text will be set to "Categories".

setCategoryTitle

public final void setCategoryTitle(java.lang.String categoryTitle)

Sets the title of the category section. This text will be displayed in the header above the categories. If this attribute is not set the default text will be set to "Categories".

setTranslatableCategoryTitle

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

Binds to a ResourceBundle the the title of the category section. This text will be displayed in the header above the categories. If this attribute is not set the default text will be set to "Categories".

Parameters:

bundleName - the name of the ResourceBundle

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

getItemTitle

public final java.lang.String getItemTitle()

Gets the title of the items section. This text will be displayed in the header above the items. If this attribute is not set the default text will be set to "Items".

setItemTitle

public final void setItemTitle(java.lang.String itemTitle)

Sets the title of the items section. This text will be displayed in the header above the items. If this attribute is not set the default text will be set to "Items".

setTranslatableItemTitle

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

Binds to a ResourceBundle the the title of the items section. This text will be displayed in the header above the items. If this attribute is not set the default text will be set to "Items".

Parameters:

bundleName - the name of the ResourceBundle

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

getLongDesc

public final java.lang.String getLongDesc()

Gets the description seen just under the title to describe the current location. If this attribute is not set the default text will be set to nothing.

setLongDesc

public final void setLongDesc(java.lang.String longDesc)

Sets the description seen just under the title to describe the current location. If this attribute is not set the default text will be set to nothing.

isFormSubmitted

public final boolean isFormSubmitted()

Gets Sets whether or not to use form submission

setFormSubmitted

public final void setFormSubmitted(boolean formSubmitted)

Sets Sets whether or not to use form submission

isUnvalidated

public final boolean isUnvalidated()

Gets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server. This attribute allows this validation to be disabled.

setUnvalidated

public final void setUnvalidated(boolean unvalidated)

Sets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server. This attribute allows this validation to be disabled.

getFormName

public final java.lang.String getFormName()

Gets form to which browseMenu events should be submitted

setFormName

public final void setFormName(java.lang.String formName)

Sets form to which browseMenu events should be submitted

getContentLink

public static UINode getContentLink(MutableUINode bean)

Bean to use to link to category content.

setContentLink

public static void setContentLink(MutableUINode bean,
                                  UINode contentLinkNode)

Bean to use to link to category content.

getItems

public static UINode getItems(MutableUINode bean)

Bean to use to render items.

setItems

public static void setItems(MutableUINode bean,
                            UINode itemsNode)

Bean to use to render items.

getCategories

public static UINode getCategories(MutableUINode bean)

Bean to use to render categories.

setCategories

public static void setCategories(MutableUINode bean,
                                 UINode categoriesNode)

Bean to use to render categories.

getLocation

public static UINode getLocation(MutableUINode bean)

Bean to use to render locator element at top.

setLocation

public static void setLocation(MutableUINode bean,
                               UINode locationNode)

Bean to use to render locator element at top.

getTitle

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

Gets the title of the browse menu. This text will be displayed in the top header. If this attribute is not set the default text will be set to "Browse".

setTitle

public static void setTitle(MutableUINode bean,
                            java.lang.String title)

Sets the title of the browse menu. This text will be displayed in the top header. If this attribute is not set the default text will be set to "Browse".

setTranslatableTitle

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

Binds to a ResourceBundle the the title of the browse menu. This text will be displayed in the top header. If this attribute is not set the default text will be set to "Browse".

Parameters:

bundleName - the name of the ResourceBundle

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

getCategoryTitle

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

Gets the title of the category section. This text will be displayed in the header above the categories. If this attribute is not set the default text will be set to "Categories".

setCategoryTitle

public static void setCategoryTitle(MutableUINode bean,
                                    java.lang.String categoryTitle)

Sets the title of the category section. This text will be displayed in the header above the categories. If this attribute is not set the default text will be set to "Categories".

setTranslatableCategoryTitle

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

Binds to a ResourceBundle the the title of the category section. This text will be displayed in the header above the categories. If this attribute is not set the default text will be set to "Categories".

Parameters:

bundleName - the name of the ResourceBundle

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

getItemTitle

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

Gets the title of the items section. This text will be displayed in the header above the items. If this attribute is not set the default text will be set to "Items".

setItemTitle

public static void setItemTitle(MutableUINode bean,
                                java.lang.String itemTitle)

Sets the title of the items section. This text will be displayed in the header above the items. If this attribute is not set the default text will be set to "Items".

setTranslatableItemTitle

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

Binds to a ResourceBundle the the title of the items section. This text will be displayed in the header above the items. If this attribute is not set the default text will be set to "Items".

Parameters:

bundleName - the name of the ResourceBundle

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

getLongDesc

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

Gets the description seen just under the title to describe the current location. If this attribute is not set the default text will be set to nothing.

setLongDesc

public static void setLongDesc(MutableUINode bean,
                               java.lang.String longDesc)

Sets the description seen just under the title to describe the current location. If this attribute is not set the default text will be set to nothing.

isFormSubmitted

public static boolean isFormSubmitted(MutableUINode bean)

Gets Sets whether or not to use form submission

setFormSubmitted

public static void setFormSubmitted(MutableUINode bean,
                                    boolean formSubmitted)

Sets Sets whether or not to use form submission

isUnvalidated

public static boolean isUnvalidated(MutableUINode bean)

Gets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server. This attribute allows this validation to be disabled.

setUnvalidated

public static void setUnvalidated(MutableUINode bean,
                                  boolean unvalidated)

Sets If this element is used in formSubmitted mode, then the default behaviour is to validate all form inputs, before submitting to the server. This attribute allows this validation to be disabled.

getFormName

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

Gets form to which browseMenu events should be submitted

setFormName

public static void setFormName(MutableUINode bean,
                               java.lang.String formName)

Sets form to which browseMenu events should be submitted