|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.UIXIterator
org.apache.myfaces.trinidad.component.UIXTable
oracle.adf.view.rich.component.UIXTable
oracle.adf.view.rich.component.rich.data.RichTable
public class RichTable
The Table is used to display tabular data. It also supports row/column selection (both single and multiple), sorting, record navigation.
The Table component uses a model to access the data in the underlying list. The specific model class is oracle.adf.view.rich.model.CollectionModel
. You may also use other model instances, e.g., java.util.List
, array, and javax.faces.model.DataModel
. The Table will automatically convert the instance into a CollectionModel.
The immediate children of a Table component must all be <af:column>
components. Each visibleColumn component creates a separate column in the Table. For more information see the documentation for <column>
Use the "header" facet on a Column to create the column header. You can also use the "headerText" attribute to set the column header text.
Use the "detailStamp" facet on the Table to include a collapsable content area for each table row. Please note that the height of the open detail area will be a set height based on the height of the detailStamp component. Adding a component that changes in height (like showDetail or panelBox) will by default produce strange results when the detailStamp component's height changes.
The selection feature of a Table lets the user select one or more rows in the list. The user can then perform some operation on the selected rows by activating an appropriate ActionSource component (e.g., by clicking on an CommandButton). Use the "rowselection" attribute on the Table to enable the selection feature.
By default, the table draws both horizontal and vertical grid lines. These may be independently turned off by setting the "horizontalGridVisible" and/or "verticalGridVisible" attributes to "false".
Banding is a technique where groups of rows (or columns) are displayed with alternating background colors. This helps to differentiate between adjacent groups of rows (or columns).
The "rowBandingInterval" attribute on the Table controls how many consecutive rows form a row group (for the purposes of banding). If this is "0" all rows will have the same background color. If this is a positive number then adjacent row groups will have different background colors.
The "columnBandingInterval" attribute on the Table controls how many columns form a column group (for the purposes of banding). If this is "0" all columns will have the same background color. If this is a positive number then adjacent column groups will have different background colors.
<af:column>
tags can be nested to produce groups of columns. The header of a column group spans across all the columns it contains.
The Table component supports sorting columns in ascending or descending order. The table displays up/down arrow icons in the column header for sortable columns. Clicking on the up arrow sorts the column in ascending order. Clicking on the down arrow sorts the column in descending order. The ctrl+shift+up-arrow/down-arrow shortcut keys are also available to sort a column in ascending/descending order using the keyboard. The table shows a previously sorted column with a filled-in up/down arrow icon to indicate the ascending/descending sort order.
There are three requirements to enable sorting: the underlying table model must support sorting, the "sortProperty" and "sortable" attributes must be set on the column to enable the sort capability for that column.
To support sorting, the CollectionModel
instance must implement the following methods:
public boolean isSortable(String propertyName) public void setSortCriteria(List criteria) public List getSortCriteria()
If the underlying model is not a CollectionModel
, the Table automatically examines the actual data to determine which properties are sortable. Any column that has data that implements java.lang.Comparable
is sortable. This automatic support cannot be nearly as efficient as coding sorting directly into a CollectionModel
(for instance, by translating the sort into an "ORDER BY" SQL clause), but is sufficient for small data sets.
To associate a column with a particular property-name to be used for sorting purposes, use the "sortProperty" attribute on the column. To enable the UI for sorting a particular column, set the "sortable" property to true
. For more information see the documentation for <column>
.
In the following example, both columns are sortable. Sorting the first column sorts by the "firstname" property; sorting the second column sorts by the "lastname" property.
<af:table ...> <af:column sortProperty="firstname" sortable="true"> <f:facet name="header"> <af:outputText value="Firstname" /> </f:facet> ... </af:column> <af:column> <f:facet name="header" sortProperty="lastname" sortable="true"> <af:outputText value="Lastname" /> </f:facet> ... </af:column> </af:table>
The table/treeTable and tree components are virtualized. This means that not all the rows that are available for the component on the server are fetched and displayed on the client. The number of rows that are displayed on the client are just enough to fill the viewport. More rows are fetched as the user scrolls the component vertically.
"fetchSize" is the number of rows requested from the client to the server on each attempt to fill the component. So if the height of the table is small, the fetch size of 25 is sufficient to fill the component. However if the height of the component is large, there might be a need to request the data multiple times from the server. For example, if the height of the table is 600px and height of each row is 18px. You need at least 45 rows to fill the table. With a fetchSize of 25 the table has to make a request to the server 2 times to fill the table. So it is appropriate to set the fetchSize to 50.
"width:auto" inside inline style or style class is not supported.
"width" attribute value should not be "auto".
Examples of the "width" attribute: width="700" for 700 pixels, or width="100%" to fill up the entire width of the container. If no value is defined then the default will be 300 px.
The "rows" attribute is not currently supported for the rich renderer kit. Use inlineStyle to set the height of a table.
<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>
Type | Phases | Description |
---|---|---|
oracle.adf.view.rich.event.ColumnSelectionEvent |
Invoke Application | The ColumnSelectionEvent is delivered when a column selection change occurs in Table or TreeTable. |
oracle.adf.view.rich.event.QueryEvent |
Invoke Application | The Query event is delivered when a query action is triggered. |
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.RangeChangeEvent |
Apply Request Values Invoke Application |
The range change event is delivered when the user navigates. |
org.apache.myfaces.trinidad.event.SortEvent |
Apply Request Values Invoke Application |
The sort event is delivered when the table column sort criteria is changed. |
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. |
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex |
---|
org.apache.myfaces.trinidad.model.LocalRowKeyIndex.Confidence, org.apache.myfaces.trinidad.model.LocalRowKeyIndex.LocalCachingStrategy |
Field Summary | |
---|---|
static org.apache.myfaces.trinidad.bean.PropertyKey |
ACTIVE_ROW_KEY_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
ALL_DETAILS_ENABLED_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
AUTO_HEIGHT_ROWS_KEY |
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 java.lang.String |
COLUMN_RESIZING_DISABLED |
static java.lang.String |
COLUMN_RESIZING_ENABLED |
static org.apache.myfaces.trinidad.bean.PropertyKey |
COLUMN_RESIZING_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
COLUMN_SELECTION_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
COLUMN_SELECTION_LISTENER_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 |
CONTENT_DELIVERY_WHEN_AVAILABLE |
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 org.apache.myfaces.trinidad.bean.PropertyKey |
DONT_PERSIST_KEY |
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 |
FETCH_SIZE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
FILTER_VISIBLE_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 org.apache.myfaces.trinidad.bean.PropertyKey |
PERSIST_KEY |
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 oracle.adf.view.rich.component.UIXTable |
---|
FILTER_MODEL_KEY, QUERY_LISTENER_KEY |
Fields inherited from class org.apache.myfaces.trinidad.component.UIXTable |
---|
DETAIL_STAMP_FACET, DISCLOSED_ROW_KEYS_KEY, IMMEDIATE_KEY, RANGE_CHANGE_LISTENER_KEY, ROW_DISCLOSURE_LISTENER_KEY, SELECTED_ROW_KEYS_KEY, SELECTION_LISTENER_KEY, SHOW_ALL_KEY, SORT_LISTENER_KEY |
Fields inherited from class org.apache.myfaces.trinidad.component.UIXIterator |
---|
FIRST_KEY, ROWS_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 | |
---|---|
|
RichTable() Construct an instance of the RichTable. |
protected |
RichTable(java.lang.String rendererType) Construct an instance of the RichTable. |
Method Summary | |
---|---|
void |
addColumnSelectionListener(ColumnSelectionListener listener) Adds a columnSelection listener. |
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. |
java.lang.Object |
getActiveRowKey() Gets this is the row that is currently active on the client. |
int |
getAutoHeightRows() Gets |
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 |
getColumnResizing() Gets Setting this value to "disabled" will turn off user column resizing. |
java.lang.String |
getColumnSelection() Gets whether columns in this table are selectable. |
javax.el.MethodExpression |
getColumnSelectionListener() Gets a method reference to a ColumnSelectionListener |
ColumnSelectionListener[] |
getColumnSelectionListeners() Returns an array of attached columnSelection listeners. |
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[] |
getDontPersist() Gets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
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. |
java.lang.String[] |
getPersist() Gets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
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.util.Collection<java.lang.String> |
getSelectedColumns() Returns selected child columns by clientId. |
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 |
isAllDetailsEnabled() Gets whether or not to enable the show/hide all links above the table, which allow the user to show/hide all the detail rows. |
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 |
isFilterVisible() Gets whether the filter fields are displayed on the top of the table. |
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 |
removeColumnSelectionListener(ColumnSelectionListener listener) Removes a columnSelection listener. |
void |
setActiveRowKey(java.lang.Object activeRowKey) Sets this is the row that is currently active on the client. |
void |
setAllDetailsEnabled(boolean allDetailsEnabled) Sets whether or not to enable the show/hide all links above the table, which allow the user to show/hide all the detail rows. |
void |
setAutoHeightRows(int autoHeightRows) Sets |
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 |
setColumnResizing(java.lang.String columnResizing) Sets Setting this value to "disabled" will turn off user column resizing. |
void |
setColumnSelection(java.lang.String columnSelection) Sets whether columns in this table are selectable. |
void |
setColumnSelectionListener(javax.el.MethodExpression columnSelectionListener) Sets a method reference to a ColumnSelectionListener |
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 |
setDontPersist(java.lang.String[] dontPersist) Sets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
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 |
setFetchSize(int fetchSize) Sets the number of rows in the data fetch block |
void |
setFilterVisible(boolean filterVisible) Sets whether the filter fields are displayed on the top of the table. |
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 |
setPersist(java.lang.String[] persist) Sets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. |
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 oracle.adf.view.rich.component.UIXTable |
---|
__decodeChildrenImpl, __updateChildrenImpl, __validateChildrenImpl, addQueryListener, getFilterModel, getQueryListener, getQueryListeners, processStamps, removeQueryListener, setFilterModel, setQueryListener |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXTable |
---|
addRangeChangeListener, addRowDisclosureListener, addSelectionListener, addSortListener, createCollectionModel, createFacesBean, decode, getContainerClientId, getDetailStamp, getDisclosedRowKeys, getRangeChangeListener, getRangeChangeListeners, getRowDisclosureListener, getRowDisclosureListeners, getSelectedRowData, getSelectedRowKeys, getSelectionListener, getSelectionListeners, getSortListener, getSortListeners, getStamps, isImmediate, isShowAll, postCreateCollectionModel, processFacetsAndChildren, processUpdates, processValidators, queueEvent, removeRangeChangeListener, removeRowDisclosureListener, removeSelectionListener, removeSortListener, restoreStampState, restoreState, saveStampState, saveState, setDetailStamp, setDisclosedRowKeys, setImmediate, setRangeChangeListener, setRangeChangeListener, setRowDisclosureListener, setRowDisclosureListener, setSelectedRowKeys, setSelectionListener, setSelectionListener, setShowAll, setSortCriteria, setSortListener, setSortListener |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXIterator |
---|
createVarStatusMap, encodeChildren, getFirst, getRendersChildren, getRows, getValue, getVarStatus, isFlatteningChildren, processFlattenedChildren, setFirst, setRows, setValue, setVarStatus, visitTree |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXCollection |
---|
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, decodeChildrenImpl, encodeBegin, encodeEnd, getCachingStrategy, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, resetStampState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setVar, updateChildrenImpl, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, decodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, removeAttributeChangeListener, removeFacesListener, satisfiesPartialTrigger, 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 |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll |
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 |
---|
getFirst, getRows, getVar |
Methods inherited from interface org.apache.myfaces.trinidad.model.RowKeyIndex |
---|
getRowCount, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, setRowIndex, setRowKey |
Methods inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex |
---|
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, isRowLocallyAvailable, isRowLocallyAvailable |
Field Detail |
---|
public static final java.lang.String COLUMN_SELECTION_NONE
public static final java.lang.String COLUMN_SELECTION_SINGLE
public static final java.lang.String COLUMN_SELECTION_MULTIPLE
public static final java.lang.String COLUMN_RESIZING_ENABLED
public static final java.lang.String COLUMN_RESIZING_DISABLED
public static final java.lang.String ROW_SELECTION_NONE
public static final java.lang.String ROW_SELECTION_SINGLE
public static final java.lang.String ROW_SELECTION_MULTIPLE
public static final java.lang.String ROW_SELECTION_MULTIPLE_NO_SELECT_ALL
public static final java.lang.String DISPLAY_ROW_FIRST
public static final java.lang.String DISPLAY_ROW_LAST
public static final java.lang.String DISPLAY_ROW_SELECTED
public static final java.lang.String EDITING_MODE_EDIT_ALL
public static final java.lang.String EDITING_MODE_CLICK_TO_EDIT
public static final java.lang.String CONTENT_DELIVERY_IMMEDIATE
public static final java.lang.String CONTENT_DELIVERY_LAZY
public static final java.lang.String CONTENT_DELIVERY_WHEN_AVAILABLE
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey BODY_CONTEXT_MENU_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_SELECTION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_STRETCHING_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_RESIZING_KEY
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTEXT_MENU_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLE_COLUMN_REORDERING_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HORIZONTAL_GRID_VISIBLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VERTICAL_GRID_VISIBLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey EMPTY_TEXT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_BANDING_INTERVAL_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_BANDING_INTERVAL_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_SELECTION_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey WIDTH_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SUMMARY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey FETCH_SIZE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_ROW_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_ROW_KEY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ACTIVE_ROW_KEY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTEXT_MENU_SELECT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey EDITING_MODE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SCROLL_TOP_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SCROLL_LEFT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SCROLL_TOP_ROW_KEY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLEAR_TOKEN_CACHE_ON_PPR_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey AUTO_HEIGHT_ROWS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PERSIST_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DONT_PERSIST_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ALL_DETAILS_ENABLED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey FILTER_VISIBLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_SELECTION_LISTENER_KEY
public static final java.lang.String FOOTER_FACET
public static final java.lang.String HEADER_FACET
public static final java.lang.String CONTEXT_MENU_FACET
public static final java.lang.String BODY_CONTEXT_MENU_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichTable()
protected RichTable(java.lang.String rendererType)
Method Detail |
---|
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class UIXTable
javax.faces.event.AbortProcessingException
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)
DragSourceFactory
null
if no DragSource should be attached.createDragSource
in interface DragSourceFactory
name
- refers to a named DragSource; "default" refers to the default DragSourceallowedActions
- Set of DnDAction
supported by the DragSource.defaultAction
- Default drag and drop action supported by this drag sourcediscriminant
- 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 futurepublic 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)
DragSourceFactory
createDragSourceBehavior
in interface DragSourceFactory
name
- refers to a named DragSource; "default" refers to the default DragSourcedragSource
- DragSource to create clientDragSource initializer for.allowedActions
- Set of DnDAction
supported by the DragSource.defaultAction
- Default drag and drop action supported by this drag sourcediscriminant
- 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 futurepublic java.util.Collection<java.lang.String> getSelectedColumns()
public final javax.faces.component.UIComponent getFooter()
public final void setFooter(javax.faces.component.UIComponent footerFacet)
public final javax.faces.component.UIComponent getHeader()
public final void setHeader(javax.faces.component.UIComponent headerFacet)
public final javax.faces.component.UIComponent getContextMenu()
public final void setContextMenu(javax.faces.component.UIComponent contextMenuFacet)
public final javax.faces.component.UIComponent getBodyContextMenu()
public final void setBodyContextMenu(javax.faces.component.UIComponent bodyContextMenuFacet)
public final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners value
@Deprecated
public final java.lang.String getBodyContextMenuId()
@Deprecated
public final void setBodyContextMenuId(java.lang.String bodyContextMenuId)
bodyContextMenuId
- the new bodyContextMenuId valuepublic final java.lang.String getColumnSelection()
public final void setColumnSelection(java.lang.String columnSelection)
columnSelection
- the new columnSelection valuepublic final java.lang.String getColumnStretching()
public final void setColumnStretching(java.lang.String columnStretching)
columnStretching
- the new columnStretching valuepublic final java.lang.String getColumnResizing()
public final void setColumnResizing(java.lang.String columnResizing)
columnResizing
- the new columnResizing value
@Deprecated
public final java.lang.String getContextMenuId()
@Deprecated
public final void setContextMenuId(java.lang.String contextMenuId)
contextMenuId
- the new contextMenuId valuepublic final boolean isDisableColumnReordering()
public final void setDisableColumnReordering(boolean disableColumnReordering)
disableColumnReordering
- the new disableColumnReordering valuepublic final boolean isHorizontalGridVisible()
public final void setHorizontalGridVisible(boolean horizontalGridVisible)
horizontalGridVisible
- the new horizontalGridVisible valuepublic final boolean isVerticalGridVisible()
public final void setVerticalGridVisible(boolean verticalGridVisible)
verticalGridVisible
- the new verticalGridVisible valuepublic final java.lang.String getEmptyText()
public final void setEmptyText(java.lang.String emptyText)
emptyText
- the new emptyText valuepublic final int getColumnBandingInterval()
public final void setColumnBandingInterval(int columnBandingInterval)
columnBandingInterval
- the new columnBandingInterval valuepublic final int getRowBandingInterval()
public final void setRowBandingInterval(int rowBandingInterval)
rowBandingInterval
- the new rowBandingInterval valuepublic final java.lang.String getRowSelection()
public final void setRowSelection(java.lang.String rowSelection)
rowSelection
- the new rowSelection valuepublic final java.lang.String getWidth()
public final void setWidth(java.lang.String width)
width
- the new width valuepublic final java.lang.String getSummary()
public final void setSummary(java.lang.String summary)
summary
- the new summary valuepublic final int getFetchSize()
public final void setFetchSize(int fetchSize)
fetchSize
- the new fetchSize valuepublic final java.lang.String getDisplayRow()
public final void setDisplayRow(java.lang.String displayRow)
displayRow
- the new displayRow valuepublic final java.lang.Object getDisplayRowKey()
public final void setDisplayRowKey(java.lang.Object displayRowKey)
displayRowKey
- the new displayRowKey valuepublic final java.lang.Object getActiveRowKey()
public final void setActiveRowKey(java.lang.Object activeRowKey)
activeRowKey
- the new activeRowKey valuepublic final boolean isContextMenuSelect()
public final void setContextMenuSelect(boolean contextMenuSelect)
contextMenuSelect
- the new contextMenuSelect valuepublic final java.lang.String getEditingMode()
public final void setEditingMode(java.lang.String editingMode)
editingMode
- the new editingMode valuepublic final int getScrollTop()
public final void setScrollTop(int scrollTop)
scrollTop
- the new scrollTop valuepublic final int getScrollLeft()
public final void setScrollLeft(int scrollLeft)
scrollLeft
- the new scrollLeft valuepublic final java.lang.Object getScrollTopRowKey()
public final void setScrollTopRowKey(java.lang.Object scrollTopRowKey)
scrollTopRowKey
- the new scrollTopRowKey valuepublic final java.lang.String getContentDelivery()
public final void setContentDelivery(java.lang.String contentDelivery)
contentDelivery
- the new contentDelivery valuepublic final boolean isClearTokenCacheOnPPR()
public final void setClearTokenCacheOnPPR(boolean clearTokenCacheOnPPR)
clearTokenCacheOnPPR
- the new clearTokenCacheOnPPR valuepublic final int getAutoHeightRows()
The number of rows used to size the component height. The default value is -1 (no auto-sizing for any number of rows).
public final void setAutoHeightRows(int autoHeightRows)
The number of rows used to size the component height. The default value is -1 (no auto-sizing for any number of rows).
autoHeightRows
- the new autoHeightRows valuepublic final java.lang.String[] getPersist()
public final void setPersist(java.lang.String[] persist)
persist
- the new persist valuepublic final java.lang.String[] getDontPersist()
public final void setDontPersist(java.lang.String[] dontPersist)
dontPersist
- the new dontPersist valuepublic final boolean isAllDetailsEnabled()
public final void setAllDetailsEnabled(boolean allDetailsEnabled)
allDetailsEnabled
- the new allDetailsEnabled valuepublic final boolean isFilterVisible()
public final void setFilterVisible(boolean filterVisible)
filterVisible
- the new filterVisible valuepublic final javax.el.MethodExpression getColumnSelectionListener()
public final void setColumnSelectionListener(javax.el.MethodExpression columnSelectionListener)
columnSelectionListener
- the new columnSelectionListener valuepublic final void addColumnSelectionListener(ColumnSelectionListener listener)
listener
- the columnSelection listener to addpublic final void removeColumnSelectionListener(ColumnSelectionListener listener)
listener
- the columnSelection listener to removepublic final ColumnSelectionListener[] getColumnSelectionListeners()
public java.lang.String getFamily()
getFamily
in class UIXTable
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class UIXTable
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |