: Class BrowseNodeDataObject

Overview

Package

Class

Tree

Deprecated

Index

Help

UIX 2.2.16

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.cabo.ui.data.tree
Class BrowseNodeDataObject

java.lang.Object
  |
  +--oracle.cabo.ui.data.tree.BrowseNodeDataObject

All Implemented Interfaces:: DataObject, UIConstants

public class BrowseNodeDataObject
extends java.lang.Object
implements DataObject, UIConstants

While the purpose of the BrowseMenuBean is to allow users to browse through complex sets of hierarchical objects, the hierarchical data isn't added to the BrowseMenu itself. BrowseNodeDataObject takes a tree of DataObjects and a current location and extracts the appropriate information.

BrowseNodeDataObject expects the nodes in the tree to use the following keys.

UIConstants.TEXT_KEY - The title of this node.
UIConstants.DESCRIPTION_KEY - The description or instructions for this node.
UIConstants.DESTINATION_KEY - The destination for this node.
UIConstants.DESTINATION_TEXT_KEY - The text for the destination for this node.
UIConstants.NODES_KEY - A DataObjectList containing the children of this node.

Usage

To begin with we will give an example of hierarchical, or tree-structured, data which we will use in subsequent examples:

    private SimpleTreeData createShopNode(
       String text,
       String description)
    {
      SimpleTreeData data = new SimpleTreeData();
      data.setText( text );
      if ( description != null )
       data.setDescription( description);

      data.setDestination( "http://bali.us.oracle.com");
      data.setDestinationText( "More Information");
      return data;
    }

    private DataObject createData()
    {
      SimpleTreeData treeRoot = new SimpleTreeData();
      SimpleTreeData shop  =
           createShopNode("Shop", "Spend some money!");
      SimpleTreeData books =
           createShopNode("Books", null);
      SimpleTreeData umbrellas  =
           createShopNode("Umbrellas", "Rain, rain go away");
      SimpleTreeData  art  =
           createShopNode("Art", "Picasso et al");

      books.addChild( art);
      shop.addChild(books);
      shop.addChild(umbrellas);

      return shop;
    }

So this is the tree:


         shop
        /    \
     books   umbrellas
      |
     art

So "art" and "umbrellas" are leaves and therefore items, while "shop" and "books" are categories. So "shop" is one of the 'roots' of this tree. There could theoretically be multiple roots.

So let's use BrowseMenuUtils to set up a "default" looking BrowseMenu using this data. In this example we are using a servlet. For those not familiar with servlets it may help to know that the init method is called once when the servlet is started while the doGet method is called once per request.

In init we would build the tree of UINodes and somewhere in there we might see the following:

    public void init(ServletConfig config)
    throws ServletException
    {
      .....

      // create the browse menu
      BrowseMenuBean browseMenu = new BrowseMenuBean();
      // give it page-wide-unique id - IMPORTANT!!
      browseMenu.setID(MY_BROWSE_MENU_NAME);

      // add the "default" containers
      BrowseMenuUtils.configureBrowseMenu(
           MY_NAMESPACEURI,
           MY_LOCALNAME,
           browseMenu);

      // set treeData, an instance field,
      // to be the tree described above
      treeData = createData();

      // put the browse menu in a form
      FormBean form = new FormBean("myForm");
      form.addIndexedChild(browseMenu);

      // add hidden field with current state so that if
      // another bean fires event the browseMenu's current
      // state is still sent back with the form
      FormValueBean hidden = new FormValueBean();
      hidden.setName( MY_BROWSE_MENU_NAME + ":State");
      hidden.setValueBinding( new DataBoundValue(
                  MY_NAMESPACEURI,
                  MY_LOCALNAME,
                  BrowseNodeDataObject.CURRENT_STATE_KEY));
      form.addIndexedChild(hidden);


      .....
    }

Then in the servlet's doGet we might have:

    public void doGet(
         HttpServletRequest request,
         HttpServletResponse response)
      throws ServletException, IOException
    {
      .....

      // get the state for the current location in the tree
      String currentLocation =
             request.getParameter("location");
      // if null then the state might have been sent
      // back with the form through the hidden field
      if ( currentLocation == null )
            currentLocation = request.getParameter(
                         MY_BROWSE_MENU_NAME + ":State");

      // create the data
      DataObject browseData = new BrowseNodeDataObject(
           treeData,
           currentLocation );

      // push the data on the context
      TableDataProvider provider = new TableDataProvider();
      provider.put(MY_NAMESPACEURI, MY_LOCALNAME, browseData);

      .....
    }

Please see below for more information about the line request.getParameter("location").

Keys

BrowseNodeDataObject takes a tree of data and a current location. The BrowseNodeDataObject uses the current location to go through the tree and find the current location node, to find the "books" node for example. The current location node is expected to return results when queried with:

UIConstants.TEXT_KEY
UIConstants.DESCRIPTION_KEY
UIConstants.DESTINATION_KEY
UIConstants.DESTINATION_TEXT_KEY
UIConstants.NODES_KEY

The BrowseNodeDataObject also creates data to be returned when queried with the following keys:

BrowseNodeDataObject.LOCATION_DATA_KEY - A DataObjectList with the nodes for the location child. These are all the nodes along the path from the root of the tree to the current location node.
BrowseNodeDataObject.CATEGORIES_DATA_KEY - A DataObjectList with the nodes for the categories child. These are all the children of the current location data object who have children themselves, or are not leaves in the tree.
BrowseNodeDataObject.ITEMS_DATA_KEY - A DataObjectList with the nodes for the items child. These are all the children of the current location data object who do not have children themselves, or are leaves in the tree.
BrowseNodeDataObject.RENDER_LOCATION_KEY - if the current location node is one of the 'roots' of the tree, this is set to Boolean.FALSE since the location child should only be seen relative to one of the 'roots'.
BrowseNodeDataObject.RENDER_CONTENT_LINK_KEY - if the current location node is queried with UIConstants.DESTINATION_TEXT_KEY and it returns no value or an empty string then this is set to Boolean.FALSE.
BrowseNodeDataObject.RENDER_CATEGORIES_KEY - if the current location node has no children who are categories, or internal nodes in the tree, this is set to Boolean.FALSE.
BrowseNodeDataObject.RENDER_ITEMS_KEY - if the current location node has no children who are items, or tree leaves, this is set to Boolean.FALSE.
BrowseNodeDataObject.CURRENT_STATE_KEY - A String containing the current state of the browse menu as passed in to the constructor.

So let's say the current location is the "books" node in the tree above. The keys above would return the following.

BrowseNodeDataObject.LOCATION_DATA_KEY - A DataObjectList containing the nodes "shop" and "books".
BrowseNodeDataObject.CATEGORIES_DATA_KEY - An empty DataObjectList. "books" has no children which are internal nodes.
BrowseNodeDataObject.ITEMS_DATA_KEY - A DataObjectList with the "art" node in it.
BrowseNodeDataObject.RENDER_LOCATION_KEY - set to Boolean.TRUE since "books" is not one of the 'roots'.
BrowseNodeDataObject.RENDER_CONTENT_LINK_KEY - set to Boolean.TRUE since the "books" node returns "more information" when queried with UIConstants.DESTINATION_TEXT_KEY.
BrowseNodeDataObject.RENDER_CATEGORIES_KEY - Set to Boolean.FALSE since there are no categories.
BrowseNodeDataObject.RENDER_ITEMS_KEY - Set to Boolean.TRUE since there are items.
BrowseNodeDataObject.CURRENT_STATE_KEY - A String containing the state indicating we are looking at the "books" node. In this case this string would be "0,0" since "shop" is roots[0] and "books" is its 0th child.

Destinations for 'location' and 'categories' Data

The location and categories data are DataObjectLists where the destination on each DataObject is retrieved with the key UIConstant.DESTINATION_KEY. The destination is set such that if a location or categories element is pressed the following name-value pairs are returned to the server:

'event'='browse'
'source'=ID of BrowseMenu
'location'=new location state

When the BrowseMenu's formSubmitted attribute is set to true, then the name-value pairs above are returned through form submission.

If the BrowseMenu's formSubmitted attribute is set to false or is not set then the destinations contain the destination passed in to the constructor to which the name-value pairs above are appended. If no destination was passed in or the destination passed in was null, then the destination returned by the call context.getURLEncoder().getDefaultURL() is used.

Therefore the line request.getParameter("location") above should return the value associated with the parameter name 'location'. Thus if a user has selected a category, for example, then the three name-value pairs above are sent to the server and the line request.getParameter("location") will return a String representing the new location state. The first time a client makes a request to the servlet this parameter will not exist, in which case the String returned will be null. When null is passed to the BrowseNodeDataObject constructor the currentLocation will be set to the default of "0", representing 'roots[0]'.

See Also:: SimpleTreeData, BrowseMenuUtils, BrowseMenuBean, UIConstants

Field Summary

static java.lang.String CATEGORIES_DATA_KEY
          key to pass to selectValue which returns a DataObjectList with the data for the categories child.

static java.lang.String CURRENT_STATE_KEY
          key to pass to selectValue which returns the String representing the current location state

static java.lang.String ITEMS_DATA_KEY
          key to pass to selectValue which returns a DataObjectList with the data for the items child.

static java.lang.String LOCATION_DATA_KEY
          key to pass to selectValue which returns a DataObjectList with the data for the location child.

static java.lang.String RENDER_CATEGORIES_KEY
          key to pass to selectValue which returns the Boolean value of whether or not to render the categories child

static java.lang.String RENDER_CONTENT_LINK_KEY
          key to pass to selectValue which returns the Boolean value of whether or not to render the contentLink child

static java.lang.String RENDER_ITEMS_KEY
          key to pass to selectValue which returns the Boolean value of whether or not to render the items child

static java.lang.String RENDER_LOCATION_KEY
          key to pass to selectValue which returns the Boolean value of whether or not to render the location child

Fields inherited from interface oracle.cabo.ui.UIConstants

ABBREVIATION_ATTR, ABOUT_CHILD, ACCESS_KEY_ATTR, ADD_NAME, ADD_ROWS_EVENT, ADD_TABLE_ROW_NAME, ADVANCED_CHOICES_CHILD, AGENT_NAME, ALIGNMENT_GROUP_ATTR, ALL_DETAILS_ENABLED_ATTR, ALLOWS_TRANSPARENT_ATTR, ALTERNATE_CONTENT_CHILD, ALTERNATE_TEXT_ATTR, ANCESTOR_ATTRIBUTE_NAME, ANCESTOR_ID_ATTR, ANCESTOR_PATH_ATTR, ANCHOR_ATTR, AND_NAME, ANNOTATION_ATTR, APPLICATION_SWITCHER_NAME, ARRAY_NODE_LIST_NAME, ATTRIBUTE_MAP_NAME, AUTOFLIP_ATTR, AUTOMATIC_ATTR, AUTOSTART_ATTR, BACKGROUND_ATTR, BACKGROUND_DARK, BACKGROUND_LIGHT, BACKGROUND_MEDIUM, BACKGROUND_TRANSPARENT, BANDING_INTERVAL_KEY, BANDING_SHADE_DARK, BANDING_SHADE_KEY, BANDING_SHADE_LIGHT, BEAN_NAME, BETWEEN_TEXT_ATTR, BLOCK_SIZE_ATTR, BODY_NAME, BORDER_LAYOUT_NAME, BORDER_WIDTH_ATTR, BOTTOM_CHILD, BOUND_ATTRIBUTE_NAME, BOUND_MESSAGE_NAME, BOUND_TEXT_NAME, BOUND_VALUE_PROVIDER_NAME, BREAD_CRUMB_TEXT_ATTR, BREAD_CRUMBS_NAME, BROWSE_EVENT, BROWSE_MENU_NAME, BULLETED_LIST_NAME, BULLETS_GROUP_ATTR, BUNDLE_NAME, BUTTON_NAME, BUTTONS_CHILD, BYTE_LENGTH_NAME, CALENDAR_ID_ATTR, CALENDAR_NAME, CANCEL_EVENT, CASE_NAME, CATCH_CHILD, CATEGORIES_CHILD, CATEGORY_TITLE_ATTR, CELL_FORMAT_NAME, CELL_NO_WRAP_FORMAT_KEY, CELL_PADDING_ATTR, CELL_SPACING_ATTR, CENTER_CHILD, CHECK_BOX_NAME, CHECKED_ATTR, CHILD_BLOCK_SIZE_ATTR, CHILD_DATA_ATTR, CHILD_LIST_NAME, CHILD_MAP_NAME, CHILD_NAME_ATTR, CHILD_TYPE_TEXT, CHILD_TYPE_TEXT_ATTR, CHOICE_NAME, CHROME_TYPE_ATTR, CLICK_THRU_DESTINATION_URI_ATTR, COBRANDING_CHILD, COLLAPSE_ALL_EVENT, COLLAPSE_DESTINATION_KEY, COLOR_BUTTON_NAME, COLOR_DATA_ATTR, COLOR_FIELD_NAME, COLOR_NAME, COLOR_PALETTE_NAME, COLOR_PICKER_NAME, COLOR_SWATCH_NAME, COLUMN_BANDING, COLUMN_DATA_FORMAT_KEY, COLUMN_FOOTER_CHILD, COLUMN_FORMAT_ATTR, COLUMN_FORMATS_ATTR, COLUMN_GROUP_NAME, COLUMN_HEADER_CHILD, COLUMN_HEADER_DATA_ATTR, COLUMN_HEADER_FORMAT_ATTR, COLUMN_HEADER_FORMATS_ATTR, COLUMN_HEADER_STAMP_CHILD, COLUMN_NAME, COLUMN_SPAN_ATTR, COLUMNS_ATTR, COMPACT_ATTR, COMPARISON_NAME, COMPARISON_TYPE_EQUALS, COMPARISON_TYPE_GREATER_THAN, COMPARISON_TYPE_GREATER_THAN_OR_EQUALS, COMPARISON_TYPE_LESS_THAN, COMPARISON_TYPE_LESS_THAN_OR_EQUALS, COMPARISON_TYPE_NOT_EQUALS, COMPOSITE_ROLE, CONCAT_NAME, CONCISE_MESSAGE_CHILD, CONFIG_NAME_PARAM, CONSUMER_NAME, CONTENT_CONTAINER_NAME, CONTENT_FOOTER_CHILD, CONTENT_FOOTER_NAME, CONTENT_FORM_CHILD, CONTENT_LINK_CHILD, CONTENT_STYLE_CLASS_ATTR, CONTENT_TYPE_ATTR, CONTENTS_NAME, CONTEXT_POPPING_NAME, CONTEXT_PROPERTY_NAME, CONTEXT_SWITCHER_CHILD, CONTEXT_URI_PARAM, CONTROLS_ALL, CONTROLS_ATTR, CONTROLS_MINIMAL, CONTROLS_NONE, CONTROLS_NONE_VISIBLE, CONTROLS_TYPICAL, CONVERT_NAME, CONVERT_PARAM, COPYRIGHT_CHILD, CORPORATE_BRANDING_CHILD, CURRENT_DATA_ATTR, CURRENT_INDEX_ATTR, CURRENT_THROWABLE_PROPERTY, CUSTOM_COLOR_DATA_ATTR, DATA_KEY, DATA_NAME, DATA_NAME_ATTR, DATA_NAMESPACE_ATTR, DATA_OBJECT_NAME, DATA_SCOPE_NAME, DATA_TYPE_ATTR, DATE_BUTTON_NAME, DATE_EVENT, DATE_FIELD_NAME, DATE_FORMAT_NAME, DATE_NAME, DATE_STYLE_PARAM, DECIMAL_NAME, DEFAULT_CASE_ATTR, DEFAULT_CONTENTS_ATTR, DEFAULT_FORM_NAME, DEFAULT_NAME, DEFAULTING_NAME, DESCRIPTION_ATTR, DESCRIPTION_KEY, DESTINATION_ATTR, DESTINATION_KEY, DESTINATION_TEXT_KEY, DETAIL_CHILD, DETAIL_DISCLOSURE_ATTR, DETAIL_SELECTOR_NAME, DETAILED_MESSAGE_CHILD, DIRECTION_ATTR, DIRTY_ATTR, DISABLED_ATTR, DISCLOSED_ATTR, DISCLOSED_KEY, DISCLOSED_TEXT_ATTR, DISPLAY_EXCEPTION_NAME, DISPLAY_GRID_KEY, DOCUMENT_NAME, EDGE_STAMP_CHILD, EDIT_GROUP_ATTR, EMBEDDED_ATTR, ENC_PARAM, ENCODED_PARAMETER_NAME, END_CHILD, ENTER_CLIENT_ACTION_ATTR, EVENT_ATTR, EVENT_PARAM, EXCEPTIONS_CAUGHT_PROPERTY, EXPAND_ALL_EVENT, EXPAND_DESTINATION_KEY, EXPAND_EVENT, EXPANDABLE_ALWAYS, EXPANDABLE_COLLAPSED, EXPANDABLE_EXPANDED, EXPANDABLE_KEY, EXPANDABLE_NO, EXPRESSION_LANGUAGE_ATTRIBUTE_NAME, FACET_DEFAULT, FACET_EMAIL, FACET_PORTLET, FACET_PRINTABLE, FIELD_WIDTH_ATTR, FILE_UPLOAD_NAME, FILTER_CHILD, FILTER_CHOICE_CHILD, FIRST_CLICK_PASSED_ATTR, FIXED_NAME, FLOW_LAYOUT_NAME, FOCUS_EVENT, FONT_BAR_ATTR, FONT_BEAN_ATTR, FONT_COLOR_BEAN_ATTR, FONT_SIZE_BEAN_ATTR, FOOTER_CHILD, FOOTER_NAME, FOOTNOTE_CHILD, FORM_DATA_ATTR, FORM_NAME, FORM_NAME_ATTR, FORM_NAME_PROPERTY, FORM_PARAMETER_NAME, FORM_SUBMITTED_ATTR, FORM_VALUE_NAME, FORMAT_NAME, FORMATTED_TEXT_NAME, FRAME_BORDER_LAYOUT_NAME, FRAME_NAME, GENERATES_CONTENT_ATTR, GLOBAL_BUTTON_BAR_NAME, GLOBAL_BUTTON_NAME, GLOBAL_BUTTONS_CHILD, GLOBAL_HEADER_NAME, GOTO_EVENT, GRAPH_DIAGRAM_NAME, GRAPH_EDGE_NAME, GRAPH_NODE_NAME, GRAPH_VIEW_STATE_ATTR, H_ALIGN_ATTR, H_ALIGN_CENTER, H_ALIGN_END, H_ALIGN_LEFT, H_ALIGN_RIGHT, H_ALIGN_START, H_GRID_NAME, HARD_WRAP, HEAD_NAME, HEADER_ATTR, HEADER_INSTRUCTIONS_CHILD, HEADER_NAME, HEADERS_ATTR, HEIGHT_ATTR, HIDE_EVENT, HIDE_SHOW_HEADER_NAME, HIDE_SHOW_NAME, HYPERLINK_BUTTON_ATTR, ICON_ATTR, ICON_BUTTON_FORMAT, ICON_KEY, ICON_KEY_NAME, ICON_NAME, ICON_REQUIRED, ICON_SHORT_DESC_KEY, ID_ATTR, IF_NAME, IMAGE_ATTR, IMAGE_MAP_TYPE_ATTR, IMAGE_MAP_TYPE_NONE, IMAGE_MAP_TYPE_SERVER, IMAGE_NAME, IMAGE_UPLOAD_URI_ATTR, IMPORT_SCRIPT_NAME, IN_CONTEXT_BRANDING_CHILD, IN_CONTEXT_BRANDING_STYLE, INCLUDE_NAME, INCOMPLETE_DATA_SET, INDENTATION_GROUP_ATTR, INITIAL_FOCUS_CONTEXT_PROPERTY, INITIAL_FOCUS_ID_ATTR, INLINE_DATE_PICKER_NAME, INLINE_MESSAGE_NAME, INLINE_NAME, INLINE_STYLE_ATTR, INNER_BOTTOM_CHILD, INNER_END_CHILD, INNER_HEIGHT_ATTR, INNER_LEFT_CHILD, INNER_RIGHT_CHILD, INNER_START_CHILD, INNER_TOP_CHILD, INNER_WIDTH_ATTR, INSERTED_NODE_LIST_NAME, INSTANCE_NAME, INSTRUCTION_STYLE, ITEM_TITLE_ATTR, ITEMS_CHILD, JSP_PARAM, LABEL_CHILD, LABEL_WIDTH_ATTR, LABELED_FIELD_LAYOUT_NAME, LABELED_NODE_ID_ATTR, LANGUAGE_ATTR, LARGE_ADVERTISEMENT_CHILD, LEADING_CHILD, LEADING_DESC_SHOWN_ATTR, LEADING_FOOTER_CHILD, LEADING_HEADER_ATTR, LEFT_CHILD, LINK_NAME, LIST_NAME, LIST_OF_VALUES_NAME, LIST_STYLE_ATTR, LIST_STYLE_CIRCLE, LIST_STYLE_DECIMAL, LIST_STYLE_DISC, LIST_STYLE_LOWER_ALPHA, LIST_STYLE_NONE, LIST_STYLE_SQUARE, LIST_STYLE_UPPER_ALPHA, LOC_PARAM, LOCATION_CHILD, LOCATION_PARAM, LONG_DESC_ATTR, LONG_DESC_URL_ATTR, LOV_BUTTON_NAME, LOV_CHOICE_NAME, LOV_EVENT, LOV_FIELD_NAME, LOV_FILTER_EVENT, LOV_INPUT_NAME, LOV_LIBRARY_NAME, LOV_SEARCH_TEXT, LOV_SELECT_COLUMN_NAME, MAILTO_NAME, MAIN_VIEW_HEIGHT_ATTR, MAIN_VIEW_WIDTH_ATTR, MARLIN_NAMESPACE, MAX_VALUE_ATTR, MAX_VALUE_PARAM, MAX_VALUE_UNKNOWN, MAX_VISITED_ATTR, MAXIMUM_LENGTH_ATTR, MEDIA_NAME, MEDIUM_ADVERTISEMENT_CHILD, MESSAGE_ATTR, MESSAGE_BOX_NAME, MESSAGE_CHECK_BOX_NAME, MESSAGE_CHOICE_NAME, MESSAGE_COLOR_FIELD_NAME, MESSAGE_COMPONENT_LAYOUT_NAME, MESSAGE_DATA_ATTR, MESSAGE_DATA_TEXT_NAME, MESSAGE_DATE_FIELD_NAME, MESSAGE_FILE_UPLOAD_NAME, MESSAGE_FORMAT_NAME, MESSAGE_LAYOUT_NAME, MESSAGE_LIST_NAME, MESSAGE_LOV_CHOICE_NAME, MESSAGE_LOV_FIELD_NAME, MESSAGE_LOV_INPUT_NAME, MESSAGE_PROMPT_NAME, MESSAGE_RADIO_BUTTON_NAME, MESSAGE_RADIO_GROUP_NAME, MESSAGE_RADIO_SET_NAME, MESSAGE_RICH_TEXT_EDITOR_NAME, MESSAGE_STYLED_TEXT_NAME, MESSAGE_TEXT_INPUT_NAME, MESSAGE_TEXT_NAME, MESSAGE_TYPE_ATTR, MESSAGE_TYPE_CONFIRMATION, MESSAGE_TYPE_ERROR, MESSAGE_TYPE_INFO, MESSAGE_TYPE_NONE, MESSAGE_TYPE_PROCESSING, MESSAGE_TYPE_WARNING, MESSAGES_CHILD, META_CONTAINER_CHILD, METHOD_ATTR, METHOD_NAME, MIN_VALUE_ATTR, MIN_VALUE_PARAM, MINIMUM_WIDTH_ATTR, MODEL_ATTR, MONTH_PARAM, MULTIPLE_ATTR, MULTIPLE_SELECTION_NAME, NAME_ATTR, NAME_TRANSFORMED_ATTR, NAME_VALUES_ATTR, NAMED_SOURCE_ATTR, NAMES_ATTR, NAVIGATE_EVENT, NAVIGATION_BAR_NAME, NAVIGATION_EXCLUDE_NAMES_ATTR, NAVIGATION_FORM_NAME_ATTR, NAVIGATOR_HEIGHT_ATTR, NAVIGATOR_WIDTH_ATTR, NEXT_EVENT, NO_BANDING, NODE_ATTR, NODE_PARAM, NODE_STAMP_CHILD, NODES_ATTR, NODES_KEY, NOT_NAME, NULL_NAME, NUMBER_FORMAT, OBJECT_NAME_FORMAT, ON_BLUR_ATTR, ON_BLUR_VALIDATER_ATTR, ON_CHANGE_ATTR, ON_CLICK_ATTR, ON_CLICK_KEY, ON_COLOR_SELECT_ATTR, ON_DEMAND, ON_DOUBLE_CLICK_ATTR, ON_FOCUS_ATTR, ON_KEY_DOWN_ATTR, ON_KEY_PRESS_ATTR, ON_KEY_UP_ATTR, ON_LOAD_ATTR, ON_LOV_INIT_ATTR, ON_LOV_SELECT_ATTR, ON_LOV_VALIDATE_ATTR, ON_MOUSE_DOWN_ATTR, ON_MOUSE_MOVE_ATTR, ON_MOUSE_OUT_ATTR, ON_MOUSE_OVER_ATTR, ON_MOUSE_UP_ATTR, ON_NAVIGATE_ATTR, ON_SELECT_ATTR, ON_SUBMIT_ATTR, ON_SUBMIT_VALIDATER_ATTR, ON_SWITCH_APP_ATTR, ON_UNLOAD_ATTR, OPTION_NAME, OR_NAME, ORIENTATION_ATTR, ORIENTATION_BOTTOM, ORIENTATION_DEFAULT, ORIENTATION_HORIZONTAL, ORIENTATION_TOP, ORIENTATION_VERTICAL, PAGE_BUTTON_BAR_NAME, PAGE_BUTTONS_CHILD, PAGE_HEADER_CHILD, PAGE_HEADER_LAYOUT_NAME, PAGE_LAYOUT_NAME, PAGE_NAME, PAGE_STAMP_STYLE, PAGE_STATUS_CHILD, PALETTE_ID_ATTR, PALETTE_NAME, PARAM_NAME_EXCHANGES_ATTR, PARSE_NAME, PARTIAL_CONTENT_NAME, PARTIAL_KEEP_ALIVE_PROPERTY, PARTIAL_LINK_NAME, PARTIAL_LIST_UNRENDERED_PROPERTY, PARTIAL_NODE_ID_ATTR, PARTIAL_PAGE_CONTEXT_PROPERTY, PARTIAL_PARAM, PARTIAL_RENDER_ENABLED_ATTR, PARTIAL_RENDER_MODE_ATTR, PARTIAL_RENDER_MODE_MULTIPLE, PARTIAL_RENDER_MODE_NONE, PARTIAL_RENDER_MODE_SELF, PARTIAL_ROOT_NAME, PARTIAL_SUBMIT_BUTTON_NAME, PARTIAL_TARGET_IDS_ATTR, PARTIAL_TARGETS_ATTR, PARTIAL_TARGETS_PARAM, PATTERN_ATTR, PATTERN_PARAM, PATTERNS_ATTR, PERCENT_COMPLETE_ATTR, PERCENT_UNKNOWN, PICKER_ID_ATTR, PLAY_COUNT_ATTR, PLAYER_ATTR, PLAYER_LINK, PLAYER_QUICKTIME, PLAYER_REAL, PLAYER_WINDOWS, PORTLET_NAME, POST_TEXT_ATTR, PRE_TEXT_ATTR, PREVIOUS_EVENT, PRIMARY_CLIENT_ACTION_ATTR, PRIVACY_CHILD, PROCESS_STEPS_NAME, PROCESSING_LAYOUT_NAME, PROCESSING_NAME, PRODUCT_BRANDING_CHILD, PRODUCT_BRANDING_NAME, PROMPT_ATTR, PROMPT_CHILD, PROMPT_WIDTH_ATTR, PROVIDER_ATTR, PROXIED_ATTR, PROXY_ATTR, QUICK_LINKS_NAME, QUICK_LINKS_SHOWN_ATTR, QUICK_SEARCH_CHILD, RADIO_BUTTON_NAME, RADIO_GROUP_NAME, RADIO_GROUP_TYPE_CHOICE, RADIO_GROUP_TYPE_RADIO, RADIO_OPTION_NAME, RADIO_SET_NAME, RAW_TEXT_NAME, READ_ONLY_ATTR, REFRESH_EVENT, REG_EXP_NAME, RENDERED_ATTR, RENDERING_MODE_ATTR, REORDERABLE_ATTR, REQUIRED_ATTR, REQUIRED_NO, REQUIRED_UI_ONLY, REQUIRED_VALIDATER_ONLY, REQUIRED_YES, RESET_BUTTON_NAME, RETURN_NAVIGATION_CHILD, RICH_TEXT_EDITOR_NAME, RICH_TEXT_MODE, RICH_TEXT_MODE_DISPLAY_HEIGHT_ATTR, RICH_TEXT_MODE_DISPLAY_LENGTH_ATTR, RICH_TEXT_MODE_EVENT, RIGHT_CHILD, ROOT_ATTRIBUTE_MAP_NAME, ROOT_CHILD_EXISTS_NAME, ROOT_CHILD_LIST_NAME, ROOT_CHILD_MAP_NAME, ROOT_CHILD_NAME, ROOT_PARAM, ROW_BANDING, ROW_FORMATS_ATTR, ROW_HEADER_DATA_ATTR, ROW_HEADER_FORMATS_ATTR, ROW_HEADER_STAMP_CHILD, ROW_LAYOUT_NAME, ROW_SPAN_ATTR, ROWS_ATTR, SAMPLE_NAME, SCRIPT_NAME, SCROLLED_VALUE_ATTR, SCROLLED_VALUE_PARAM, SCROLLING_ATTR, SCROLLING_AUTO, SCROLLING_NO, SCROLLING_YES, SEARCH_AREA_MODE_ATTR, SEARCH_DESC_ATTR, SEARCH_INSTRUCTIONS_CHILD, SEARCH_TEXT_ATTR, SECRET_ATTR, SECRET_FIELD_DEFAULT_VALUE, SELECT_ATTR, SELECT_MODE_KEY, SELECT_OPTION_NAME, SELECTED_ATTR, SELECTED_INDEX_ATTR, SELECTED_KEY, SELECTED_VALUE_ATTR, SELECTION_ATTR, SELECTION_PARAM, SEPARATOR_CHILD, SEPARATOR_NAME, SERVER_VALIDATER_ATTR, SERVLET_INCLUDE_NAME, SET_CONTEXT_PROPERTY_NAME, SHORT_DESC_ATTR, SHORT_TEXT_ATTR, SHOW_ALL_ACTIVE, SHOW_ALL_ATTR, SHOW_ALL_NO, SHOW_ALL_YES, SHOW_EVENT, SHOW_WINDOW_ATTR, SHUTTLE_NAME, SIDE_BAR_NAME, SIDE_NAV_NAME, SINGLE_SELECTION_NAME, SINGLE_STEP, SIZE_ATTR, SIZE_PARAM, SOFT_WRAP, SORT_EVENT, SORT_STATE_ASCENDING, SORT_STATE_DESCENDING, SORTABLE_ASCENDING, SORTABLE_ATTR, SORTABLE_DESCENDING, SORTABLE_HEADER_NAME, SORTABLE_NO, SORTABLE_YES, SOURCE_ATTR, SOURCE_PARAM, SPACER_NAME, STACK_LAYOUT_NAME, STANDBY_TEXT_ATTR, START_CHILD, STATE_CHECK_ATTR, STATE_PARAM, STATE_ROLE, STEPS_COMPLETE_ATTR, STRUCTURAL_ROLE, STYLE_CLASS_ATTR, STYLE_GROUP_ATTR, STYLE_SHEET_NAME, STYLE_USAGE_ATTR, STYLED_ITEM_NAME, STYLED_LIST_NAME, STYLED_TEXT_NAME, SUB_TAB_BAR_NAME, SUB_TAB_LAYOUT_NAME, SUB_TABS_CHILD, SUB_TRAIN_ATTR, SUBMIT_BUTTON_NAME, SUBMIT_PREPARE_ATTR, SUMMARY_ATTR, SWITCH_APP_EVENT, SWITCH_APP_TYPE_BACK, SWITCH_APP_TYPE_GOTO, SWITCH_MODE_HYPERLINK_ATTR, SWITCHER_NAME, TAB_BAR_NAME, TABLE_ACTIONS_CHILD, TABLE_BANDING_KEY, TABLE_DATA_ATTR, TABLE_FILTER_CHILD, TABLE_FOOTER_NAME, TABLE_FORMAT_ATTR, TABLE_LAYOUT_NAME, TABLE_NAME, TABLE_NAME_ATTR, TABLE_SELECTION_CHILD, TABS_CHILD, TARGET_FRAME_ATTR, TARGET_FRAME_KEY, TEMPLATE_DEFINITION_NAME, TEMPLATE_IMPORT_NAME, TEMPLATE_LIBRARY_NAME, TEMPLATES_NAME, TEXT_ATTR, TEXT_FORMAT, TEXT_INPUT_NAME, TEXT_KEY, TEXT_MODE, TEXT_MODE_DISPLAY_HEIGHT_ATTR, TEXT_MODE_DISPLAY_LENGTH_ATTR, TEXT_NAME, THREADED_ATTR, THREADED_LAYOUT_NAME, TIME_INTERVAL_ATTR, TIP_ATTR, TIP_NAME, TITLE_ATTR, TOK_PARAM, TOP_CHILD, TOTAL_CHILD, TOTAL_ROW_NAME, TRAILING_CHILD, TRAILING_DESC_SHOWN_ATTR, TRAILING_FOOTER_CHILD, TRAILING_HEADER_ATTR, TRAIN_NAME, TREE_DATA_ATTR, TREE_NAME, TRUNCATE_AT_ATTR, TRUNCATE_NAME, TRY_NAME, TYPE_ATTR, TYPE_PARAM, TYPE_POST, TYPE_PRE, TYPE_TEXT_ATTR, TZ_OFFSET_PARAM, UNDISCLOSED_TEXT_ATTR, UNKNOWN_ROLE, UNVALIDATED_ATTR, UPDATE_EVENT, URI_PARAM, URL_INCLUDE_NAME, USE_SEPARATE_ROWS_ATTR, USER_INFO_CHILD, USER_INVISIBLE_ROLE, USES_UPLOAD_ATTR, UTF8_LENGTH_NAME, V_ALIGN_ABSMIDDLE, V_ALIGN_ATTR, V_ALIGN_BOTTOM, V_ALIGN_MIDDLE, V_ALIGN_TOP, VALID_ATTR, VALIDATE_BLANKS_ATTR, VALUE_ATTR, VALUE_COLUMNS_ATTR, VALUE_PARAM, VALUE_SHOW_ALL, WIDTH_ATTR, WIDTH_KEY, WML_NAME, WRAP_ATTR, WRAPPING_DISABLED_ATTR, YEAR_PARAM

