oracle.cabo.ui.beans.table
Class TableBean

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

All Implemented Interfaces:

MutableUINode, UIConstants, UINode

Direct Known Subclasses:

TableBean

public class TableBean

extends MarlinBean

The TableBean supports the editing and display of tabular data, as well as special formatting that accompanies that data.

Table data and its rendering

The number of rows in the data area of the table is specifed by the DataObjectList which is set as the tableData property. The size of that DataObjectList maps to the number of data rows, with each DataObject in the DataObjectList corresponding to the data for that row.

The rendering of the data in each cell is performed by the indexed children of the TableBean. Each indexed child is the equivalent of a column in the table, because columns generally display a common type of data, and clients should add an indexed child to the table for every column they wish the table to visibly display. When the table data cells are rendered, the DataObject representing a table row is passed to each indexed child, in turn, for rendering. This is accomplished by making the row DataObject the "current" DataObject on the RenderingContext. Then, each indexed child acts as "stamp" which renders itself repeatedly in every row for that column.

The indexed child selects data from the row DataObject using a select key whose result it knows how to display. For example, a TextInputBean that is added as an indexed child of a table will ask a row DataObject for whatever value it is bound to and render that as a text field. An ImageBean would query the row DataObject for the source of an image and render its data as an image tag.

It is the responsibility of clients to make sure that the table data DataObjectList returns DataObjects that the indexed children can query and use.

In some rare cases, such as where radiobuttons need to be rendered in a group across rows, clients may need to turn off the name transformation of rendered data form controls. Setting the nameTransformed property to "false" will prevent the table from transforming the names of the rendered data cells in any way throughout the table.

Storing data on the client

Sometimes a client will want to store data on a table that is not visible to the user, but is still returned as part of the form submission for that table. This can be useful in keeping state with the client rather than forcing a server to maintain that state in memory.

To support this globally, UIX Components provides a FormValueBean which will insert a hidden field in a rendered page. That hidden value is then returned to the server in a form submission. The TableBean additionally supports adding one or more FormValueBeans as children of the table. The FormValueBean queries the table DataObjectList for the data to insert into its column just as every other table column does. However, a FormValueBean in a TableBean does not render any visible table cells. This allows per-row data to be stored on a client and returned to a server without affecting the page display.

It is recommended that clients make the FormValueBeans the last indexed children in a TableBean. This is due to the fact that column header DataObjectList must supply DataObjects for any column headers up through the final visible data column.

Note that this technique should be used sparingly, as the cost of transmitting the data to the client and back to the server is still incurred, even if that data isn't directly visible.

Retrieving submitted table data

To support tables which contain editable data columns such as TextInputBeans, the CaboShare project contains the utility class ServletRequestDataSet. An instance of this class can be constructed on the server with a ServletRequest and the name of the TableBean. The utility class will then parse the ServletRequest and recreate a DataSet implementation so that the resulting values from a form submission can be easily extracted from a TableBean.

The constructed DataSet will return a DataObject for each row in the TableBean, and the row DataObjects can be queried using selectValue() with the name of a column rendering UINode in order to return the submitted form value for that row and column. Note that only form data from the client is stored in a ServletRequestDataSet, and that the indices into the ServletRequestDataSet are always zero-based. See the ServletRequestDataSet documentation for more details.

Note also that UIX Controller clients can bypass the ServletRequestDataSet altogether and call selectValue() directly on a PageEvent to get the form data submitted by a TableBean.

Column and row headers

Column and row headers work similar to the rendering of table data, except that the renderers are explicitly set on the table as named children rather than added as indexed children. Here, as with the table data, UINodes function as "stamps".

The node specified as the columnHeaderStamp will be used to "stamp" the column header cells, and the node specified as the rowHeaderStamp will be used to "stamp" the row header cells. The data used by the column and row headers is set using the columnHeaderData and rowHeaderData DataObjectList properties. The row header DataObjectList must supply a DataObject for each row in the table, and the column header DataObjectList must supply a DataObject for each column in the table.

Note that both the row header and column header are optional and independent of each other and the table data.

Selectable table rows

A common function of tables is to allow users to select one or more rows and perform an action on those rows. To facilitate this, UIX Components provides the SingleSelectionBean and MultipleSelectionBean, either of which can be added to a table using its tableSelection property. These beans perform three useful tasks:

1. They render a column in the table for selecting rows.
2. The render a "control bar" around the table with actions to take on the selected rows.
3. They work with the ServletRequestDataSet to allow easy retrieval of the client's selection upon form submission.

Consult the SingleSelectionBean and MultipleSelectionBean for more documentation on adding a selection to a TableBean.

Hide/Show in a Table Row

Some table designs call for the ability to hide or show additional detail for individual rows in a table. This can be achieved by adding a special named child to the table -- the detail child. Any table with such a named child will automatically render an additional column with the heading "Details" and a hide/show component in each cell.

Clicking on the hide/show component will produce an URL with three parameters: event (which is set to either 'hide' or 'show'), source (which is the table name) and value (which is the table row that the component is on).

The disclosed state -- hidden or disclosed -- of each cell in the detail column is determined by a new DataObjectList attribute on the table, the detailDisclosure. This DataObjectList should contain one DataObject for each row in the table, each of which will be queried with the UIConstant DISCLOSED_KEY when that row is rendered. If this DataObject returns Boolean.TRUE from the query, the row will be rendered as disclosed and the contents of the detail child will be stamped in a special row under the normal data row. If Boolean.TRUE is not returned, nothing additional will render under that table row.

When the detail child is rendered underneath any disclosed table row, the current data object will be the data object for that table row. Thus, the contents of the detail child can get their bound values from that table row data object by binding to the current object.

Setting UIConstants.ALL_DETAILS_ENABLED_ATTR to true will add links "Show All Details" and "Hide All Details" above the table rows. Clicking on these links will produce three parameters: event is 'hide' or 'show', source is the table name, and value is UIConstants.VALUE_SHOW_ALL

Table footers

There are two beans available which serve as TableBean "footers", which are rendered below the content area. The AddTableRowBean and TotalRowBean provide ways for users to add rows and see total data, respectively, and can be set as the columnFootert named child. See their documentation for more details.

JavaScript proxies

In some cases, developers will need to use JavaScript to update or retrieve values in TableBeans while they are running on the client. When the proxied property is set to "true", a set of Javascript utility methods will be rendered that allow clients to get access to Form elements based on their columns and rows locations. Additional methods allow access to other table properties such as the number or rows and the currently selected indices.

