Skip navigation links

oracle.adf.view.rich.component.rich.data
Class RichTreeTable

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXCollection
org.apache.myfaces.trinidad.component.UIXHierarchy
org.apache.myfaces.trinidad.component.UIXTree
org.apache.myfaces.trinidad.component.UIXTreeTable
oracle.adf.view.rich.component.rich.data.RichTreeTable

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder, DragSourceFactory, org.apache.myfaces.trinidad.component.CollectionComponent, org.apache.myfaces.trinidad.model.RowKeyIndex

public class RichTreeTable

extends org.apache.myfaces.trinidad.component.UIXTreeTable

implements DragSourceFactory, javax.faces.component.NamingContainer

The TreeTable is used to display data that is structured in a hierarchical format. This component displays a hierarchy in a UI similar to a Table, and is more elaborate than the Tree component. TreeTable supports displaying columns of data per tree node in the hierarchy. The features of the TreeTable include mechanisms for focusing in on subtrees (within the main tree), as well as expanding and collapsing elements in the hierarchy.

Tree Model

The TreeTable component uses a model to access the underlying hierarchical data. The specific model class is org.apache.myfaces.trinidad.model.TreeModel. There is a utility class available that wraps a Java List of beans or maps in an implementation of the org.apache.myfaces.trinidad.model.TreeModel (See org.apache.myfaces.trinidad.model.ChildPropertyTreeModel).

Columns

Like the Table, the TreeTable's children must be Column components (see Table Columns). Like the Tree, the TreeTable has a "nodeStamp" facet which renders the "Object Name" Column. The "Object Name" Column contains the primary identifier of an element in the hierarchy. For example, in an organization chart of employees, the "Object Name" Column might be the employee name.

Headers

See Table Headers.

Selection

See Table Selection.

Grid Lines and Banding

See Table Grid Lines and Banding.

Column Groups

See Table Column Groups.

Sorting

See Table Sorting. Unlike the Table, the TreeTable does not support automatic sorting. The underlying TreeModel must support sorting by implementing it's sorting logic in the setSortCriteria(List criteria) method of the TreeModel.

Fetch Size

See Table Fetch Size.

CSS Style Restriction

See Table CSS Style Restrictions.

Hierachical Selector

See Tree Hierachical Selector.

<section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children, e.g., panelStretchLayout.</html:li> <html:li>This component does not stretch its children.</html:li> </html:ul> </section>

Events:

Type	Phases	Description
org.apache.myfaces.trinidad.event.RowDisclosureEvent	Apply Request Values Invoke Application	The expansion event is generated for a table when the detail facet of a row is expanded or collapsed. For tree or a treeTable, the expansion event is generated when tree nodes are expanded or collapsed.
org.apache.myfaces.trinidad.event.SelectionEvent	Apply Request Values Invoke Application	The selection event is delivered when the table selection changes.
org.apache.myfaces.trinidad.event.FocusEvent	Apply Request Values Invoke Application	Event delivered when user clicks to focus on (or zoom into) a particular element's subtree of children. The TreeTable responds to this event by modifying the "focusPath" property appropriately. Subsequently, any registered FocusListener instances are called.
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Field Summary

static java.lang.String	BODY_CONTEXT_MENU_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	BODY_CONTEXT_MENU_ID_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	CLEAR_TOKEN_CACHE_ON_PPR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_ATTRIBUTES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_COMPONENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	COLUMN_BANDING_INTERVAL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	COLUMN_SELECTION_KEY
static java.lang.String	COLUMN_SELECTION_MULTIPLE
static java.lang.String	COLUMN_SELECTION_NONE
static java.lang.String	COLUMN_SELECTION_SINGLE
static org.apache.myfaces.trinidad.bean.PropertyKey	COLUMN_STRETCHING_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	CONTENT_DELIVERY_IMMEDIATE
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_DELIVERY_KEY
static java.lang.String	CONTENT_DELIVERY_LAZY
static java.lang.String	CONTEXT_MENU_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTEXT_MENU_ID_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTEXT_MENU_SELECT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	DISABLE_COLUMN_REORDERING_KEY
static java.lang.String	DISPLAY_ROW_FIRST
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAY_ROW_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAY_ROW_KEY_KEY
static java.lang.String	DISPLAY_ROW_LAST
static java.lang.String	DISPLAY_ROW_SELECTED
static java.lang.String	EDITING_MODE_CLICK_TO_EDIT
static java.lang.String	EDITING_MODE_EDIT_ALL
static org.apache.myfaces.trinidad.bean.PropertyKey	EDITING_MODE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	EMPTY_TEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	EXPAND_ALL_ENABLED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FETCH_SIZE_KEY
static java.lang.String	FOOTER_FACET
static java.lang.String	HEADER_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	HORIZONTAL_GRID_VISIBLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static java.lang.String	PATH_STAMP_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	ROW_BANDING_INTERVAL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ROW_SELECTION_KEY
static java.lang.String	ROW_SELECTION_MULTIPLE
static java.lang.String	ROW_SELECTION_MULTIPLE_NO_SELECT_ALL
static java.lang.String	ROW_SELECTION_NONE
static java.lang.String	ROW_SELECTION_SINGLE
static org.apache.myfaces.trinidad.bean.PropertyKey	SCROLL_LEFT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SCROLL_TOP_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SCROLL_TOP_ROW_KEY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SUMMARY_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	UNSECURE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VERTICAL_GRID_VISIBLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	WIDTH_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXTreeTable

RANGE_CHANGE_LISTENER_KEY, ROOT_NODE_RENDERED_KEY, ROWS_BY_DEPTH_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXTree

DISCLOSED_ROW_KEYS_KEY, FOCUS_LISTENER_KEY, FOCUS_ROW_KEY_KEY, IMMEDIATE_KEY, INITIALLY_EXPANDED_KEY, NODE_STAMP_FACET, ROW_DISCLOSURE_LISTENER_KEY, SELECTED_ROW_KEYS_KEY, SELECTION_LISTENER_KEY, VALUE_KEY, VAR_STATUS_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXCollection

VAR_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Fields inherited from interface oracle.adf.view.rich.dnd.DragSourceFactory

DEFAULT_DRAGSOURCE

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

	RichTreeTable() Construct an instance of the RichTreeTable.
protected	RichTreeTable(java.lang.String rendererType) Construct an instance of the RichTreeTable.

Method Summary

void	__decodeChildrenImpl(javax.faces.context.FacesContext context)
void	__updateChildrenImpl(javax.faces.context.FacesContext context)
void	__validateChildrenImpl(javax.faces.context.FacesContext context)
void	broadcast(javax.faces.event.FacesEvent event)
DragSource	createDragSource(java.lang.String name, java.util.Set<DnDAction> allowedActions, DnDAction defaultAction, java.lang.String discriminant, javax.el.MethodExpression dragDropEndListener, java.util.Map<java.lang.String,?> properties) Returns the server DragSource, or null if no DragSource should be attached.
java.lang.CharSequence	createDragSourceBehavior(java.lang.String name, DragSource dragSource, java.util.Set<DnDAction> allowedActions, DnDAction defaultAction, java.lang.String discriminant, javax.el.MethodExpression dragDropEndListener, java.util.Map<java.lang.String,?> properties) Returns the client DragSource initializer.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
javax.faces.component.UIComponent	getBodyContextMenu() popup component containing the context menu that will be shown on right click within the table body, but outside of any table row.
java.lang.String	getBodyContextMenuId() Deprecated. This attribute is deprecated, "bodyContextMenu" facet should be used instead.
java.util.Set	getClientAttributes() Gets a set of client attribute names.
ClientListenerSet	getClientListeners() Gets a set of client listeners.
int	getColumnBandingInterval() Gets the interval between which the column banding occurs.
java.lang.String	getColumnSelection() Gets whether columns in this table are selectable.
java.lang.String	getColumnStretching() Gets Indicates what kind of stretching you want applied to the columns.
java.lang.String	getContentDelivery() Gets whether data should be fetched when the component is rendered initially.
javax.faces.component.UIComponent	getContextMenu() popup component containing the context menu that will be shown on right click of any table row.
java.lang.String	getContextMenuId() Deprecated. This attribute is deprecated, "contextMenu" facet should be used instead.
java.lang.String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
java.lang.String	getDisplayRow() Gets the row to display in the table during intial display.
java.lang.Object	getDisplayRowKey() Gets the rowkey to display in the table during intial display.
java.lang.String	getEditingMode() Gets Indicates the mode used to edit the table when it contains editable components.
java.lang.String	getEmptyText() Gets the text of an empty table.
java.lang.String	getFamily()
int	getFetchSize() Gets the number of rows in the data fetch block
javax.faces.component.UIComponent	getFooter() the component used to render the table footer.
javax.faces.component.UIComponent	getHeader() the component used to render the table header.
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
javax.faces.component.UIComponent	getPathStamp() the component used to stamp each step of the focus path when the Hierachical Selector popup is displayed.
int	getRowBandingInterval() Gets the interval between which the row banding occurs.
java.lang.String	getRowSelection() Gets whether rows in this table are selectable.
int	getScrollLeft() Gets private property to indicate current horizontal scroll position.
int	getScrollTop() Gets private property to indicate current vertical scroll position.
java.lang.Object	getScrollTopRowKey() Gets private property to indicate row key for the first visible row.
java.lang.String	getShortDesc() Gets the short description of the component.
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
java.lang.String	getSummary() Gets the summary of this table's purpose and structure for user agents rendering to non-visual media.
java.util.Set<java.lang.String>	getUnsecure() Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
java.lang.String	getWidth() Gets the width of this component.
boolean	isClearTokenCacheOnPPR() Gets private property to turn on/off the clearing of the row key token cache when the component is PPRed.
boolean	isClientComponent() Gets whether a client-side component will be generated.
boolean	isContextMenuSelect() Gets Indicates if we should actually select the row clicked when right clicking to show a context menu.
boolean	isDisableColumnReordering() Gets whether column reordering is disabled in the table.
boolean	isExpandAllEnabled() Gets Indicates whether the "Expand/Collapse All", and "Expand/Collapse All Below" menu items are rendered.
boolean	isHorizontalGridVisible() Gets whether the Horizontal GridLines are to be drawn.
boolean	isVerticalGridVisible() Gets whether the vertical GridLines are to be drawn.
boolean	isVisible() Gets the visibility of the component.
void	setBodyContextMenu(javax.faces.component.UIComponent bodyContextMenuFacet) popup component containing the context menu that will be shown on right click within the table body, but outside of any table row.
void	setBodyContextMenuId(java.lang.String bodyContextMenuId) Deprecated. This attribute is deprecated, "bodyContextMenu" facet should be used instead.
void	setClearTokenCacheOnPPR(boolean clearTokenCacheOnPPR) Sets private property to turn on/off the clearing of the row key token cache when the component is PPRed.
void	setClientAttributes(java.util.Set clientAttributes) Sets a set of client attribute names.
void	setClientComponent(boolean clientComponent) Sets whether a client-side component will be generated.
void	setClientListeners(ClientListenerSet clientListeners) Sets a set of client listeners.
void	setColumnBandingInterval(int columnBandingInterval) Sets the interval between which the column banding occurs.
void	setColumnSelection(java.lang.String columnSelection) Sets whether columns in this table are selectable.
void	setColumnStretching(java.lang.String columnStretching) Sets Indicates what kind of stretching you want applied to the columns.
void	setContentDelivery(java.lang.String contentDelivery) Sets whether data should be fetched when the component is rendered initially.
void	setContextMenu(javax.faces.component.UIComponent contextMenuFacet) popup component containing the context menu that will be shown on right click of any table row.
void	setContextMenuId(java.lang.String contextMenuId) Deprecated. This attribute is deprecated, "contextMenu" facet should be used instead.
void	setContextMenuSelect(boolean contextMenuSelect) Sets Indicates if we should actually select the row clicked when right clicking to show a context menu.
void	setCustomizationId(java.lang.String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setDisableColumnReordering(boolean disableColumnReordering) Sets whether column reordering is disabled in the table.
void	setDisplayRow(java.lang.String displayRow) Sets the row to display in the table during intial display.
void	setDisplayRowKey(java.lang.Object displayRowKey) Sets the rowkey to display in the table during intial display.
void	setEditingMode(java.lang.String editingMode) Sets Indicates the mode used to edit the table when it contains editable components.
void	setEmptyText(java.lang.String emptyText) Sets the text of an empty table.
void	setExpandAllEnabled(boolean expandAllEnabled) Sets Indicates whether the "Expand/Collapse All", and "Expand/Collapse All Below" menu items are rendered.
void	setFetchSize(int fetchSize) Sets the number of rows in the data fetch block
void	setFooter(javax.faces.component.UIComponent footerFacet) the component used to render the table footer.
void	setHeader(javax.faces.component.UIComponent headerFacet) the component used to render the table header.
void	setHorizontalGridVisible(boolean horizontalGridVisible) Sets whether the Horizontal GridLines are to be drawn.
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setPathStamp(javax.faces.component.UIComponent pathStampFacet) the component used to stamp each step of the focus path when the Hierachical Selector popup is displayed.
void	setRowBandingInterval(int rowBandingInterval) Sets the interval between which the row banding occurs.
void	setRowSelection(java.lang.String rowSelection) Sets whether rows in this table are selectable.
void	setScrollLeft(int scrollLeft) Sets private property to indicate current horizontal scroll position.
void	setScrollTop(int scrollTop) Sets private property to indicate current vertical scroll position.
void	setScrollTopRowKey(java.lang.Object scrollTopRowKey) Sets private property to indicate row key for the first visible row.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the component.
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
void	setSummary(java.lang.String summary) Sets the summary of this table's purpose and structure for user agents rendering to non-visual media.
void	setUnsecure(java.util.Set<java.lang.String> unsecure) Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
void	setVerticalGridVisible(boolean verticalGridVisible) Sets whether the vertical GridLines are to be drawn.
void	setVisible(boolean visible) Sets the visibility of the component.
void	setWidth(java.lang.String width) Sets the width of this component.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXTreeTable

__encodeBegin, addRangeChangeListener, decode, getContainerClientId, getFirst, getRangeChangeListener, getRangeChangeListeners, getRows, getRowsByDepth, getStamps, isRootNodeRendered, processFacetsAndChildren, processUpdates, processValidators, removeRangeChangeListener, restoreStampState, restoreState, saveStampState, saveState, setFirst, setRangeChangeListener, setRangeChangeListener, setRootNodeRendered, setRowsByDepth

Methods inherited from class org.apache.myfaces.trinidad.component.UIXTree

addFocusListener, addRowDisclosureListener, addSelectionListener, createCollectionModel, createFacesBean, getDisclosedRowKeys, getFocusListener, getFocusListeners, getFocusRowKey, getNodeStamp, getRowDisclosureListener, getRowDisclosureListeners, getSelectedRowKeys, getSelectionListener, getSelectionListeners, getValue, getVarStatus, isImmediate, isInitiallyExpanded, queueEvent, removeFocusListener, removeRowDisclosureListener, removeSelectionListener, setDisclosedRowKeys, setFocusListener, setFocusRowKey, setImmediate, setInitiallyExpanded, setNodeStamp, setRowDisclosureListener, setRowDisclosureListener, setSelectedRowKeys, setSelectionListener, setSelectionListener, setValue, setVarStatus

Methods inherited from class org.apache.myfaces.trinidad.component.UIXHierarchy

enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getTreeModel, isContainer, isContainerEmpty

Methods inherited from class org.apache.myfaces.trinidad.component.UIXCollection

clearCurrencyStringCache, createVarStatusMap, decodeChildrenImpl, encodeBegin, encodeEnd, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, resetStampState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setVar, updateChildrenImpl, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, decodeChildren, encodeAll, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, removeAttributeChangeListener, removeFacesListener, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, validateChildren

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.myfaces.trinidad.component.CollectionComponent

getVar

Methods inherited from interface org.apache.myfaces.trinidad.model.RowKeyIndex

getRowCount, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, setRowIndex, setRowKey

Field Detail

COLUMN_SELECTION_NONE

public static final java.lang.String COLUMN_SELECTION_NONE

See Also:

Constant Field Values

COLUMN_SELECTION_SINGLE

public static final java.lang.String COLUMN_SELECTION_SINGLE

See Also:

Constant Field Values

COLUMN_SELECTION_MULTIPLE

public static final java.lang.String COLUMN_SELECTION_MULTIPLE

See Also:

Constant Field Values

ROW_SELECTION_NONE

public static final java.lang.String ROW_SELECTION_NONE

See Also:

Constant Field Values

ROW_SELECTION_SINGLE

public static final java.lang.String ROW_SELECTION_SINGLE

See Also:

Constant Field Values

ROW_SELECTION_MULTIPLE

public static final java.lang.String ROW_SELECTION_MULTIPLE

See Also:

Constant Field Values

ROW_SELECTION_MULTIPLE_NO_SELECT_ALL

public static final java.lang.String ROW_SELECTION_MULTIPLE_NO_SELECT_ALL

See Also:

Constant Field Values

DISPLAY_ROW_FIRST

public static final java.lang.String DISPLAY_ROW_FIRST

See Also:

Constant Field Values

DISPLAY_ROW_LAST

public static final java.lang.String DISPLAY_ROW_LAST

See Also:

Constant Field Values

DISPLAY_ROW_SELECTED

public static final java.lang.String DISPLAY_ROW_SELECTED

See Also:

Constant Field Values

EDITING_MODE_EDIT_ALL

public static final java.lang.String EDITING_MODE_EDIT_ALL

See Also:

Constant Field Values

EDITING_MODE_CLICK_TO_EDIT

public static final java.lang.String EDITING_MODE_CLICK_TO_EDIT

See Also:

Constant Field Values

CONTENT_DELIVERY_IMMEDIATE

public static final java.lang.String CONTENT_DELIVERY_IMMEDIATE

See Also:

Constant Field Values

CONTENT_DELIVERY_LAZY

public static final java.lang.String CONTENT_DELIVERY_LAZY

See Also:

Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

UNSECURE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

Deprecated.

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

BODY_CONTEXT_MENU_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey BODY_CONTEXT_MENU_ID_KEY

Deprecated.

COLUMN_SELECTION_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_SELECTION_KEY

COLUMN_STRETCHING_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_STRETCHING_KEY

CONTEXT_MENU_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTEXT_MENU_ID_KEY

Deprecated.

DISABLE_COLUMN_REORDERING_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLE_COLUMN_REORDERING_KEY

HORIZONTAL_GRID_VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HORIZONTAL_GRID_VISIBLE_KEY

VERTICAL_GRID_VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VERTICAL_GRID_VISIBLE_KEY

EMPTY_TEXT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EMPTY_TEXT_KEY

COLUMN_BANDING_INTERVAL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_BANDING_INTERVAL_KEY

ROW_BANDING_INTERVAL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_BANDING_INTERVAL_KEY

ROW_SELECTION_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_SELECTION_KEY

WIDTH_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey WIDTH_KEY

SUMMARY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SUMMARY_KEY

FETCH_SIZE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey FETCH_SIZE_KEY

DISPLAY_ROW_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_ROW_KEY

DISPLAY_ROW_KEY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_ROW_KEY_KEY

CONTEXT_MENU_SELECT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTEXT_MENU_SELECT_KEY

EDITING_MODE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EDITING_MODE_KEY

SCROLL_TOP_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SCROLL_TOP_KEY

SCROLL_LEFT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SCROLL_LEFT_KEY

SCROLL_TOP_ROW_KEY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SCROLL_TOP_ROW_KEY_KEY

CLEAR_TOKEN_CACHE_ON_PPR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLEAR_TOKEN_CACHE_ON_PPR_KEY

EXPAND_ALL_ENABLED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EXPAND_ALL_ENABLED_KEY

CONTENT_DELIVERY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY

FOOTER_FACET

public static final java.lang.String FOOTER_FACET

See Also:

Constant Field Values

HEADER_FACET

public static final java.lang.String HEADER_FACET

See Also:

Constant Field Values

CONTEXT_MENU_FACET

public static final java.lang.String CONTEXT_MENU_FACET

See Also:

Constant Field Values

BODY_CONTEXT_MENU_FACET

public static final java.lang.String BODY_CONTEXT_MENU_FACET

See Also:

Constant Field Values

PATH_STAMP_FACET

public static final java.lang.String PATH_STAMP_FACET

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

RichTreeTable

public RichTreeTable()

Construct an instance of the RichTreeTable.

RichTreeTable

protected RichTreeTable(java.lang.String rendererType)

Construct an instance of the RichTreeTable.

Method Detail

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class org.apache.myfaces.trinidad.component.UIXTreeTable

Throws:

javax.faces.event.AbortProcessingException

__decodeChildrenImpl

public void __decodeChildrenImpl(javax.faces.context.FacesContext context)

__validateChildrenImpl

public void __validateChildrenImpl(javax.faces.context.FacesContext context)

__updateChildrenImpl

public void __updateChildrenImpl(javax.faces.context.FacesContext context)

createDragSource

public DragSource createDragSource(java.lang.String name,
                                   java.util.Set<DnDAction> allowedActions,
                                   DnDAction defaultAction,
                                   java.lang.String discriminant,
                                   javax.el.MethodExpression dragDropEndListener,
                                   java.util.Map<java.lang.String,?> properties)

Description copied from interface: DragSourceFactory

Returns the server DragSource, or null if no DragSource should be attached.

Specified by:

createDragSource in interface DragSourceFactory

Parameters:

name - refers to a named DragSource; "default" refers to the default DragSource

allowedActions - Set of DnDAction supported by the DragSource.

defaultAction - Default drag and drop action supported by this drag source

discriminant - The discriminant for the default DataFlavors generated by this drag source.

dragDropEndListener - A method reference to an event of the signature void method(DropEvent) that is invoked after the drag drop operation ends.

properties - allows for additional properties in the future

Returns:

DragSource

createDragSourceBehavior

public java.lang.CharSequence createDragSourceBehavior(java.lang.String name,
                                                       DragSource dragSource,
                                                       java.util.Set<DnDAction> allowedActions,
                                                       DnDAction defaultAction,
                                                       java.lang.String discriminant,
                                                       javax.el.MethodExpression dragDropEndListener,
                                                       java.util.Map<java.lang.String,?> properties)

Description copied from interface: DragSourceFactory

Returns the client DragSource initializer.

Specified by:

createDragSourceBehavior in interface DragSourceFactory

Parameters:

name - refers to a named DragSource; "default" refers to the default DragSource

dragSource - DragSource to create clientDragSource initializer for.

allowedActions - Set of DnDAction supported by the DragSource.

defaultAction - Default drag and drop action supported by this drag source

discriminant - The discriminant for the default DataFlavors generated by this drag source.

dragDropEndListener - A method reference to an event of the signature void method(DropEvent) that is invoked after the drag drop operation ends.

properties - allows for additional properties in the future

Returns:

CharSequence

getFooter

public final javax.faces.component.UIComponent getFooter()

the component used to render the table footer. This facet existed in 10.1.3, but is currently not supported in RichTable and RichTreeTable

setFooter

public final void setFooter(javax.faces.component.UIComponent footerFacet)

the component used to render the table footer. This facet existed in 10.1.3, but is currently not supported in RichTable and RichTreeTable

getHeader

public final javax.faces.component.UIComponent getHeader()

the component used to render the table header. This facet existed in 10.1.3, but is currently not supported in RichTable and RichTreeTable

setHeader

public final void setHeader(javax.faces.component.UIComponent headerFacet)

the component used to render the table header. This facet existed in 10.1.3, but is currently not supported in RichTable and RichTreeTable

getContextMenu

public final javax.faces.component.UIComponent getContextMenu()

popup component containing the context menu that will be shown on right click of any table row. The af:popup must contain an af:menu to display the context menu

setContextMenu

public final void setContextMenu(javax.faces.component.UIComponent contextMenuFacet)

popup component containing the context menu that will be shown on right click of any table row. The af:popup must contain an af:menu to display the context menu

getBodyContextMenu

public final javax.faces.component.UIComponent getBodyContextMenu()

popup component containing the context menu that will be shown on right click within the table body, but outside of any table row. The af:popup must contain an af:menu to display the context menu

setBodyContextMenu

public final void setBodyContextMenu(javax.faces.component.UIComponent bodyContextMenuFacet)

popup component containing the context menu that will be shown on right click within the table body, but outside of any table row. The af:popup must contain an af:menu to display the context menu

getPathStamp

public final javax.faces.component.UIComponent getPathStamp()

the component used to stamp each step of the focus path when the Hierachical Selector popup is displayed. This component can be a a combination of simple outputText, image, or outputFormatted tags and must not be an "input" component (EditableValueHolder) since no user input is allowed in the Hierarchical Selector popup. If this facet is not provided, then the Hierarchical Selector icon is not rendered.

setPathStamp

public final void setPathStamp(javax.faces.component.UIComponent pathStampFacet)

the component used to stamp each step of the focus path when the Hierachical Selector popup is displayed. This component can be a a combination of simple outputText, image, or outputFormatted tags and must not be an "input" component (EditableValueHolder) since no user input is allowed in the Hierarchical Selector popup. If this facet is not provided, then the Hierarchical Selector icon is not rendered.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()

Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Parameters:

styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final java.util.Set<java.lang.String> getUnsecure()

Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.

Returns:

the new unsecure value

setUnsecure

public final void setUnsecure(java.util.Set<java.lang.String> unsecure)

Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute.

Parameters:

unsecure - the new unsecure value

isVisible

public final boolean isVisible()

Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Parameters:

visible - the new visible value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

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

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Parameters:

partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

getBodyContextMenuId

@Deprecated
public final java.lang.String getBodyContextMenuId()

Deprecated. This attribute is deprecated, "bodyContextMenu" facet should be used instead.

Gets A search expression to identify the popup component containing the context menu that will be shown within the table body, for clicks outside of any table row. Expressions are relative to this table component and must account for NamingContainers (for example, table and panelCollection are NamingContainer components). You can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will pop out of one NamingContainer (including the component itself if it is a naming container, like table) and begin search from there, ":::" will pop out of two NamingContainers and begin search from there, etc.

Returns:

the new bodyContextMenuId value

setBodyContextMenuId

@Deprecated
public final void setBodyContextMenuId(java.lang.String bodyContextMenuId)

Deprecated. This attribute is deprecated, "bodyContextMenu" facet should be used instead.

Sets A search expression to identify the popup component containing the context menu that will be shown within the table body, for clicks outside of any table row. Expressions are relative to this table component and must account for NamingContainers (for example, table and panelCollection are NamingContainer components). You can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will pop out of one NamingContainer (including the component itself if it is a naming container, like table) and begin search from there, ":::" will pop out of two NamingContainers and begin search from there, etc.

Parameters:

bodyContextMenuId - the new bodyContextMenuId value

getColumnSelection

public final java.lang.String getColumnSelection()

Gets whether columns in this table are selectable.

Returns:

the new columnSelection value

setColumnSelection

public final void setColumnSelection(java.lang.String columnSelection)

Sets whether columns in this table are selectable.

Parameters:

columnSelection - the new columnSelection value

getColumnStretching

public final java.lang.String getColumnStretching()

Gets Indicates what kind of stretching you want applied to the columns. For optimal performance, use the "none" (default) option. If you want the last column to stretch to fill up any unused space inside of the viewport, use the "last" option. If you want to have an empty blank column be automatically inserted and have it stretch (so the row background colors will span the entire width of the table), use the "blank" option. If you want to have a specific leaf (non-group) column stretch to fill up any unused space inside of the viewport, use the option where you specify "column:" followed by the ID of the column that you want to have stretched, e.g. "column:myColId". Note that row headers and frozen columns will not be stretched because doing so could easily leave the user unable to access the scrollable data body of the table. Only a maximum of one column may be stretched at a time.

Returns:

the new columnStretching value

setColumnStretching

public final void setColumnStretching(java.lang.String columnStretching)

Sets Indicates what kind of stretching you want applied to the columns. For optimal performance, use the "none" (default) option. If you want the last column to stretch to fill up any unused space inside of the viewport, use the "last" option. If you want to have an empty blank column be automatically inserted and have it stretch (so the row background colors will span the entire width of the table), use the "blank" option. If you want to have a specific leaf (non-group) column stretch to fill up any unused space inside of the viewport, use the option where you specify "column:" followed by the ID of the column that you want to have stretched, e.g. "column:myColId". Note that row headers and frozen columns will not be stretched because doing so could easily leave the user unable to access the scrollable data body of the table. Only a maximum of one column may be stretched at a time.

Parameters:

columnStretching - the new columnStretching value

getContextMenuId

@Deprecated
public final java.lang.String getContextMenuId()

Deprecated. This attribute is deprecated, "contextMenu" facet should be used instead.

Gets A search expression to identify the popup component containing the context menu that will be shown on right click of any table row. Expressions are relative to this table component and must account for NamingContainers (for example, table and panelCollection are NamingContainer components). You can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will pop out of one NamingContainer (including the component itself if it is a naming container, like table) and begin search from there, ":::" will pop out of two NamingContainers and begin search from there, etc.

Returns:

the new contextMenuId value

setContextMenuId

@Deprecated
public final void setContextMenuId(java.lang.String contextMenuId)

Deprecated. This attribute is deprecated, "contextMenu" facet should be used instead.

Sets A search expression to identify the popup component containing the context menu that will be shown on right click of any table row. Expressions are relative to this table component and must account for NamingContainers (for example, table and panelCollection are NamingContainer components). You can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will pop out of one NamingContainer (including the component itself if it is a naming container, like table) and begin search from there, ":::" will pop out of two NamingContainers and begin search from there, etc.

Parameters:

contextMenuId - the new contextMenuId value

isDisableColumnReordering

public final boolean isDisableColumnReordering()

Gets whether column reordering is disabled in the table. Column reordering is on by default.

Returns:

the new disableColumnReordering value

setDisableColumnReordering

public final void setDisableColumnReordering(boolean disableColumnReordering)

Sets whether column reordering is disabled in the table. Column reordering is on by default.

Parameters:

disableColumnReordering - the new disableColumnReordering value

isHorizontalGridVisible

public final boolean isHorizontalGridVisible()

Gets whether the Horizontal GridLines are to be drawn.

Returns:

the new horizontalGridVisible value

setHorizontalGridVisible

public final void setHorizontalGridVisible(boolean horizontalGridVisible)

Sets whether the Horizontal GridLines are to be drawn.

Parameters:

horizontalGridVisible - the new horizontalGridVisible value

isVerticalGridVisible

public final boolean isVerticalGridVisible()

Gets whether the vertical GridLines are to be drawn.

Returns:

the new verticalGridVisible value

setVerticalGridVisible

public final void setVerticalGridVisible(boolean verticalGridVisible)

Sets whether the vertical GridLines are to be drawn.

Parameters:

verticalGridVisible - the new verticalGridVisible value

getEmptyText

public final java.lang.String getEmptyText()

Gets the text of an empty table. If the text is enclosed in an open and closing html tag, it will be formatted. The formatting behavior is similar to outputFormatted component. If it is not enclosed in an open and closing html tag, it will not be formatted.

Returns:

the new emptyText value

setEmptyText

public final void setEmptyText(java.lang.String emptyText)

Sets the text of an empty table. If the text is enclosed in an open and closing html tag, it will be formatted. The formatting behavior is similar to outputFormatted component. If it is not enclosed in an open and closing html tag, it will not be formatted.

Parameters:

emptyText - the new emptyText value

getColumnBandingInterval

public final int getColumnBandingInterval()

Gets the interval between which the column banding occurs. This value controls the display of the column banding in the table. For e.g, columnBandingInterval=1 would display alternately banded columns in the Grid.

Returns:

the new columnBandingInterval value

setColumnBandingInterval

public final void setColumnBandingInterval(int columnBandingInterval)

Sets the interval between which the column banding occurs. This value controls the display of the column banding in the table. For e.g, columnBandingInterval=1 would display alternately banded columns in the Grid.

Parameters:

columnBandingInterval - the new columnBandingInterval value

getRowBandingInterval

public final int getRowBandingInterval()

Gets the interval between which the row banding occurs. This value controls the display of the row banding in the table. For e.g, rowBandingInterval=1 would display alternately banded rows in the Grid.

Returns:

the new rowBandingInterval value

setRowBandingInterval

public final void setRowBandingInterval(int rowBandingInterval)

Sets the interval between which the row banding occurs. This value controls the display of the row banding in the table. For e.g, rowBandingInterval=1 would display alternately banded rows in the Grid.

Parameters:

rowBandingInterval - the new rowBandingInterval value

getRowSelection

public final java.lang.String getRowSelection()

Gets whether rows in this table are selectable.

Returns:

the new rowSelection value

setRowSelection

public final void setRowSelection(java.lang.String rowSelection)

Sets whether rows in this table are selectable.

Parameters:

rowSelection - the new rowSelection value

getWidth

public final java.lang.String getWidth()

Gets the width of this component. Default value is 300 PX

Returns:

the new width value

setWidth

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

Sets the width of this component. Default value is 300 PX

Parameters:

width - the new width value

getSummary

public final java.lang.String getSummary()

Gets the summary of this table's purpose and structure for user agents rendering to non-visual media.

Returns:

the new summary value

setSummary

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

Sets the summary of this table's purpose and structure for user agents rendering to non-visual media.

Parameters:

summary - the new summary value

getFetchSize

public final int getFetchSize()

Gets the number of rows in the data fetch block

Returns:

the new fetchSize value

setFetchSize

public final void setFetchSize(int fetchSize)

Sets the number of rows in the data fetch block

Parameters:

fetchSize - the new fetchSize value

getDisplayRow

public final java.lang.String getDisplayRow()

Gets the row to display in the table during intial display. The possible values are "first" to display the first row, "last" to display the last row and "selected" to display the first selected row in the table. The default value for this is null which means that the first row is displayed. Please note that this API will have no effect if the total number of rows are not known from the table model (model.getRowCount()==-1).

Returns:

the new displayRow value

setDisplayRow

public final void setDisplayRow(java.lang.String displayRow)

Sets the row to display in the table during intial display. The possible values are "first" to display the first row, "last" to display the last row and "selected" to display the first selected row in the table. The default value for this is null which means that the first row is displayed. Please note that this API will have no effect if the total number of rows are not known from the table model (model.getRowCount()==-1).

Parameters:

displayRow - the new displayRow value

getDisplayRowKey

public final java.lang.Object getDisplayRowKey()

Gets the rowkey to display in the table during intial display. Specifying this attribute will override the displayRow attribute. Please note that this API will have no effect if the total number of rows are not known from the table model (model.getRowCount()==-1).

Returns:

the new displayRowKey value

setDisplayRowKey

public final void setDisplayRowKey(java.lang.Object displayRowKey)

Sets the rowkey to display in the table during intial display. Specifying this attribute will override the displayRow attribute. Please note that this API will have no effect if the total number of rows are not known from the table model (model.getRowCount()==-1).

Parameters:

displayRowKey - the new displayRowKey value

isContextMenuSelect

public final boolean isContextMenuSelect()

Gets Indicates if we should actually select the row clicked when right clicking to show a context menu. By default the row is selected before the context menu is displayed. However if contextMenuSelect="false", and if user right clicks a row, the new row is highlighted and the highlighting for the currently selected row(s) is cleared when the context menus is displayed. The highlighting of the currently selected row(s) is restored after the context menu is dismissed. It should be noted that when the context menu is displayed, the attribute selectedRowKeys still contains the selected row(s). The highlighted row key is established as a currency in the table when the action for context menu item is executed. The currency in the table can be retrieved by calling "table.getRowKey()".

Returns:

the new contextMenuSelect value

setContextMenuSelect

public final void setContextMenuSelect(boolean contextMenuSelect)

Sets Indicates if we should actually select the row clicked when right clicking to show a context menu. By default the row is selected before the context menu is displayed. However if contextMenuSelect="false", and if user right clicks a row, the new row is highlighted and the highlighting for the currently selected row(s) is cleared when the context menus is displayed. The highlighting of the currently selected row(s) is restored after the context menu is dismissed. It should be noted that when the context menu is displayed, the attribute selectedRowKeys still contains the selected row(s). The highlighted row key is established as a currency in the table when the action for context menu item is executed. The currency in the table can be retrieved by calling "table.getRowKey()".

Parameters:

contextMenuSelect - the new contextMenuSelect value

getEditingMode

public final java.lang.String getEditingMode()

Gets Indicates the mode used to edit the table when it contains editable components. The possible values are "clickToEdit" and "editAll". In "editAll" mode all the editable components are displayed at a time in the table view area. In "clickToEdit" mode a single row editable at a time. A row becomes editable by double clicking on it. If a user types F2, the currently selected row becomes editable. Typing Esc removes the user from editing mode. User can then navigate next/previous rows using tab, <shift>tab, or enter.

Returns:

the new editingMode value

setEditingMode

public final void setEditingMode(java.lang.String editingMode)

Sets Indicates the mode used to edit the table when it contains editable components. The possible values are "clickToEdit" and "editAll". In "editAll" mode all the editable components are displayed at a time in the table view area. In "clickToEdit" mode a single row editable at a time. A row becomes editable by double clicking on it. If a user types F2, the currently selected row becomes editable. Typing Esc removes the user from editing mode. User can then navigate next/previous rows using tab, <shift>tab, or enter.

Parameters:

editingMode - the new editingMode value

getScrollTop

public final int getScrollTop()

Gets private property to indicate current vertical scroll position.

Returns:

the new scrollTop value

setScrollTop

public final void setScrollTop(int scrollTop)

Sets private property to indicate current vertical scroll position.

Parameters:

scrollTop - the new scrollTop value

getScrollLeft

public final int getScrollLeft()

Gets private property to indicate current horizontal scroll position.

Returns:

the new scrollLeft value

setScrollLeft

public final void setScrollLeft(int scrollLeft)

Sets private property to indicate current horizontal scroll position.

Parameters:

scrollLeft - the new scrollLeft value

getScrollTopRowKey

public final java.lang.Object getScrollTopRowKey()

Gets private property to indicate row key for the first visible row.

Returns:

the new scrollTopRowKey value

setScrollTopRowKey

public final void setScrollTopRowKey(java.lang.Object scrollTopRowKey)

Sets private property to indicate row key for the first visible row.

Parameters:

scrollTopRowKey - the new scrollTopRowKey value

isClearTokenCacheOnPPR

public final boolean isClearTokenCacheOnPPR()

Gets private property to turn on/off the clearing of the row key token cache when the component is PPRed. Default is true

Returns:

the new clearTokenCacheOnPPR value

setClearTokenCacheOnPPR

public final void setClearTokenCacheOnPPR(boolean clearTokenCacheOnPPR)

Sets private property to turn on/off the clearing of the row key token cache when the component is PPRed. Default is true

Parameters:

clearTokenCacheOnPPR - the new clearTokenCacheOnPPR value

isExpandAllEnabled

public final boolean isExpandAllEnabled()

Gets Indicates whether the "Expand/Collapse All", and "Expand/Collapse All Below" menu items are rendered. These menu items are rendered by default.

Returns:

the new expandAllEnabled value

setExpandAllEnabled

public final void setExpandAllEnabled(boolean expandAllEnabled)

Sets Indicates whether the "Expand/Collapse All", and "Expand/Collapse All Below" menu items are rendered. These menu items are rendered by default.

Parameters:

expandAllEnabled - the new expandAllEnabled value

getContentDelivery

public final java.lang.String getContentDelivery()

Gets whether data should be fetched when the component is rendered initially. When contentDelivery is "immediate", data is fetched and inlined into the component chrome. If contentDelivery is "lazy", data will be fetched and delivered to the client during a subsequent request.

Returns:

the new contentDelivery value

setContentDelivery

public final void setContentDelivery(java.lang.String contentDelivery)

Sets whether data should be fetched when the component is rendered initially. When contentDelivery is "immediate", data is fetched and inlined into the component chrome. If contentDelivery is "lazy", data will be fetched and delivered to the client during a subsequent request.

Parameters:

contentDelivery - the new contentDelivery value

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class org.apache.myfaces.trinidad.component.UIXTreeTable

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXTreeTable

Skip navigation links