Constructor Summary

BrowseNodeDataObject(DataObject[] treeRoots, java.lang.String currentLocation)
          Constructs a DataObject with information relevant to a BrowseMenu

BrowseNodeDataObject(DataObject[] treeRoots, java.lang.String currentLocation, java.lang.String destination)
          Constructs a DataObject with information relevant to a BrowseMenu

BrowseNodeDataObject(DataObjectList treeRoots, java.lang.String currentLocation)
          Constructs a DataObject with information relevant to a BrowseMenu

BrowseNodeDataObject(DataObjectList treeRoots, java.lang.String currentLocation, java.lang.String destination)
          Constructs a DataObject with information relevant to a BrowseMenu

BrowseNodeDataObject(DataObject treeRoot, java.lang.String currentLocation)
          Constructs a DataObject with information relevant to a BrowseMenu

BrowseNodeDataObject(DataObject treeRoot, java.lang.String currentLocation, java.lang.String destination)
          Constructs a DataObject with information relevant to a BrowseMenu

Method Summary

java.lang.Object selectValue(RenderingContext context, java.lang.Object select)
          Given a select object, returns the value matching that selection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CATEGORIES_DATA_KEY

public static final java.lang.String CATEGORIES_DATA_KEY

key to pass to selectValue which returns a DataObjectList with the data for the categories child.

ITEMS_DATA_KEY

public static final java.lang.String ITEMS_DATA_KEY

key to pass to selectValue which returns a DataObjectList with the data for the items child.

LOCATION_DATA_KEY

public static final java.lang.String LOCATION_DATA_KEY

key to pass to selectValue which returns a DataObjectList with the data for the location child.

RENDER_ITEMS_KEY

public static final java.lang.String RENDER_ITEMS_KEY

key to pass to selectValue which returns the Boolean value of whether or not to render the items child

RENDER_CATEGORIES_KEY

public static final java.lang.String RENDER_CATEGORIES_KEY

key to pass to selectValue which returns the Boolean value of whether or not to render the categories child

RENDER_CONTENT_LINK_KEY

public static final java.lang.String RENDER_CONTENT_LINK_KEY

key to pass to selectValue which returns the Boolean value of whether or not to render the contentLink child

RENDER_LOCATION_KEY

public static final java.lang.String RENDER_LOCATION_KEY

key to pass to selectValue which returns the Boolean value of whether or not to render the location child

CURRENT_STATE_KEY

public static final java.lang.String CURRENT_STATE_KEY

key to pass to selectValue which returns the String representing the current location state

Constructor Detail