The methods can be accessed by creating a TableProxy instance based on the table name. For example:

               // create the proxy object
               var proxy = new TableProxy("testTable");
 
               // get the number of rows currently displayed
               var length = proxy.getLength();
 
               // get the selected index of a single-selection table
               var selectedIndex = proxy.getSelectedRow();
 
               // display the value of the text field in row 2, column "lastName"
               var row2Field = proxy.getFormElement("lastName", 2);
               alert("The value of the lastName in row 2 is " + row2Field.value);
             

For more information and examples, see the oracle.cabo.ui.test.TableTest class and the TableProxy.js JavaScript library file.

Formatting the table

The appearance of the table can be adjusted using five formatting objects: the tableFormat, the columnFormats, the rowFormats, and the columnHeaderFormats and rowHeaderFormats.

The table format DataObject is queried for format information applicable across the entire table rendering. Currently, the table format DataObject is queried for the type of banding (i.e. alternating colors) to render in the table data, using the UIConstant TABLE_BANDING_KEY.

If the format DataObject returns the UIConstant ROW_BANDING, the table data rows alternate colors. If it returns COLUMN_BANDING, the table columns alternate colors. Otherwise, no banding is rendered (the default). If the format does indicate that banding is desired, the table format DataObject will also be queried with the BANDING_INTERVAL_KEY. If this key returns an Integer greater than 1, that interval will be used as the number of rows or columns to group in a band. For instance, if a row-banded table returns "2" as the banding interval, the table will alternate two dark rows with two light rows over the course of the render.

The column format DataObjectList must return a DataObject for each column to specify the formatting of that column. Currently, each column format DataObject is queried for the type of data it displays using the COLUMN_DATA_FORMAT_KEY. This information is used to align the contents of the cells by type.

If a format DataObject returns TEXT_FORMAT (the default), the text is aligned to the left. If a format DataObject returns NUMBER_FORMAT, the text is aligned to the right, and if it returns ICON_BUTTON_FORMAT it will be center aligned, as specified by Oracle UI standards.

Column format DataObjects are also queried to determine if a cell should be rendered with line wrapping disabled. When queried with the CELL_NO_WRAP_FORMAT_KEY, if the format object returns Boolean.TRUE, the cells in that column will be rendered without wrapping the contents.

The column format DataObjects are also queried with the DISPLAY_GRID_KEY. For each DataObject returning Boolean.TRUE to this query, a vertical grid line will be rendered before that column's content (to the left in a left-to-right locale). DataObjects which return Boolean.FALSE for that query will not have grid lines rendered. The default is to render a grid line for every column.

Column formats can also control their widths by returning a string representing their preferred width when queried with the WIDTH_KEY. This width can be in pixels or percentages, and it will be used as a recommended width for the column content. However, if the content is wider than the specified width, it will take more space than requested. If no column formats in the table request a specific width, the space will be divided evenly among the data columns as much as is possible.

One other way that the column format can control the column appearance is to return a value when queried with the BANDING_SHADE_KEY. If any column format returns a value for this key, the table will explicitly band all of the columns according to the values of these keys, giving clients complete control over column banding patterns. The allowable results for this query are BANDING_SHADE_LIGHT for a light shaded column or BANDING_SHADE_DARK (the default) or normal or dark shaded columns. Note that using any explicit column bands overrides the use of banding specified by the table format DataObject.

The row format DataObjectList also must supply a DataObject, but for each row in the table. Each of these DataObjects is queried with the DISPLAY_GRID_KEY, and each one that does not return Boolean.FALSE from this query will have a grid line rendered above that row. Again, the default is to render a grid line above every row.

The column and row header format DataObjectLists also supply DataObjects, but for each row or column header. When queried with the CELL_NO_WRAP_FORMAT_KEY, if the format object returns Boolean.TRUE, the cells in that column or row header will be rendered without wrapping the contents.

The TableStyle class provides simple utility implementations of DataObjectLists and DataObjects which assist in formatting tables.

Encapsulated columns

In many cases, clients may wish to encapsulate all the information describing a column into a single entity, rather than spreading it out across the indexed child (column stamp), header stamp, header format, header data, and column format objects set globally on the table. To support this, there is now a ColumnBean which can be added as the indexed child of a table where you would normally place the UINode "stamp" for that column. The ColumnBean will not render anything itself; however, its own indexed children will be stamped down each cell of that table column

The ColumnBean also allows you to set its own columnFormat, column header format, column header data, and column header stamp. If specified, these will override the values for formats and stamps attributed to the TableBean itself. If they are not specified, the TableBean's own formats and stamps will be used, as before.

You can use ColumnBeans for any, all, or none of the columns in the TableBean. You can also set the rendered flag on a ColumnBean to hide it from view for a given render.

Navigation Bars

Tables which show a subset of a larger set of data should render navigation bars at the top (and sometimes at the bottom) of the table. The TableBean automatically creates and renders these navigation bars if it is supplied with the appropriate properties:

• minValue: the first possible value in the range of data displayed by the table. It defaults to 1.
• maxValue: the last possible value in the range of data displayed by the table. It defaults to MAX_VALUE_UNKNOWN.
• value: The first index currently displayed in the table.
• blockSize: the number of rows displayed in a normal subset of the table data. Usually this is the same as the number of rows displayed by the table. However, in edge cases they will differ. For example, a table with maxValue of 103 displaying 10 rows at a time, will only display 3 rows and still have a block size of 10, when it displays rows 101-103.

Note: prior to UIX version 2.1.4, in order for the navigation bars to render, any of the above four attributes must be set on the table. That behaviour has been DEPRECATED. Since 2.1.4 the blockSize and value attributes must be provided, if the navigation bar is to render.

These properties, along with the table name, are passed to the navigation bars for rendering. By default, the links generated by the navigation bar are URLs based on the destination property of the TableBean and the current view on the navigation set. But the navigation bar will instead generate form submission links if the formSubmitted property is set on the table. For more information on the use of these properties and the links they render, refer to the documentation for the NavigationBarBean.

For tables displaying a large number of data rows on a single page, the navigation bar should be repeated at the bottom of the table display. The table renderer will do this by default if the number of rows exceeds the threshold set by the Oracle UI team.

Other formatting

The table can also render a title above the data and navigation area. This title can be specified by setting the text property on the table.

An alternateText property can be used to specify text to be displayed inside the table when no data has been supplied or there are no rows in the table data.

