oracle.cabo.ui.beans.table
Class HGridBean

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.table.HGridBean

All Implemented Interfaces:

MutableUINode, UIConstants, UINode

public class HGridBean

extends MarlinBean

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

The HGridBean is used to display objects in a hierarchical format, much like the TreeBean. The HGrid renders like a TableBean; each row coresponds to a tree node. It has two special columns: the focus column and the object hierarchy column. The object hierarchy column identifies the current tree node and allows the user to expand (view the children of) or collapse (hide the children of) this node. The focus column is used to select a new root for the tree. This allows users to zoom into subtrees of a massive tree. The HGrid renders bread crumbs to allow the user to focus out (or zoom out) of the current subtree. The HGrid also renders links to allow the user to quickly expand or collapse all the nodes under the current focus root.

HGrid hierarchy data

The hierarchy data is provided the same way as for the TreeBean. However, the root of the HGrid is a DataObject, as opposed to a DataObjectList. This root is specified by binding the treeData attribute. Incidentally, the HGrid querries each DataObject (that represents a tree node) with the same keys as the TreeBean.

As in the TreeBean, a nodeStamp may be used to render the contents of the object hierarchy column. The column header for this object hierarchy column is defaulted to Name. However, it can be changed by setting a ColumnBean as the nodeStamp and by setting a columnHeader child on that ColumnBean.

To make the HGrid come "alive" a proxy object must be bound to it. Refer to the TreeBean for an explanation of the proxy. On the HGrid the proxy must be of type oracle.cabo.ui.data.tree.HGridDataProxy and is bound using the proxy attribute. See oracle.cabo.ui.data.tree.ClientStateHGridDataProxy for an instance of such a proxy.

HGrid appearance

The appearance of the HGrid is controlled in a similar manner to the TableBean. The column headers are declared using the columnHeaderData attribute and the columnHeaderStamp child. The column values are set as indexed children (the contents) of the HGrid. Various format options may be set using the tableFormat, columnFormats and columnHeaderFormats attributes. Please refer to the TableBean documentation for detailed descriptions of these attributes. Also note that while formatting options for rows are supported on the TableBean they are not supported on the HGrid.

Example:

 <hGrid id="hg1">
  <treeData>
   <nodes text="Root">
    <nodes text="Child 1"/>
    <nodes text="Child 2"/>
   </nodes>
  </treeData>
 </hGrid>

See Also:

TableBean, TreeBean, ClientStateHGridDataProxy, HGridDataProxy

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

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

Method Summary

