oracle.cabo.ui.beans.nav
Class TreeBean

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

All Implemented Interfaces:

MutableUINode, UIConstants, UINode

public class TreeBean

extends MarlinBean

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

The TreeBean is used to display objects in a hierarchical format. It factors data into child/leaf nodes and parent nodes which are either expanded or collapsed. The purpose of the tree control is to allow users to quickly browse through complex sets of hierarchical objects and access detailed information for a record by highlighting it in the tree. The visual representation of the hierarchy using the tree is also intended to show the relationship between a set of objects with respect to one another.

The TreeBean is rendered statically on the client. However, not all of the data needs to be static. We provide a means of combining static data that is shared among all users along with client state which is determined at render time. Per render data on a TreeBean can be set through use of an object which implements the TreeDataProxy interface, which can be set as an attribute on the TreeBean. One useful implementation of the TreeDataProxy that we provide is ClientStateTreeProxy. It will manage the expand/collapse state of nodes, and optionally the selection on the tree both on the client and over the server, on a per render basis.

Tree hierarchy data

The TreeBean supports three attributes and one named child: ID, nodes, and proxy. A tree's ID is used to for the purposes of identifying the tree during events through the server. The proxy attribute is optional and provides an alternate method for obtaining some properties of the individual nodes. The nodes attribute should return a DataObjectList containing the root nodes of the tree. This first DataObjectList indicates all of the "root", or top level nodes. The number of root nodes is determined by the result of the getLength() call on this root DataObjectList, and every DataObject returned from a call to getItem(int index) returns one of the root DataObjects. Users may specify anodeStamp named child for the tree. The nodeStamp is a UINode which is rendered at each node of the tree using the appropriate node data. If no node stamp is specified, then a default stamp of an icon and link will be used.

To determine the children of each of these root node DataObjects, the value of the nodes attribute is obtained in turn from each of them. This value is either null, to indicate that the node has no children, or another DataObjectList representing the node's children. Each of these new DataObjectLists is also queried with the nodes attribute, and the process continues to completion to build the entire tree structure for a rendering of the tree.

Tree node appearance

Recall that each DataObject represents a displayed node in the tree. The actual appearance of a given node is determined by its properties, obtained by a series of queries against it through a proxy. The node properties are as follows:

• The text displayed for that node should be stored as a String with the UIConstant TEXT_KEY.
• The icon displayed for that node should be stored as a String URI pointing to an image file -- 16 pixels wide and 22 pixels high -- with the UIConstant ICON_KEY. If nothing is stored, then no icon is rendered for leaf nodes, and a default folder icon is rendered for nodes with children.
• For nodes which should be drawn as selected, the Boolean.TRUE value should be stored with the UIConstant SELECTED_KEY.
• The link destination for that node should be stored as a String URI with the UIConstant DESTINATION_KEY.
• Nodes are queried with the EXPANDABLE_KEY to determine if they are expanded or collapsed, or childless. Nodes containing the UIConstant EXPANDABLE_EXPANDED are rendered as "open", along with their children. Nodes containing EXPANDABLE_COLLAPSED are rendered as having children which are currently hidden. Nodes returning EXPANDABLE_NO or null are rendered as leaves.
• Nodes marked as EXPANDABLE_EXPANDED by the EXPANDABLE_KEY query are then queried with the COLLAPSE_DESTINATION_KEY, which should return a String URI serving as a link destination to collapse the expanded node.
• Nodes marked as EXPANDABLE_COLLAPSED by the EXPANDABLE_KEY query are then queried with the EXPAND_DESTINATION_KEY, which should return a String URI serving as a link destination to expand the collapsed node.

Example:

A tree with a databound proxy attribute.

 <ctrl:content xmlns:ui="http://xmlns.oracle.com/uix/ui">
 
   <dataScope xmlns="http://xmlns.oracle.com/uix/ui">
     <contents>
       <tree name="tree1" data:proxy="proxy@TreeProxy">
         <nodes>
           <nodes text="Root1" expandable="collapsed"/>
           <nodes text="Root2" expandable="collapsed"/>
           <nodes text="Root3" expandable="expanded">
             <nodes text="Node3-1"/>
             <nodes text="Node3-2" expandable="expanded">
               <nodes text="Node3-2-1" selected="false" />
               <nodes text="Node3-2-2" selected="true" expandable="no"/>
               <nodes text="Node3-2-3" expandable="no"/>
             </nodes>
             <nodes text="Node3-3" expandable="no"/>
           </nodes>
           <nodes text="Root4" expandable="collapsed"/>
         </nodes>
       </tree>
 
     </contents>
 
     <provider>
       <data name="TreeProxy">
         <method class="oracle.cabo.doc.demo.DataTrees"
                 method="getTreeProxy"/>
       </data>
     </provider>
   </dataScope>
 </ctrl:content>
 
 <ctrl:handlers xmlns="http://xmlns.oracle.com/uix/controller">
 
   <event name="expand">
     <method class="oracle.cabo.doc.demo.DataTrees"
       method="expandEventHandler"/>
   </event>
 
 </ctrl:handlers>

See Also:

UIConstants, TreeDataProxy

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

	TreeBean() Construct an instance of the TreeBean.
protected	TreeBean(boolean ignored, java.lang.String localName) Construct an instance of the TreeBean.
	TreeBean(java.lang.String id) Construct an instance of the TreeBean.

Method Summary