Example:

 <table>
  <columnHeaderData>
   <col text="Name"/>
   <col text="Age"/>
  </columnHeaderData>
  <columnHeaderStamp>
   <text data:text="text"/>
  </columnHeaderStamp>
  <tableData>
   <row name="Person 1" age="12"/>
   <row name="Person 2" age="13"/>
   <row name="Person 3" age="14"/>
  </tableData>
  <contents>
   <text data:text="name"/>
   <text data:text="age"/>
  </contents>
 </table>

See Also:

AddTableRowBean, MultipleSelectionBean, SingleSelectionBean, TableStyle, TotalRowBean, ColumnBean, NavigationBarBean, FormValueBean, PagedDataObjectList, ReorderingUINodeList

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

	TableBean() Construct an instance of the TableBean.
protected	TableBean(boolean ignored, java.lang.String localName) Construct an instance of the TableBean.
	TableBean(java.lang.String name, DataObjectList tableData) Construct an instance of the TableBean.
	TableBean(java.lang.String name, DataObjectList tableData) Deprecated. since 2.0.
	TableBean(java.lang.String name, DataObjectList tableData, UINode rowHeaderStampNode, DataObjectList rowHeaderData, UINode columnHeaderStampNode, DataObjectList columnHeaderData) Construct an instance of the TableBean.
	TableBean(java.lang.String name, DataObjectList tableData, UINode rowHeaderStampNode, DataObjectList rowHeaderData, UINode columnHeaderStampNode, DataObjectList columnHeaderData) Deprecated. since 2.0.

Method Summary