java.lang.String	getAlternateText() Gets the text to display inside an empty HGrid.
static java.lang.String	getAlternateText(MutableUINode bean) Gets the text to display inside an empty HGrid.
DataObjectList	getColumnFormats() Gets the formatting information for each column.
static DataObjectList	getColumnFormats(MutableUINode bean) Gets the formatting information for each column.
DataObjectList	getColumnHeaderData() Gets The data for the column header.
static DataObjectList	getColumnHeaderData(MutableUINode bean) Gets The data for the column header.
DataObjectList	getColumnHeaderFormats() Gets the formatting information for each column.
static DataObjectList	getColumnHeaderFormats(MutableUINode bean) Gets the formatting information for each column.
UINode	getColumnHeaderStamp() Node to use to render each column header.
static UINode	getColumnHeaderStamp(MutableUINode bean) Node to use to render each column header.
java.lang.String	getDestination() Gets the base destination for all links generated by the hGrid.
static java.lang.String	getDestination(MutableUINode bean) Gets the base destination for all links generated by the hGrid.
UINode	getNodeStamp() UINode to render at each tree node.
static UINode	getNodeStamp(MutableUINode bean) UINode to render at each tree node.
HGridDataProxy	getProxy() Gets A proxy that sits between tree nodes and the expanded state, selection state, focus state and children of those nodes.
static HGridDataProxy	getProxy(MutableUINode bean) Gets A proxy that sits between tree nodes and the expanded state, selection state, focus state and children of those nodes.
java.lang.String	getSummary() Gets The summary of the table's purpose and structure for user agents rendering to non-visual media.
static java.lang.String	getSummary(MutableUINode bean) Gets The summary of the table's purpose and structure for user agents rendering to non-visual media.
DataObject	getTableFormat() Gets formatting information for the entire table.
static DataObject	getTableFormat(MutableUINode bean) Gets formatting information for the entire table.
UINode	getTableSelection() Turns on selection in the Table.
static UINode	getTableSelection(MutableUINode bean) Turns on selection in the Table.
DataObject	getTreeData() Gets The data for the HGrid.
static DataObject	getTreeData(MutableUINode bean) Gets The data for the HGrid.
java.lang.String	getWidth() Gets the width of the HGrid.
static java.lang.String	getWidth(MutableUINode bean) Gets the width of the HGrid.
boolean	isFormSubmitted() Gets whether or not to use form sumission in the links generated by the hGrid's proxy.
static boolean	isFormSubmitted(MutableUINode bean) Gets whether or not to use form sumission in the links generated by the hGrid's proxy.
boolean	isNameTransformed() Gets Deprecated since 2.1.11.
static boolean	isNameTransformed(MutableUINode bean) Gets Deprecated since 2.1.11.
boolean	isProxied() Gets whether or not the HGrid should include Javascript proxy code when rendering on the client.
static boolean	isProxied(MutableUINode bean) Gets whether or not the HGrid should include Javascript proxy code when rendering on the client.
boolean	isUnvalidated() Gets whether or not to validate before any form submits generated by this hGrid's proxy.
static boolean	isUnvalidated(MutableUINode bean) Gets whether or not to validate before any form submits generated by this hGrid's proxy.
static void	setAlternateText(MutableUINode bean, java.lang.String alternateText) Sets the text to display inside an empty HGrid.
void	setAlternateText(java.lang.String alternateText) Sets the text to display inside an empty HGrid.
void	setColumnFormats(DataObjectList columnFormats) Sets the formatting information for each column.
void	setColumnFormats(DataObjectList columnFormats) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setColumnFormats(MutableUINode bean, DataObjectList columnFormats) Sets the formatting information for each column.
static void	setColumnFormats(MutableUINode bean, DataObjectList columnFormats) Deprecated. since 2.0; please use the non-deprecated version of this function.
void	setColumnHeaderData(DataObjectList columnHeaderData) Sets The data for the column header.
void	setColumnHeaderData(DataObjectList columnHeaderData) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setColumnHeaderData(MutableUINode bean, DataObjectList columnHeaderData) Sets The data for the column header.
static void	setColumnHeaderData(MutableUINode bean, DataObjectList columnHeaderData) Deprecated. since 2.0; please use the non-deprecated version of this function.
void	setColumnHeaderFormats(DataObjectList columnHeaderFormats) Sets the formatting information for each column.
void	setColumnHeaderFormats(DataObjectList columnHeaderFormats) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setColumnHeaderFormats(MutableUINode bean, DataObjectList columnHeaderFormats) Sets the formatting information for each column.
static void	setColumnHeaderFormats(MutableUINode bean, DataObjectList columnHeaderFormats) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setColumnHeaderStamp(MutableUINode bean, UINode columnHeaderStampNode) Node to use to render each column header.
void	setColumnHeaderStamp(UINode columnHeaderStampNode) Node to use to render each column header.
static void	setDestination(MutableUINode bean, java.lang.String destination) Sets the base destination for all links generated by the hGrid.
void	setDestination(java.lang.String destination) Sets the base destination for all links generated by the hGrid.
void	setFormSubmitted(boolean formSubmitted) Sets whether or not to use form sumission in the links generated by the hGrid's proxy.
static void	setFormSubmitted(MutableUINode bean, boolean formSubmitted) Sets whether or not to use form sumission in the links generated by the hGrid's proxy.
void	setNameTransformed(boolean nameTransformed) Sets Deprecated since 2.1.11.
static void	setNameTransformed(MutableUINode bean, boolean nameTransformed) Sets Deprecated since 2.1.11.
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.
void	setProxied(boolean proxied) Sets whether or not the HGrid should include Javascript proxy code when rendering on the client.
static void	setProxied(MutableUINode bean, boolean proxied) Sets whether or not the HGrid should include Javascript proxy code when rendering on the client.
void	setProxy(HGridDataProxy proxy) Sets A proxy that sits between tree nodes and the expanded state, selection state, focus state and children of those nodes.
static void	setProxy(MutableUINode bean, HGridDataProxy proxy) Sets A proxy that sits between tree nodes and the expanded state, selection state, focus state and children of those nodes.
static void	setSummary(MutableUINode bean, java.lang.String summary) Sets The summary of the table's purpose and structure for user agents rendering to non-visual media.
void	setSummary(java.lang.String summary) Sets The summary of the table's purpose and structure for user agents rendering to non-visual media.
void	setTableFormat(DataObject tableFormat) Sets formatting information for the entire table.
void	setTableFormat(DataObject tableFormat) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setTableFormat(MutableUINode bean, DataObject tableFormat) Sets formatting information for the entire table.
static void	setTableFormat(MutableUINode bean, DataObject tableFormat) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setTableSelection(MutableUINode bean, UINode tableSelectionNode) Turns on selection in the Table.
void	setTableSelection(UINode tableSelectionNode) Turns on selection in the Table.
static void	setTranslatableAlternateText(MutableUINode bean, java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the text to display inside an empty HGrid.
void	setTranslatableAlternateText(java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the text to display inside an empty HGrid.
static void	setTranslatableSummary(MutableUINode bean, java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the The summary of the table's purpose and structure for user agents rendering to non-visual media.
void	setTranslatableSummary(java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the The summary of the table's purpose and structure for user agents rendering to non-visual media.
void	setTreeData(DataObject treeData) Sets The data for the HGrid.
void	setTreeData(DataObject treeData) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setTreeData(MutableUINode bean, DataObject treeData) Sets The data for the HGrid.
static void	setTreeData(MutableUINode bean, DataObject treeData) Deprecated. since 2.0; please use the non-deprecated version of this function.
void	setUnvalidated(boolean unvalidated) Sets whether or not to validate before any form submits generated by this hGrid's proxy.
static void	setUnvalidated(MutableUINode bean, boolean unvalidated) Sets whether or not to validate before any form submits generated by this hGrid's proxy.
static void	setWidth(MutableUINode bean, java.lang.String width) Sets the width of the HGrid.
void	setWidth(java.lang.String width) Sets the width of the HGrid.

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

HGridBean

public HGridBean()

Construct an instance of the HGridBean.

HGridBean

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

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

Method Detail

getColumnHeaderStamp

public final UINode getColumnHeaderStamp()

Node to use to render each column header.

setColumnHeaderStamp

public final void setColumnHeaderStamp(UINode columnHeaderStampNode)

Node to use to render each column header.

getTableSelection

public final UINode getTableSelection()

Turns on selection in the Table.

setTableSelection

public final void setTableSelection(UINode tableSelectionNode)

Turns on selection in the Table.

getNodeStamp

public final UINode getNodeStamp()

UINode to render at each tree node. This can also be used to set the object hierarchy column header.

setNodeStamp

public final void setNodeStamp(UINode nodeStampNode)

UINode to render at each tree node. This can also be used to set the object hierarchy column header.

getTableFormat

public final DataObject getTableFormat()

Gets formatting information for the entire table.

setTableFormat

public final void setTableFormat(DataObject tableFormat)

Sets formatting information for the entire table.

setTableFormat

public final void setTableFormat(DataObject tableFormat)

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

Sets formatting information for the entire table.

getColumnFormats

public final DataObjectList getColumnFormats()

Gets the formatting information for each column.

setColumnFormats

public final void setColumnFormats(DataObjectList columnFormats)

Sets the formatting information for each column.

setColumnFormats

public final void setColumnFormats(DataObjectList columnFormats)

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

Sets the formatting information for each column.

getColumnHeaderFormats

public final DataObjectList getColumnHeaderFormats()

Gets the formatting information for each column.

setColumnHeaderFormats

public final void setColumnHeaderFormats(DataObjectList columnHeaderFormats)

Sets the formatting information for each column.

setColumnHeaderFormats

public final void setColumnHeaderFormats(DataObjectList columnHeaderFormats)

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

Sets the formatting information for each column.

getProxy

public final HGridDataProxy getProxy()

Gets A proxy that sits between tree nodes and the expanded state, selection state, focus state and children of those nodes.

setProxy

public final void setProxy(HGridDataProxy proxy)

Sets A proxy that sits between tree nodes and the expanded state, selection state, focus state and children of those nodes.

getTreeData

public final DataObject getTreeData()

Gets The data for the HGrid.

setTreeData

public final void setTreeData(DataObject treeData)

Sets The data for the HGrid.

setTreeData

public final void setTreeData(DataObject treeData)

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

Sets The data for the HGrid.

getColumnHeaderData

public final DataObjectList getColumnHeaderData()

Gets The data for the column header.

setColumnHeaderData

public final void setColumnHeaderData(DataObjectList columnHeaderData)

Sets The data for the column header.

setColumnHeaderData

public final void setColumnHeaderData(DataObjectList columnHeaderData)

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

Sets The data for the column header.

getWidth

public final java.lang.String getWidth()

Gets the width of the HGrid.

setWidth

public final void setWidth(java.lang.String width)

Sets the width of the HGrid.

getAlternateText

public final java.lang.String getAlternateText()

Gets the text to display inside an empty HGrid.

setAlternateText

public final void setAlternateText(java.lang.String alternateText)

Sets the text to display inside an empty HGrid.

setTranslatableAlternateText

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

Binds to a ResourceBundle the the text to display inside an empty HGrid.

Parameters:

bundleName - the name of the ResourceBundle

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

getSummary

public final java.lang.String getSummary()

Gets The summary of the table's purpose and structure for user agents rendering to non-visual media. If this attribute is not provided, the value of the text attribute will be used.

setSummary

public final void setSummary(java.lang.String summary)

Sets The summary of the table's purpose and structure for user agents rendering to non-visual media. If this attribute is not provided, the value of the text attribute will be used.

setTranslatableSummary

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

Binds to a ResourceBundle the The summary of the table's purpose and structure for user agents rendering to non-visual media. If this attribute is not provided, the value of the text attribute will be used.

Parameters:

bundleName - the name of the ResourceBundle

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

getDestination

public final java.lang.String getDestination()

Gets the base destination for all links generated by the hGrid.

setDestination

public final void setDestination(java.lang.String destination)

Sets the base destination for all links generated by the hGrid.

isFormSubmitted

public final boolean isFormSubmitted()

Gets whether or not to use form sumission in the links generated by the hGrid's proxy.

setFormSubmitted

public final void setFormSubmitted(boolean formSubmitted)

Sets whether or not to use form sumission in the links generated by the hGrid's proxy.

isUnvalidated

public final boolean isUnvalidated()

Gets whether or not to validate before any form submits generated by this hGrid's proxy. The default is to perform no validation. This attribute is only applicable when the hGrid is used in formSubmitted mode.

setUnvalidated

public final void setUnvalidated(boolean unvalidated)

Sets whether or not to validate before any form submits generated by this hGrid's proxy. The default is to perform no validation. This attribute is only applicable when the hGrid is used in formSubmitted mode.

isProxied

public final boolean isProxied()

Gets whether or not the HGrid should include Javascript proxy code when rendering on the client.

setProxied

public final void setProxied(boolean proxied)

Sets whether or not the HGrid should include Javascript proxy code when rendering on the client.

isNameTransformed

public final boolean isNameTransformed()

Gets Deprecated since 2.1.11. Use the 'nameTransformed' attribute of the column bean instead. A boolean value indicating whether or not TableBean should provide any name transformation when rendering data controls. By default, the names are transformed.

setNameTransformed

public final void setNameTransformed(boolean nameTransformed)

Sets Deprecated since 2.1.11. Use the 'nameTransformed' attribute of the column bean instead. A boolean value indicating whether or not TableBean should provide any name transformation when rendering data controls. By default, the names are transformed.

getColumnHeaderStamp

public static UINode getColumnHeaderStamp(MutableUINode bean)

Node to use to render each column header.

setColumnHeaderStamp

public static void setColumnHeaderStamp(MutableUINode bean,
                                        UINode columnHeaderStampNode)

Node to use to render each column header.

getTableSelection

public static UINode getTableSelection(MutableUINode bean)

Turns on selection in the Table.

setTableSelection

public static void setTableSelection(MutableUINode bean,
                                     UINode tableSelectionNode)

Turns on selection in the Table.

getNodeStamp

public static UINode getNodeStamp(MutableUINode bean)

UINode to render at each tree node. This can also be used to set the object hierarchy column header.

setNodeStamp

public static void setNodeStamp(MutableUINode bean,
                                UINode nodeStampNode)

UINode to render at each tree node. This can also be used to set the object hierarchy column header.

getTableFormat

public static DataObject getTableFormat(MutableUINode bean)

Gets formatting information for the entire table.

setTableFormat

public static void setTableFormat(MutableUINode bean,
                                  DataObject tableFormat)

Sets formatting information for the entire table.

setTableFormat

public static void setTableFormat(MutableUINode bean,
                                  DataObject tableFormat)

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

Sets formatting information for the entire table.

getColumnFormats

public static DataObjectList getColumnFormats(MutableUINode bean)

Gets the formatting information for each column.

setColumnFormats

public static void setColumnFormats(MutableUINode bean,
                                    DataObjectList columnFormats)

Sets the formatting information for each column.

setColumnFormats

public static void setColumnFormats(MutableUINode bean,
                                    DataObjectList columnFormats)

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

Sets the formatting information for each column.

getColumnHeaderFormats

public static DataObjectList getColumnHeaderFormats(MutableUINode bean)

Gets the formatting information for each column.

setColumnHeaderFormats

public static void setColumnHeaderFormats(MutableUINode bean,
                                          DataObjectList columnHeaderFormats)

Sets the formatting information for each column.

setColumnHeaderFormats

public static void setColumnHeaderFormats(MutableUINode bean,
                                          DataObjectList columnHeaderFormats)

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

Sets the formatting information for each column.

getProxy

public static HGridDataProxy getProxy(MutableUINode bean)

Gets A proxy that sits between tree nodes and the expanded state, selection state, focus state and children of those nodes.

setProxy

public static void setProxy(MutableUINode bean,
                            HGridDataProxy proxy)

Sets A proxy that sits between tree nodes and the expanded state, selection state, focus state and children of those nodes.

getTreeData

public static DataObject getTreeData(MutableUINode bean)

Gets The data for the HGrid.

setTreeData

public static void setTreeData(MutableUINode bean,
                               DataObject treeData)

Sets The data for the HGrid.

setTreeData

public static void setTreeData(MutableUINode bean,
                               DataObject treeData)

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

Sets The data for the HGrid.

getColumnHeaderData

public static DataObjectList getColumnHeaderData(MutableUINode bean)

Gets The data for the column header.

setColumnHeaderData

public static void setColumnHeaderData(MutableUINode bean,
                                       DataObjectList columnHeaderData)

Sets The data for the column header.

setColumnHeaderData

public static void setColumnHeaderData(MutableUINode bean,
                                       DataObjectList columnHeaderData)

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

Sets The data for the column header.

getWidth

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

Gets the width of the HGrid.

setWidth

public static void setWidth(MutableUINode bean,
                            java.lang.String width)

Sets the width of the HGrid.

getAlternateText

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

Gets the text to display inside an empty HGrid.

setAlternateText

public static void setAlternateText(MutableUINode bean,
                                    java.lang.String alternateText)

Sets the text to display inside an empty HGrid.

setTranslatableAlternateText

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

Binds to a ResourceBundle the the text to display inside an empty HGrid.

Parameters:

bundleName - the name of the ResourceBundle

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

getSummary

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

Gets The summary of the table's purpose and structure for user agents rendering to non-visual media. If this attribute is not provided, the value of the text attribute will be used.

setSummary

public static void setSummary(MutableUINode bean,
                              java.lang.String summary)

Sets The summary of the table's purpose and structure for user agents rendering to non-visual media. If this attribute is not provided, the value of the text attribute will be used.

setTranslatableSummary

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

Binds to a ResourceBundle the The summary of the table's purpose and structure for user agents rendering to non-visual media. If this attribute is not provided, the value of the text attribute will be used.

Parameters:

bundleName - the name of the ResourceBundle

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

getDestination

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

Gets the base destination for all links generated by the hGrid.

setDestination

public static void setDestination(MutableUINode bean,
                                  java.lang.String destination)

Sets the base destination for all links generated by the hGrid.

isFormSubmitted

public static boolean isFormSubmitted(MutableUINode bean)

Gets whether or not to use form sumission in the links generated by the hGrid's proxy.

setFormSubmitted

public static void setFormSubmitted(MutableUINode bean,
                                    boolean formSubmitted)

Sets whether or not to use form sumission in the links generated by the hGrid's proxy.

isUnvalidated

public static boolean isUnvalidated(MutableUINode bean)

Gets whether or not to validate before any form submits generated by this hGrid's proxy. The default is to perform no validation. This attribute is only applicable when the hGrid is used in formSubmitted mode.

setUnvalidated

public static void setUnvalidated(MutableUINode bean,
                                  boolean unvalidated)

Sets whether or not to validate before any form submits generated by this hGrid's proxy. The default is to perform no validation. This attribute is only applicable when the hGrid is used in formSubmitted mode.

isProxied

public static boolean isProxied(MutableUINode bean)

Gets whether or not the HGrid should include Javascript proxy code when rendering on the client.

setProxied

public static void setProxied(MutableUINode bean,
                              boolean proxied)

Sets whether or not the HGrid should include Javascript proxy code when rendering on the client.

isNameTransformed

public static boolean isNameTransformed(MutableUINode bean)

Gets Deprecated since 2.1.11. Use the 'nameTransformed' attribute of the column bean instead. A boolean value indicating whether or not TableBean should provide any name transformation when rendering data controls. By default, the names are transformed.

setNameTransformed

public static void setNameTransformed(MutableUINode bean,
                                      boolean nameTransformed)

Sets Deprecated since 2.1.11. Use the 'nameTransformed' attribute of the column bean instead. A boolean value indicating whether or not TableBean should provide any name transformation when rendering data controls. By default, the names are transformed.