java.lang.String	getFormName() Gets The form name to submit to
static java.lang.String	getFormName(MutableUINode bean) Gets The form name to submit to
DataObjectList	getNodes() Gets the hierarchy of tree data.
static DataObjectList	getNodes(MutableUINode bean) Gets the hierarchy of tree data.
UINode	getNodeStamp() UINode to render at each tree node.
static UINode	getNodeStamp(MutableUINode bean) UINode to render at each tree node.
TreeDataProxy	getProxy() Gets a proxy that sits between tree nodes and the expanded state, selection state, and children of that node
static TreeDataProxy	getProxy(MutableUINode bean) Gets a proxy that sits between tree nodes and the expanded state, selection state, and children of that node
boolean	isFormSubmitted() Gets whether or not to use form submission in the expand/collapse links
static boolean	isFormSubmitted(MutableUINode bean) Gets whether or not to use form submission in the expand/collapse links
boolean	isUnvalidated() Gets If this element is used in formSubmitted mode, then the default behaviour is to not 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 not validate all form inputs, before submitting to the server.
static void	setFormName(MutableUINode bean, java.lang.String formName) Sets The form name to submit to
void	setFormName(java.lang.String formName) Sets The form name to submit to
void	setFormSubmitted(boolean formSubmitted) Sets whether or not to use form submission in the expand/collapse links
static void	setFormSubmitted(MutableUINode bean, boolean formSubmitted) Sets whether or not to use form submission in the expand/collapse links
void	setNodes(DataObjectList nodes) Sets the hierarchy of tree data.
void	setNodes(DataObjectList nodes) Deprecated. since 2.0; please use the non-deprecated version of this function.
void	setNodes(DataSet nodes) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setNodes(MutableUINode bean, DataObjectList nodes) Sets the hierarchy of tree data.
static void	setNodes(MutableUINode bean, DataObjectList nodes) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setNodeStamp(MutableUINode bean, UINode nodeStampNode) UINode to render at each tree node.
void	setNodeStamp(UINode nodeStampNode) UINode to render at each tree node.
static void	setProxy(MutableUINode bean, TreeDataProxy proxy) Sets a proxy that sits between tree nodes and the expanded state, selection state, and children of that node
void	setProxy(TreeDataProxy proxy) Sets a proxy that sits between tree nodes and the expanded state, selection state, and children of that node
void	setUnvalidated(boolean unvalidated) Sets If this element is used in formSubmitted mode, then the default behaviour is to not 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 not 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

TreeBean

public TreeBean()

Construct an instance of the TreeBean.

TreeBean

public TreeBean(java.lang.String id)

Construct an instance of the TreeBean.

Parameters:

id - the page-wide unique client ID of this node.

TreeBean

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

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

Method Detail

setNodes

public final void setNodes(DataSet nodes)

Deprecated. since 2.0; please use the non-deprecated version of this function.

Sets the hierarchy of tree data.

getNodeStamp

public final UINode getNodeStamp()

UINode to render at each tree node.

setNodeStamp

public final void setNodeStamp(UINode nodeStampNode)

UINode to render at each tree node.

getNodes

public final DataObjectList getNodes()

Gets the hierarchy of tree data.

setNodes

public final void setNodes(DataObjectList nodes)

Sets the hierarchy of tree data.

setNodes

public final void setNodes(DataObjectList nodes)

Deprecated. since 2.0; please use the non-deprecated version of this function.

Sets the hierarchy of tree data.

getProxy

public final TreeDataProxy getProxy()

Gets a proxy that sits between tree nodes and the expanded state, selection state, and children of that node

setProxy

public final void setProxy(TreeDataProxy proxy)

Sets a proxy that sits between tree nodes and the expanded state, selection state, and children of that node

isFormSubmitted

public final boolean isFormSubmitted()

Gets whether or not to use form submission in the expand/collapse links

setFormSubmitted

public final void setFormSubmitted(boolean formSubmitted)

Sets whether or not to use form submission in the expand/collapse links

isUnvalidated

public final boolean isUnvalidated()

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

setUnvalidated

public final void setUnvalidated(boolean unvalidated)

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

getFormName

public final java.lang.String getFormName()

Gets The form name to submit to

setFormName

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

Sets The form name to submit to

getNodeStamp

public static UINode getNodeStamp(MutableUINode bean)

UINode to render at each tree node.

setNodeStamp

public static void setNodeStamp(MutableUINode bean,
                                UINode nodeStampNode)

UINode to render at each tree node.

getNodes

public static DataObjectList getNodes(MutableUINode bean)

Gets the hierarchy of tree data.

setNodes

public static void setNodes(MutableUINode bean,
                            DataObjectList nodes)

Sets the hierarchy of tree data.

setNodes

public static void setNodes(MutableUINode bean,
                            DataObjectList nodes)

Deprecated. since 2.0; please use the non-deprecated version of this function.

Sets the hierarchy of tree data.

getProxy

public static TreeDataProxy getProxy(MutableUINode bean)

Gets a proxy that sits between tree nodes and the expanded state, selection state, and children of that node

setProxy

public static void setProxy(MutableUINode bean,
                            TreeDataProxy proxy)

Sets a proxy that sits between tree nodes and the expanded state, selection state, and children of that node

isFormSubmitted

public static boolean isFormSubmitted(MutableUINode bean)

Gets whether or not to use form submission in the expand/collapse links

setFormSubmitted

public static void setFormSubmitted(MutableUINode bean,
                                    boolean formSubmitted)

Sets whether or not to use form submission in the expand/collapse links

isUnvalidated

public static boolean isUnvalidated(MutableUINode bean)

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

setUnvalidated

public static void setUnvalidated(MutableUINode bean,
                                  boolean unvalidated)

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

getFormName

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

Gets The form name to submit to

setFormName

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

Sets The form name to submit to