java.lang.String	getAlternateText() Gets the text to display inside an empty table.
static java.lang.String	getAlternateText(MutableUINode bean) Gets the text to display inside an empty table.
int	getBlockSize() Gets the standard number of rows in displayed in the table.
static int	getBlockSize(MutableUINode bean) Gets the standard number of rows in displayed in the table.
UINode	getColumnFooter()
static UINode	getColumnFooter(MutableUINode bean)
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 table.
static java.lang.String	getDestination(MutableUINode bean) Gets the base destination for all links generated by the table.
UINode	getDetail() Node to stamp below every row which is disclosed.
static UINode	getDetail(MutableUINode bean) Node to stamp below every row which is disclosed.
DataObjectList	getDetailDisclosure() Gets The list indicating which detail rows are currently disclosed.
static DataObjectList	getDetailDisclosure(MutableUINode bean) Gets The list indicating which detail rows are currently disclosed.
java.lang.String	getHeight() Gets the height of the table.
static java.lang.String	getHeight(MutableUINode bean) Gets the height of the table.
int	getMaxValue() Gets the last possible row in the set of data displayed by the table.
static int	getMaxValue(MutableUINode bean) Gets the last possible row in the set of data displayed by the table.
int	getMinValue() Gets the first possible row in the set of data displayed by the table.
static int	getMinValue(MutableUINode bean) Gets the first possible row in the set of data displayed by the table.
java.lang.String	getName() Gets the name used to identify the table in client-to-client or client-to-server events.
static java.lang.String	getName(MutableUINode bean) Gets the name used to identify the table in client-to-client or client-to-server events.
java.lang.String	getPartialRenderMode() Gets The partialRenderMode attribute is used to control the table's partial page rendering behavior.
static java.lang.String	getPartialRenderMode(MutableUINode bean) Gets The partialRenderMode attribute is used to control the table's partial page rendering behavior.
java.lang.String[]	getPartialTargets() Gets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple".
static java.lang.String[]	getPartialTargets(MutableUINode bean) Gets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple".
DataObjectList	getRowFormats() Gets The formatting information for each row.
static DataObjectList	getRowFormats(MutableUINode bean) Gets The formatting information for each row.
DataObjectList	getRowHeaderData() Gets The data for the row header.
static DataObjectList	getRowHeaderData(MutableUINode bean) Gets The data for the row header.
DataObjectList	getRowHeaderFormats() Gets The formatting information for each row.
static DataObjectList	getRowHeaderFormats(MutableUINode bean) Gets The formatting information for each row.
UINode	getRowHeaderStamp() Node to use to render each row header.
static UINode	getRowHeaderStamp(MutableUINode bean) Node to use to render each row header.
java.lang.String	getShowAll() Gets whether a "Show All" option should be displayed.
static java.lang.String	getShowAll(MutableUINode bean) Gets whether a "Show All" option should be displayed.
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.
DataObjectList	getTableData() Gets the data for the table.
static DataObjectList	getTableData(MutableUINode bean) Gets the data for the table.
UINode	getTableFilter() Node to display in the filter area of the table.
static UINode	getTableFilter(MutableUINode bean) Node to display in the filter area of the table.
DataObject	getTableFormat() Gets formatting information for the entire table.
static DataObject	getTableFormat(MutableUINode bean) Gets formatting information for the entire table.
UINode	getTableSelection() the component used for selecting rows in the table.
static UINode	getTableSelection(MutableUINode bean) the component used for selecting rows in the table.
java.lang.String	getText() Gets the title to display above the table.
static java.lang.String	getText(MutableUINode bean) Gets the title to display above the table.
int	getValue() Gets The first currently visible row in the set of data which is displayed by the table.
static int	getValue(MutableUINode bean) Gets The first currently visible row in the set of data which is displayed by the table.
java.lang.String	getWidth() Gets the width of the table.
static java.lang.String	getWidth(MutableUINode bean) Gets the width of the table.
boolean	isAllDetailsEnabled() Gets Whether or not to add links above table which allows the user to show/hide all the detail areas.
static boolean	isAllDetailsEnabled(MutableUINode bean) Gets Whether or not to add links above table which allows the user to show/hide all the detail areas.
boolean	isFormSubmitted() Gets whether or not to use form sumission in the links generated by the table's navigation bars.
static boolean	isFormSubmitted(MutableUINode bean) Gets whether or not to use form sumission in the links generated by the table's navigation bars.
boolean	isNameTransformed() Gets a boolean value indicating whether or not TableBean should provide any name transformation when rendering data controls.
static boolean	isNameTransformed(MutableUINode bean) Gets a boolean value indicating whether or not TableBean should provide any name transformation when rendering data controls.
boolean	isProxied() Gets whether or not the table should include Javascript proxy code when rendering on the client.
static boolean	isProxied(MutableUINode bean) Gets whether or not the table 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 table.
static boolean	isUnvalidated(MutableUINode bean) Gets whether or not to validate before any form submits generated by this table.
void	setAllDetailsEnabled(boolean allDetailsEnabled) Sets Whether or not to add links above table which allows the user to show/hide all the detail areas.
static void	setAllDetailsEnabled(MutableUINode bean, boolean allDetailsEnabled) Sets Whether or not to add links above table which allows the user to show/hide all the detail areas.
static void	setAlternateText(MutableUINode bean, java.lang.String alternateText) Sets the text to display inside an empty table.
void	setAlternateText(java.lang.String alternateText) Sets the text to display inside an empty table.
void	setBlockSize(int blockSize) Sets the standard number of rows in displayed in the table.
static void	setBlockSize(MutableUINode bean, int blockSize) Sets the standard number of rows in displayed in the table.
static void	setColumnFooter(MutableUINode bean, UINode columnFooterNode)
void	setColumnFooter(UINode columnFooterNode)
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 table.
void	setDestination(java.lang.String destination) Sets the base destination for all links generated by the table.
static void	setDetail(MutableUINode bean, UINode detailNode) Node to stamp below every row which is disclosed.
void	setDetail(UINode detailNode) Node to stamp below every row which is disclosed.
void	setDetailDisclosure(DataObjectList detailDisclosure) Sets The list indicating which detail rows are currently disclosed.
void	setDetailDisclosure(DataObjectList detailDisclosure) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setDetailDisclosure(MutableUINode bean, DataObjectList detailDisclosure) Sets The list indicating which detail rows are currently disclosed.
static void	setDetailDisclosure(MutableUINode bean, DataObjectList detailDisclosure) Deprecated. since 2.0; please use the non-deprecated version of this function.
void	setFormSubmitted(boolean formSubmitted) Sets whether or not to use form sumission in the links generated by the table's navigation bars.
static void	setFormSubmitted(MutableUINode bean, boolean formSubmitted) Sets whether or not to use form sumission in the links generated by the table's navigation bars.
static void	setHeight(MutableUINode bean, java.lang.String height) Sets the height of the table.
void	setHeight(java.lang.String height) Sets the height of the table.
void	setMaxValue(int maxValue) Sets the last possible row in the set of data displayed by the table.
void	setMaxValue(long maxValue) Sets the last possible row in the set of data displayed by the table.
static void	setMaxValue(MutableUINode bean, int maxValue) Sets the last possible row in the set of data displayed by the table.
static void	setMaxValue(MutableUINode bean, long maxValue) Sets the last possible row in the set of data displayed by the table.
void	setMinValue(int minValue) Sets the first possible row in the set of data displayed by the table.
void	setMinValue(long minValue) Sets the first possible row in the set of data displayed by the table.
static void	setMinValue(MutableUINode bean, int minValue) Sets the first possible row in the set of data displayed by the table.
static void	setMinValue(MutableUINode bean, long minValue) Sets the first possible row in the set of data displayed by the table.
static void	setName(MutableUINode bean, java.lang.String name) Sets the name used to identify the table in client-to-client or client-to-server events.
void	setName(java.lang.String name) Sets the name used to identify the table in client-to-client or client-to-server events.
void	setNameTransformed(boolean nameTransformed) Sets a boolean value indicating whether or not TableBean should provide any name transformation when rendering data controls.
static void	setNameTransformed(MutableUINode bean, boolean nameTransformed) Sets a boolean value indicating whether or not TableBean should provide any name transformation when rendering data controls.
static void	setPartialRenderMode(MutableUINode bean, java.lang.String partialRenderMode) Sets The partialRenderMode attribute is used to control the table's partial page rendering behavior.
void	setPartialRenderMode(java.lang.String partialRenderMode) Sets The partialRenderMode attribute is used to control the table's partial page rendering behavior.
static void	setPartialTargets(MutableUINode bean, java.lang.String[] partialTargets) Sets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple".
void	setPartialTargets(java.lang.String[] partialTargets) Sets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple".
void	setProxied(boolean proxied) Sets whether or not the table should include Javascript proxy code when rendering on the client.
static void	setProxied(MutableUINode bean, boolean proxied) Sets whether or not the table should include Javascript proxy code when rendering on the client.
void	setRowFormats(DataObjectList rowFormats) Sets The formatting information for each row.
void	setRowFormats(DataObjectList rowFormats) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setRowFormats(MutableUINode bean, DataObjectList rowFormats) Sets The formatting information for each row.
static void	setRowFormats(MutableUINode bean, DataObjectList rowFormats) Deprecated. since 2.0; please use the non-deprecated version of this function.
void	setRowHeaderData(DataObjectList rowHeaderData) Sets The data for the row header.
void	setRowHeaderData(DataObjectList rowHeaderData) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setRowHeaderData(MutableUINode bean, DataObjectList rowHeaderData) Sets The data for the row header.
static void	setRowHeaderData(MutableUINode bean, DataObjectList rowHeaderData) Deprecated. since 2.0; please use the non-deprecated version of this function.
void	setRowHeaderFormats(DataObjectList rowHeaderFormats) Sets The formatting information for each row.
void	setRowHeaderFormats(DataObjectList rowHeaderFormats) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setRowHeaderFormats(MutableUINode bean, DataObjectList rowHeaderFormats) Sets The formatting information for each row.
static void	setRowHeaderFormats(MutableUINode bean, DataObjectList rowHeaderFormats) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setRowHeaderStamp(MutableUINode bean, UINode rowHeaderStampNode) Node to use to render each row header.
void	setRowHeaderStamp(UINode rowHeaderStampNode) Node to use to render each row header.
static void	setShowAll(MutableUINode bean, java.lang.String showAll) Sets whether a "Show All" option should be displayed.
void	setShowAll(java.lang.String showAll) Sets whether a "Show All" option should be displayed.
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	setTableData(DataObjectList tableData) Sets the data for the table.
void	setTableData(DataObjectList tableData) Deprecated. since 2.0; please use the non-deprecated version of this function.
static void	setTableData(MutableUINode bean, DataObjectList tableData) Sets the data for the table.
static void	setTableData(MutableUINode bean, DataObjectList tableData) Deprecated. since 2.0; please use the non-deprecated version of this function.
void	setTableDataBinding(BoundValue boundValue) Binds the the data for the table.
static void	setTableDataBinding(MutableUINode bean, BoundValue boundValue) Binds the the data for the table.
static void	setTableDataBinding(MutableUINode bean, java.lang.Object selectKey) Binds the the data for the table.
static void	setTableDataBinding(MutableUINode bean, java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the the data for the table.
void	setTableDataBinding(java.lang.Object selectKey) Binds the the data for the table.
void	setTableDataBinding(java.lang.String dataNamespace, java.lang.String dataName, java.lang.Object selectKey) Binds the the data for the table.
static void	setTableFilter(MutableUINode bean, UINode tableFilterNode) Node to display in the filter area of the table.
void	setTableFilter(UINode tableFilterNode) Node to display in the filter area of the table.
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) the component used for selecting rows in the table.
void	setTableSelection(UINode tableSelectionNode) the component used for selecting rows in the table.
static void	setText(MutableUINode bean, java.lang.String text) Sets the title to display above the table.
void	setText(java.lang.String text) Sets the title to display above 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 table.
void	setTranslatableAlternateText(java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the text to display inside an empty table.
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.
static void	setTranslatableText(MutableUINode bean, java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the title to display above the table.
void	setTranslatableText(java.lang.String bundleName, java.lang.String key) Binds to a ResourceBundle the the title to display above the table.
void	setUnvalidated(boolean unvalidated) Sets whether or not to validate before any form submits generated by this table.
static void	setUnvalidated(MutableUINode bean, boolean unvalidated) Sets whether or not to validate before any form submits generated by this table.
void	setValue(int value) Sets The first currently visible row in the set of data which is displayed by the table.
void	setValue(long value) Sets The first currently visible row in the set of data which is displayed by the table.
static void	setValue(MutableUINode bean, int value) Sets The first currently visible row in the set of data which is displayed by the table.
static void	setValue(MutableUINode bean, long value) Sets The first currently visible row in the set of data which is displayed by the table.
static void	setWidth(MutableUINode bean, java.lang.String width) Sets the width of the table.
void	setWidth(java.lang.String width) Sets the width of the table.

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

TableBean

public TableBean()

Construct an instance of the TableBean.

TableBean

public TableBean(java.lang.String name,
                 DataObjectList tableData)

Construct an instance of the TableBean.

Parameters:

name - the name used to identify the table in client-to-client or client-to-server events.

tableData - the data for the table.

TableBean

public TableBean(java.lang.String name,
                 DataObjectList tableData)

Deprecated. since 2.0.

Construct an instance of the TableBean.

Parameters:

name - the name used to identify the table in client-to-client or client-to-server events.

tableData - the data for the table.

TableBean

public TableBean(java.lang.String name,
                 DataObjectList tableData,
                 UINode rowHeaderStampNode,
                 DataObjectList rowHeaderData,
                 UINode columnHeaderStampNode,
                 DataObjectList columnHeaderData)

Construct an instance of the TableBean.

Parameters:

name - the name used to identify the table in client-to-client or client-to-server events.

tableData - the data for the table.

rowHeaderStampNode - Node to use to render each row header.

rowHeaderData - The data for the row header.

columnHeaderStampNode - Node to use to render each column header.

columnHeaderData - The data for the column header.

TableBean

public TableBean(java.lang.String name,
                 DataObjectList tableData,
                 UINode rowHeaderStampNode,
                 DataObjectList rowHeaderData,
                 UINode columnHeaderStampNode,
                 DataObjectList columnHeaderData)

Deprecated. since 2.0.

Construct an instance of the TableBean.

Parameters:

name - the name used to identify the table in client-to-client or client-to-server events.

tableData - the data for the table.

rowHeaderStampNode - Node to use to render each row header.

rowHeaderData - The data for the row header.

columnHeaderStampNode - Node to use to render each column header.

columnHeaderData - The data for the column header.

TableBean

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

Construct an instance of the TableBean. 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.

getRowHeaderStamp

public final UINode getRowHeaderStamp()

Node to use to render each row header.

setRowHeaderStamp

public final void setRowHeaderStamp(UINode rowHeaderStampNode)

Node to use to render each row header.

getColumnFooter

public final UINode getColumnFooter()

setColumnFooter

public final void setColumnFooter(UINode columnFooterNode)

getTableSelection

public final UINode getTableSelection()

the component used for selecting rows in the table.

setTableSelection

public final void setTableSelection(UINode tableSelectionNode)

the component used for selecting rows in the table.

getTableFilter

public final UINode getTableFilter()

Node to display in the filter area of the table. Deprecated.

setTableFilter

public final void setTableFilter(UINode tableFilterNode)

Node to display in the filter area of the table. Deprecated.

getDetail

public final UINode getDetail()

Node to stamp below every row which is disclosed.

setDetail

public final void setDetail(UINode detailNode)

Node to stamp below every row which is disclosed.

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.

getRowFormats

public final DataObjectList getRowFormats()

Gets The formatting information for each row.

setRowFormats

public final void setRowFormats(DataObjectList rowFormats)

Sets The formatting information for each row.

setRowFormats

public final void setRowFormats(DataObjectList rowFormats)

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

Sets The formatting information for each row.

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.

getRowHeaderFormats

public final DataObjectList getRowHeaderFormats()

Gets The formatting information for each row.

setRowHeaderFormats

public final void setRowHeaderFormats(DataObjectList rowHeaderFormats)

Sets The formatting information for each row.

setRowHeaderFormats

public final void setRowHeaderFormats(DataObjectList rowHeaderFormats)

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

Sets The formatting information for each row.

getTableData

public final DataObjectList getTableData()

Gets the data for the table.

setTableData

public final void setTableData(DataObjectList tableData)

Sets the data for the table.

setTableData

public final void setTableData(DataObjectList tableData)

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

Sets the data for the table.

setTableDataBinding

public final void setTableDataBinding(BoundValue boundValue)

Binds the the data for the table.

Parameters:

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

setTableDataBinding

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

Binds the the data for the table.

Parameters:

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

setTableDataBinding

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

Binds the the data for the table.

Parameters:

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

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

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

getRowHeaderData

public final DataObjectList getRowHeaderData()

Gets The data for the row header.

setRowHeaderData

public final void setRowHeaderData(DataObjectList rowHeaderData)

Sets The data for the row header.

setRowHeaderData

public final void setRowHeaderData(DataObjectList rowHeaderData)

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

Sets The data for the row header.

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.

getDetailDisclosure

public final DataObjectList getDetailDisclosure()

Gets The list indicating which detail rows are currently disclosed.

setDetailDisclosure

public final void setDetailDisclosure(DataObjectList detailDisclosure)

Sets The list indicating which detail rows are currently disclosed.

setDetailDisclosure

public final void setDetailDisclosure(DataObjectList detailDisclosure)

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

Sets The list indicating which detail rows are currently disclosed.

isAllDetailsEnabled

public final boolean isAllDetailsEnabled()

Gets Whether or not to add links above table which allows the user to show/hide all the detail areas. Clicking on these links will produce three parameters: event is 'hide' or 'show', source is the table name, and value is UIConstants.VALUE_SHOW_ALL

setAllDetailsEnabled

public final void setAllDetailsEnabled(boolean allDetailsEnabled)

Sets Whether or not to add links above table which allows the user to show/hide all the detail areas. Clicking on these links will produce three parameters: event is 'hide' or 'show', source is the table name, and value is UIConstants.VALUE_SHOW_ALL

getWidth

public final java.lang.String getWidth()

Gets the width of the table.

setWidth

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

Sets the width of the table.

getHeight

public final java.lang.String getHeight()

Gets the height of the table.

setHeight

public final void setHeight(java.lang.String height)

Sets the height of the table.

getText

public final java.lang.String getText()

Gets the title to display above the table.

setText

public final void setText(java.lang.String text)

Sets the title to display above the table.

setTranslatableText

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

Binds to a ResourceBundle the the title to display above the table.

Parameters:

bundleName - the name of the ResourceBundle

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

getAlternateText

public final java.lang.String getAlternateText()

Gets the text to display inside an empty table.

setAlternateText

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

Sets the text to display inside an empty table.

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

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

getBlockSize

public final int getBlockSize()

Gets the standard number of rows in displayed in the table. See the documentation on "Navigation Bars" above. This attribute is Required, if the table is to render navigation bars.

setBlockSize

public final void setBlockSize(int blockSize)

Sets the standard number of rows in displayed in the table. See the documentation on "Navigation Bars" above. This attribute is Required, if the table is to render navigation bars.

getValue

public final int getValue()

Gets The first currently visible row in the set of data which is displayed by the table. This attribute is Required, if the table is to render navigation bars.

setValue

public final void setValue(int value)

Sets The first currently visible row in the set of data which is displayed by the table. This attribute is Required, if the table is to render navigation bars.

setValue

public final void setValue(long value)

Sets The first currently visible row in the set of data which is displayed by the table. This attribute is Required, if the table is to render navigation bars.

getMinValue

public final int getMinValue()

Gets the first possible row in the set of data displayed by the table. It defaults to "1".

setMinValue

public final void setMinValue(int minValue)

Sets the first possible row in the set of data displayed by the table. It defaults to "1".

setMinValue

public final void setMinValue(long minValue)

Sets the first possible row in the set of data displayed by the table. It defaults to "1".

getMaxValue

public final int getMaxValue()

Gets the last possible row in the set of data displayed by the table. If this value is not known, it should be set to MAX_VALUE_UNKNOWN, which is also the default value.

setMaxValue

public final void setMaxValue(int maxValue)

Sets the last possible row in the set of data displayed by the table. If this value is not known, it should be set to MAX_VALUE_UNKNOWN, which is also the default value.

setMaxValue

public final void setMaxValue(long maxValue)

Sets the last possible row in the set of data displayed by the table. If this value is not known, it should be set to MAX_VALUE_UNKNOWN, which is also the default value.

getDestination

public final java.lang.String getDestination()

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

setDestination

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

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

isFormSubmitted

public final boolean isFormSubmitted()

Gets whether or not to use form sumission in the links generated by the table's navigation bars.

setFormSubmitted

public final void setFormSubmitted(boolean formSubmitted)

Sets whether or not to use form sumission in the links generated by the table's navigation bars.

isUnvalidated

public final boolean isUnvalidated()

Gets whether or not to validate before any form submits generated by this table. This attribute is only applicable in formSubmitted mode.

setUnvalidated

public final void setUnvalidated(boolean unvalidated)

Sets whether or not to validate before any form submits generated by this table. This attribute is only applicable in formSubmitted mode.

isProxied

public final boolean isProxied()

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

setProxied

public final void setProxied(boolean proxied)

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

getShowAll

public final java.lang.String getShowAll()

Gets whether a "Show All" option should be displayed. This defaults to "no", and is only meaningful for multi-step navigation bars. It is also only used if the numbers of rows is known ("maxValue" is set), and may also be ignored for very large sets. When this is in effect, event handlers must handle the "value" field of navigation events being set to the string UIConstants.VALUE_SHOW_ALL (instead of a number). The only supported values are UIConstants.SHOW_ALL_YES and UIConstants.SHOW_ALL_NO; the table will infer whether all rows are currently being shown by testing whether the maximum value happens to match the current number of visible rows.

This should only be activated if a query will not be too expensive for your specific application. It will also be automatically disabled if there are a large number of blocks of rows, or if the number of rows is not definitely known.

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

setShowAll

public final void setShowAll(java.lang.String showAll)

Sets whether a "Show All" option should be displayed. This defaults to "no", and is only meaningful for multi-step navigation bars. It is also only used if the numbers of rows is known ("maxValue" is set), and may also be ignored for very large sets. When this is in effect, event handlers must handle the "value" field of navigation events being set to the string UIConstants.VALUE_SHOW_ALL (instead of a number). The only supported values are UIConstants.SHOW_ALL_YES and UIConstants.SHOW_ALL_NO; the table will infer whether all rows are currently being shown by testing whether the maximum value happens to match the current number of visible rows.

This should only be activated if a query will not be too expensive for your specific application. It will also be automatically disabled if there are a large number of blocks of rows, or if the number of rows is not definitely known.

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

getName

public final java.lang.String getName()

Gets the name used to identify the table in client-to-client or client-to-server events.

This is a required property on the bean.

setName

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

Sets the name used to identify the table in client-to-client or client-to-server events.

This is a required property on the bean.

isNameTransformed

public final boolean isNameTransformed()

Gets 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 a boolean value indicating whether or not TableBean should provide any name transformation when rendering data controls. By default, the names are transformed.

getPartialRenderMode

public final java.lang.String getPartialRenderMode()

Gets The partialRenderMode attribute is used to control the table's partial page rendering behavior. partialRenderMode defaults to "none", in which case all table interactions result in full page renders. When partialRenderMode is set to "self" or "multiple", partial page rendering is used to optimize the following table actions, as possible:

• Table navigation (goto)
• Column sorting (sort)
• Adding table row (addRows)
• Updating total row (update)
• Toggling the detail disclosure (hide, show)

In order to enable partial page rendering, the table's id attribute must be set, the table must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the table will use the paritial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, full page rendering will be performed.

setPartialRenderMode

public final void setPartialRenderMode(java.lang.String partialRenderMode)

Sets The partialRenderMode attribute is used to control the table's partial page rendering behavior. partialRenderMode defaults to "none", in which case all table interactions result in full page renders. When partialRenderMode is set to "self" or "multiple", partial page rendering is used to optimize the following table actions, as possible:

• Table navigation (goto)
• Column sorting (sort)
• Adding table row (addRows)
• Updating total row (update)
• Toggling the detail disclosure (hide, show)

In order to enable partial page rendering, the table's id attribute must be set, the table must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the table will use the paritial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, full page rendering will be performed.

getPartialTargets

public final java.lang.String[] getPartialTargets()

Gets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". The ID of the table is automatically included in the set of partial targets and as such should not be specified explicitly in the partialTargets list.

setPartialTargets

public final void setPartialTargets(java.lang.String[] partialTargets)

Sets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". The ID of the table is automatically included in the set of partial targets and as such should not be specified explicitly in the partialTargets list.

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.

getRowHeaderStamp

public static UINode getRowHeaderStamp(MutableUINode bean)

Node to use to render each row header.

setRowHeaderStamp

public static void setRowHeaderStamp(MutableUINode bean,
                                     UINode rowHeaderStampNode)

Node to use to render each row header.

getColumnFooter

public static UINode getColumnFooter(MutableUINode bean)

setColumnFooter

public static void setColumnFooter(MutableUINode bean,
                                   UINode columnFooterNode)

getTableSelection

public static UINode getTableSelection(MutableUINode bean)

the component used for selecting rows in the table.

setTableSelection

public static void setTableSelection(MutableUINode bean,
                                     UINode tableSelectionNode)

the component used for selecting rows in the table.

getTableFilter

public static UINode getTableFilter(MutableUINode bean)

Node to display in the filter area of the table. Deprecated.

setTableFilter

public static void setTableFilter(MutableUINode bean,
                                  UINode tableFilterNode)

Node to display in the filter area of the table. Deprecated.

getDetail

public static UINode getDetail(MutableUINode bean)

Node to stamp below every row which is disclosed.

setDetail

public static void setDetail(MutableUINode bean,
                             UINode detailNode)

Node to stamp below every row which is disclosed.

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.

getRowFormats

public static DataObjectList getRowFormats(MutableUINode bean)

Gets The formatting information for each row.

setRowFormats

public static void setRowFormats(MutableUINode bean,
                                 DataObjectList rowFormats)

Sets The formatting information for each row.

setRowFormats

public static void setRowFormats(MutableUINode bean,
                                 DataObjectList rowFormats)

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

Sets The formatting information for each row.

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.

getRowHeaderFormats

public static DataObjectList getRowHeaderFormats(MutableUINode bean)

Gets The formatting information for each row.

setRowHeaderFormats

public static void setRowHeaderFormats(MutableUINode bean,
                                       DataObjectList rowHeaderFormats)

Sets The formatting information for each row.

setRowHeaderFormats

public static void setRowHeaderFormats(MutableUINode bean,
                                       DataObjectList rowHeaderFormats)

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

Sets The formatting information for each row.

getTableData

public static DataObjectList getTableData(MutableUINode bean)

Gets the data for the table.

setTableData

public static void setTableData(MutableUINode bean,
                                DataObjectList tableData)

Sets the data for the table.

setTableData

public static void setTableData(MutableUINode bean,
                                DataObjectList tableData)

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

Sets the data for the table.

setTableDataBinding

public static void setTableDataBinding(MutableUINode bean,
                                       BoundValue boundValue)

Binds the the data for the table.

Parameters:

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

setTableDataBinding

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

Binds the the data for the table.

Parameters:

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

setTableDataBinding

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

Binds the the data for the table.

Parameters:

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

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

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

getRowHeaderData

public static DataObjectList getRowHeaderData(MutableUINode bean)

Gets The data for the row header.

setRowHeaderData

public static void setRowHeaderData(MutableUINode bean,
                                    DataObjectList rowHeaderData)

Sets The data for the row header.

setRowHeaderData

public static void setRowHeaderData(MutableUINode bean,
                                    DataObjectList rowHeaderData)

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

Sets The data for the row header.

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.

getDetailDisclosure

public static DataObjectList getDetailDisclosure(MutableUINode bean)

Gets The list indicating which detail rows are currently disclosed.

setDetailDisclosure

public static void setDetailDisclosure(MutableUINode bean,
                                       DataObjectList detailDisclosure)

Sets The list indicating which detail rows are currently disclosed.

setDetailDisclosure

public static void setDetailDisclosure(MutableUINode bean,
                                       DataObjectList detailDisclosure)

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

Sets The list indicating which detail rows are currently disclosed.

isAllDetailsEnabled

public static boolean isAllDetailsEnabled(MutableUINode bean)

Gets Whether or not to add links above table which allows the user to show/hide all the detail areas. Clicking on these links will produce three parameters: event is 'hide' or 'show', source is the table name, and value is UIConstants.VALUE_SHOW_ALL

setAllDetailsEnabled

public static void setAllDetailsEnabled(MutableUINode bean,
                                        boolean allDetailsEnabled)

Sets Whether or not to add links above table which allows the user to show/hide all the detail areas. Clicking on these links will produce three parameters: event is 'hide' or 'show', source is the table name, and value is UIConstants.VALUE_SHOW_ALL

getWidth

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

Gets the width of the table.

setWidth

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

Sets the width of the table.

getHeight

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

Gets the height of the table.

setHeight

public static void setHeight(MutableUINode bean,
                             java.lang.String height)

Sets the height of the table.

getText

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

Gets the title to display above the table.

setText

public static void setText(MutableUINode bean,
                           java.lang.String text)

Sets the title to display above the table.

setTranslatableText

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

Binds to a ResourceBundle the the title to display above the table.

Parameters:

bundleName - the name of the ResourceBundle

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

getAlternateText

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

Gets the text to display inside an empty table.

setAlternateText

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

Sets the text to display inside an empty table.

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

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

getBlockSize

public static int getBlockSize(MutableUINode bean)

Gets the standard number of rows in displayed in the table. See the documentation on "Navigation Bars" above. This attribute is Required, if the table is to render navigation bars.

setBlockSize

public static void setBlockSize(MutableUINode bean,
                                int blockSize)

Sets the standard number of rows in displayed in the table. See the documentation on "Navigation Bars" above. This attribute is Required, if the table is to render navigation bars.

getValue

public static int getValue(MutableUINode bean)

Gets The first currently visible row in the set of data which is displayed by the table. This attribute is Required, if the table is to render navigation bars.

setValue

public static void setValue(MutableUINode bean,
                            int value)

Sets The first currently visible row in the set of data which is displayed by the table. This attribute is Required, if the table is to render navigation bars.

setValue

public static void setValue(MutableUINode bean,
                            long value)

Sets The first currently visible row in the set of data which is displayed by the table. This attribute is Required, if the table is to render navigation bars.

getMinValue

public static int getMinValue(MutableUINode bean)

Gets the first possible row in the set of data displayed by the table. It defaults to "1".

setMinValue

public static void setMinValue(MutableUINode bean,
                               int minValue)

Sets the first possible row in the set of data displayed by the table. It defaults to "1".

setMinValue

public static void setMinValue(MutableUINode bean,
                               long minValue)

Sets the first possible row in the set of data displayed by the table. It defaults to "1".

getMaxValue

public static int getMaxValue(MutableUINode bean)

Gets the last possible row in the set of data displayed by the table. If this value is not known, it should be set to MAX_VALUE_UNKNOWN, which is also the default value.

setMaxValue

public static void setMaxValue(MutableUINode bean,
                               int maxValue)

Sets the last possible row in the set of data displayed by the table. If this value is not known, it should be set to MAX_VALUE_UNKNOWN, which is also the default value.

setMaxValue

public static void setMaxValue(MutableUINode bean,
                               long maxValue)

Sets the last possible row in the set of data displayed by the table. If this value is not known, it should be set to MAX_VALUE_UNKNOWN, which is also the default value.

getDestination

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

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

setDestination

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

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

isFormSubmitted

public static boolean isFormSubmitted(MutableUINode bean)

Gets whether or not to use form sumission in the links generated by the table's navigation bars.

setFormSubmitted

public static void setFormSubmitted(MutableUINode bean,
                                    boolean formSubmitted)

Sets whether or not to use form sumission in the links generated by the table's navigation bars.

isUnvalidated

public static boolean isUnvalidated(MutableUINode bean)

Gets whether or not to validate before any form submits generated by this table. This attribute is only applicable 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 table. This attribute is only applicable in formSubmitted mode.

isProxied

public static boolean isProxied(MutableUINode bean)

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

setProxied

public static void setProxied(MutableUINode bean,
                              boolean proxied)

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

getShowAll

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

Gets whether a "Show All" option should be displayed. This defaults to "no", and is only meaningful for multi-step navigation bars. It is also only used if the numbers of rows is known ("maxValue" is set), and may also be ignored for very large sets. When this is in effect, event handlers must handle the "value" field of navigation events being set to the string UIConstants.VALUE_SHOW_ALL (instead of a number). The only supported values are UIConstants.SHOW_ALL_YES and UIConstants.SHOW_ALL_NO; the table will infer whether all rows are currently being shown by testing whether the maximum value happens to match the current number of visible rows.

This should only be activated if a query will not be too expensive for your specific application. It will also be automatically disabled if there are a large number of blocks of rows, or if the number of rows is not definitely known.

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

setShowAll

public static void setShowAll(MutableUINode bean,
                              java.lang.String showAll)

Sets whether a "Show All" option should be displayed. This defaults to "no", and is only meaningful for multi-step navigation bars. It is also only used if the numbers of rows is known ("maxValue" is set), and may also be ignored for very large sets. When this is in effect, event handlers must handle the "value" field of navigation events being set to the string UIConstants.VALUE_SHOW_ALL (instead of a number). The only supported values are UIConstants.SHOW_ALL_YES and UIConstants.SHOW_ALL_NO; the table will infer whether all rows are currently being shown by testing whether the maximum value happens to match the current number of visible rows.

This should only be activated if a query will not be too expensive for your specific application. It will also be automatically disabled if there are a large number of blocks of rows, or if the number of rows is not definitely known.

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

getName

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

Gets the name used to identify the table in client-to-client or client-to-server events.

This is a required property on the bean.

setName

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

Sets the name used to identify the table in client-to-client or client-to-server events.

This is a required property on the bean.

isNameTransformed

public static boolean isNameTransformed(MutableUINode bean)

Gets 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 a boolean value indicating whether or not TableBean should provide any name transformation when rendering data controls. By default, the names are transformed.

getPartialRenderMode

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

Gets The partialRenderMode attribute is used to control the table's partial page rendering behavior. partialRenderMode defaults to "none", in which case all table interactions result in full page renders. When partialRenderMode is set to "self" or "multiple", partial page rendering is used to optimize the following table actions, as possible:

• Table navigation (goto)
• Column sorting (sort)
• Adding table row (addRows)
• Updating total row (update)
• Toggling the detail disclosure (hide, show)

In order to enable partial page rendering, the table's id attribute must be set, the table must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the table will use the paritial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, full page rendering will be performed.

setPartialRenderMode

public static void setPartialRenderMode(MutableUINode bean,
                                        java.lang.String partialRenderMode)

Sets The partialRenderMode attribute is used to control the table's partial page rendering behavior. partialRenderMode defaults to "none", in which case all table interactions result in full page renders. When partialRenderMode is set to "self" or "multiple", partial page rendering is used to optimize the following table actions, as possible:

• Table navigation (goto)
• Column sorting (sort)
• Adding table row (addRows)
• Updating total row (update)
• Toggling the detail disclosure (hide, show)

In order to enable partial page rendering, the table's id attribute must be set, the table must be contained in with an UIX body element, and the Configuration.ACCESSIBILITY_MODE must be set to AccessibilityMode.INACCESSIBLE_MODE. When these requirements are met, and partialRenderMode is set to "self" or "multiple", the table will use the paritial page rendering architecture to send events to the application. If any of these requirements are not met, or if the browser is not capable of supporting partial page rendering, full page rendering will be performed.

getPartialTargets

public static java.lang.String[] getPartialTargets(MutableUINode bean)

Gets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". The ID of the table is automatically included in the set of partial targets and as such should not be specified explicitly in the partialTargets list.

setPartialTargets

public static void setPartialTargets(MutableUINode bean,
                                     java.lang.String[] partialTargets)

Sets The IDs of the partial target nodes to render when the partialRenderMode is set to "multiple". The ID of the table is automatically included in the set of partial targets and as such should not be specified explicitly in the partialTargets list.