org.apache.myfaces.trinidad.component.core.data
Class CoreTable

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXCollection
                  extended by org.apache.myfaces.trinidad.component.UIXIterator
                      extended by org.apache.myfaces.trinidad.component.UIXTable
                          extended by org.apache.myfaces.trinidad.component.core.data.CoreTable
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, CollectionComponent, FlattenedComponent, LocalRowKeyIndex, RowKeyIndex

public class CoreTable
extends UIXTable
implements javax.faces.component.behavior.ClientBehaviorHolder

The Trinidad Table is used to display tabular data. It also supports selection (both single and multiple), sorting, record navigation and detail-disclosure.

The Trinidad Table component uses a model to access the data in the underlying list. The specific model class is org.apache.myfaces.trinidad.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 <tr:column> components. Each visible Trinidad Column component creates a separate column in the Table. For more information see the documentation for <column>

When the list being displayed by a Table is huge, you can enable the Table to break up the list into ranges and display a single range at a time. Range controls are provided on the Table to let the user scroll to the next range, or to go back to the previous range. If the total size of the list is known, a control to let the user jump directly to a particular part of the list is also provided on the Table. Use the Table attributes "rows" and "first" to control the range navigation feature. When the user changes the range, the Table fires a RangeChangeEvent.

You can configure the Table to display or hide additional details of a particular row in response to a user gesture. When the details feature is enabled, a new column containing a toggle (per row) will render in the Table. When a toggle is activated, the details for that row are displayed. When a toggle is deactivated, the details for the row are hidden. The user can also display or hide the details for all rows at the same time (the controls for this feature are enabled by setting the "allDetailsEnabled" property to true.)

To enable the details feature set the "detailStamp" facet on the Table. Place the components that are used to show the details (of a row), inside this facet. In the following example, the Person's age is displayed in the details section:

     <tr:table var="row">
       <f:facet name="detailStamp">
         <tr:outputText value="#{row.age}"/>
       </f:facet>
     </tr:table>
             

When a detail row is shown or hidden the Table generates a DisclosureEvent. If all detail rows are shown or hidden the Table fires a DisclosureAllEvent.

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 a commandButton).

There are two types of selection - single and multiple. The type of selection is determined by the "rowSelection" attribute, which can be set to "single" or "multiple".

The Table component supports sorting columns in ascending or descending order. A special 3D border on a column header lets the user know that the column is sortable. When the user clicks on a column header to sort a previously unsorted column, the Table sorts the column data in ascending order. Subsequent clicks on the same header sorts the data in the reverse 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.

     <tr:table value="...">
       <tr:column sortProperty="firstname" sortable="true">
         <f:facet name="header">
           <tr:outputText value="Firstname" />
         </f:facet>
         ...
       </tr:column>
       <tr:column sortProperty="lastname" sortable="true">
         <f:facet name="header">
           <tr:outputText value="Lastname" />
         </f:facet>
         ...
       </tr:column>
     </tr:table>
           

Banding is a technique where groups of rows (or columns) are displayed with alternating background colors. This helps to differentiate between adjacent rows (or columns).

The "banding" attribute on the Table controls the type of banding to use. The "bandingInterval" attribute controls the number of consecutive rows (or columns) that are colored the same.

Note that the above banding attributes on the Table are ignored when the "bandingShade" attribute is used on the Column.

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.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 event might include the width of a column that supported client-side resizing.


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXCollection
UIXCollection.NoColumnFacetsVisitContext
 
Nested classes/interfaces inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex
LocalRowKeyIndex.Confidence, LocalRowKeyIndex.LocalCachingStrategy
 
Field Summary
static String ACTIONS_FACET
           
static PropertyKey ALL_DETAILS_ENABLED_KEY
           
static PropertyKey AUTO_SUBMIT_KEY
           
static PropertyKey COLUMN_BANDING_INTERVAL_KEY
           
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static PropertyKey EMPTY_TEXT_KEY
           
static String FOOTER_FACET
           
static String HEADER_FACET
           
static PropertyKey HORIZONTAL_GRID_VISIBLE_KEY
           
static PropertyKey INLINE_STYLE_KEY
           
static PropertyKey ONCLICK_KEY
           
static PropertyKey ONDBLCLICK_KEY
           
static PropertyKey ONKEYDOWN_KEY
           
static PropertyKey ONKEYPRESS_KEY
           
static PropertyKey ONKEYUP_KEY
           
static PropertyKey ONMOUSEDOWN_KEY
           
static PropertyKey ONMOUSEMOVE_KEY
           
static PropertyKey ONMOUSEOUT_KEY
           
static PropertyKey ONMOUSEOVER_KEY
           
static PropertyKey ONMOUSEUP_KEY
           
static PropertyKey PARTIAL_TRIGGERS_KEY
           
static PropertyKey ROW_BANDING_INTERVAL_KEY
           
static PropertyKey ROW_SELECTION_KEY
           
static String ROW_SELECTION_MULTIPLE
           
static String ROW_SELECTION_NONE
           
static String ROW_SELECTION_SINGLE
           
static PropertyKey SHORT_DESC_KEY
           
static PropertyKey STYLE_CLASS_KEY
           
static PropertyKey SUMMARY_KEY
           
static FacesBean.Type TYPE
           
static PropertyKey VERTICAL_GRID_VISIBLE_KEY
           
static PropertyKey WIDTH_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
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
  CoreTable()
          Construct an instance of the CoreTable.
protected CoreTable(String rendererType)
          Construct an instance of the CoreTable.
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
          Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.
 javax.faces.component.UIComponent getActions()
          content to be rendered inline with the navigation bar.
protected  FacesBean.Type getBeanType()
           
 Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
          Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.
 int getColumnBandingInterval()
          Gets the interval between which the column banding alternates.
 String getDefaultEventName()
          Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.
 String getEmptyText()
          Gets text displayed when a table is empty.
 Collection<String> getEventNames()
           
 String getFamily()
           
 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.
 String getInlineStyle()
          Gets the CSS styles to use for this component.
 String getOnclick()
          Gets an onclick Javascript handler.
 String getOndblclick()
          Gets an ondblclick Javascript handler.
 String getOnkeydown()
          Gets an onkeydown Javascript handler.
 String getOnkeypress()
          Gets an onkeypress Javascript handler.
 String getOnkeyup()
          Gets an onkeyup Javascript handler.
 String getOnmousedown()
          Gets an onmousedown Javascript handler.
 String getOnmousemove()
          Gets an onmousemove Javascript handler.
 String getOnmouseout()
          Gets an onmouseout Javascript handler.
 String getOnmouseover()
          Gets an onmouseover Javascript handler.
 String getOnmouseup()
          Gets an onmouseup Javascript handler.
 String[] getPartialTriggers()
          Gets the IDs of the components that should trigger a partial update.
 int getRowBandingInterval()
          Gets the interval between which the row banding alternates.
 String getRowSelection()
          Gets whether rows in this table selectable.
 String getShortDesc()
          Gets The short description of the component.
 String getStyleClass()
          Gets a CSS style class to use for this component.
 String getSummary()
          Gets the summary of this table's purpose and structure for user agents rendering to non-visual media.
 String getWidth()
          Gets the width of the table.
 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 isAutoSubmit()
          Gets If set to TRUE on a form element, the component will automatically submit the enclosing form when an appropriate action takes place (a click, text change, etc.).
 boolean isHorizontalGridVisible()
          Gets if the horizontal grid lines will be drawn.
 boolean isVerticalGridVisible()
          Gets if the vertical grid lines will be drawn.
 void setActions(javax.faces.component.UIComponent actionsFacet)
          content to be rendered inline with the navigation bar.
 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 setAutoSubmit(boolean autoSubmit)
          Sets If set to TRUE on a form element, the component will automatically submit the enclosing form when an appropriate action takes place (a click, text change, etc.).
 void setColumnBandingInterval(int columnBandingInterval)
          Sets the interval between which the column banding alternates.
 void setEmptyText(String emptyText)
          Sets text displayed when a table is empty.
 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 if the horizontal grid lines will be drawn.
 void setInlineStyle(String inlineStyle)
          Sets the CSS styles to use for this component.
 void setOnclick(String onclick)
          Sets an onclick Javascript handler.
 void setOndblclick(String ondblclick)
          Sets an ondblclick Javascript handler.
 void setOnkeydown(String onkeydown)
          Sets an onkeydown Javascript handler.
 void setOnkeypress(String onkeypress)
          Sets an onkeypress Javascript handler.
 void setOnkeyup(String onkeyup)
          Sets an onkeyup Javascript handler.
 void setOnmousedown(String onmousedown)
          Sets an onmousedown Javascript handler.
 void setOnmousemove(String onmousemove)
          Sets an onmousemove Javascript handler.
 void setOnmouseout(String onmouseout)
          Sets an onmouseout Javascript handler.
 void setOnmouseover(String onmouseover)
          Sets an onmouseover Javascript handler.
 void setOnmouseup(String onmouseup)
          Sets an onmouseup Javascript handler.
 void setPartialTriggers(String[] partialTriggers)
          Sets the IDs of the components that should trigger a partial update.
 void setRowBandingInterval(int rowBandingInterval)
          Sets the interval between which the row banding alternates.
 void setRowSelection(String rowSelection)
          Sets whether rows in this table selectable.
 void setShortDesc(String shortDesc)
          Sets The short description of the component.
 void setStyleClass(String styleClass)
          Sets a CSS style class to use for this component.
 void setSummary(String summary)
          Sets the summary of this table's purpose and structure for user agents rendering to non-visual media.
 void setVerticalGridVisible(boolean verticalGridVisible)
          Sets if the vertical grid lines will be drawn.
 void setWidth(String width)
          Sets the width of the table.
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXTable
addRangeChangeListener, addRowDisclosureListener, addSelectionListener, addSortListener, broadcast, createCollectionModel, createFacesBean, decode, getContainerClientId, getDetailStamp, getDisclosedRowKeys, getRangeChangeListener, getRangeChangeListeners, getRowDisclosureListener, getRowDisclosureListeners, getSelectedRowData, getSelectedRowKeys, getSelectionListener, getSelectionListeners, getSortListener, getSortListeners, getStamps, isImmediate, isShowAll, postCreateCollectionModel, processFacetsAndChildren, processStamps, processUpdates, processValidators, queueEvent, removeRangeChangeListener, removeRowDisclosureListener, removeSelectionListener, removeSortListener, restoreStampState, restoreState, saveStampState, saveState, setDetailStamp, setDisclosedRowKeys, setImmediate, setRangeChangeListener, setRangeChangeListener, setRowDisclosureListener, setRowDisclosureListener, setRowIndex, setRowKey, 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, visitData
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXCollection
areRowsAvailable, areRowsAvailable, areRowsAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, decodeChildrenImpl, defaultVisitChildren, encodeBegin, encodeEnd, getCachingStrategy, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processEvent, processRestoreState, processSaveState, resetStampState, setClientRowKey, setCurrencyString, setupVisitingContext, setVar, tearDownVisitingContext, updateChildrenImpl, validateChildrenImpl, visitChildren, visitChildrenWithoutIterating, visitUnstampedFacets
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, decodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, removeAttributeChangeListener, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, validateChildren
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, visitAllChildren, visitChildren, visitTree, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, pushComponentToEL, setInView
 
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
areRowsAvailable, areRowsAvailable, areRowsAvailable, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, isRowAvailable
 
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

ROW_SELECTION_NONE

public static final String ROW_SELECTION_NONE
See Also:
Constant Field Values

ROW_SELECTION_SINGLE

public static final String ROW_SELECTION_SINGLE
See Also:
Constant Field Values

ROW_SELECTION_MULTIPLE

public static final String ROW_SELECTION_MULTIPLE
See Also:
Constant Field Values

TYPE

public static final FacesBean.Type TYPE

HORIZONTAL_GRID_VISIBLE_KEY

public static final PropertyKey HORIZONTAL_GRID_VISIBLE_KEY

VERTICAL_GRID_VISIBLE_KEY

public static final PropertyKey VERTICAL_GRID_VISIBLE_KEY

EMPTY_TEXT_KEY

public static final PropertyKey EMPTY_TEXT_KEY

COLUMN_BANDING_INTERVAL_KEY

public static final PropertyKey COLUMN_BANDING_INTERVAL_KEY

ROW_BANDING_INTERVAL_KEY

public static final PropertyKey ROW_BANDING_INTERVAL_KEY

ROW_SELECTION_KEY

public static final PropertyKey ROW_SELECTION_KEY

AUTO_SUBMIT_KEY

public static final PropertyKey AUTO_SUBMIT_KEY

WIDTH_KEY

public static final PropertyKey WIDTH_KEY

SUMMARY_KEY

public static final PropertyKey SUMMARY_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

ALL_DETAILS_ENABLED_KEY

public static final PropertyKey ALL_DETAILS_ENABLED_KEY

FOOTER_FACET

public static final String FOOTER_FACET
See Also:
Constant Field Values

HEADER_FACET

public static final String HEADER_FACET
See Also:
Constant Field Values

ACTIONS_FACET

public static final String ACTIONS_FACET
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

CoreTable

public CoreTable()
Construct an instance of the CoreTable.


CoreTable

protected CoreTable(String rendererType)
Construct an instance of the CoreTable.

Method Detail

getFooter

public final javax.faces.component.UIComponent getFooter()
the component used to render the table footer.


setFooter

public final void setFooter(javax.faces.component.UIComponent footerFacet)
the component used to render the table footer.


getHeader

public final javax.faces.component.UIComponent getHeader()
the component used to render the table header.


setHeader

public final void setHeader(javax.faces.component.UIComponent headerFacet)
the component used to render the table header.


getActions

public final javax.faces.component.UIComponent getActions()
content to be rendered inline with the navigation bar.


setActions

public final void setActions(javax.faces.component.UIComponent actionsFacet)
content to be rendered inline with the navigation bar.


isHorizontalGridVisible

public final boolean isHorizontalGridVisible()
Gets if the horizontal grid lines will be drawn.

Returns:
the new horizontalGridVisible value

setHorizontalGridVisible

public final void setHorizontalGridVisible(boolean horizontalGridVisible)
Sets if the horizontal grid lines will be drawn.

Parameters:
horizontalGridVisible - the new horizontalGridVisible value

isVerticalGridVisible

public final boolean isVerticalGridVisible()
Gets if the vertical grid lines will be drawn.

Returns:
the new verticalGridVisible value

setVerticalGridVisible

public final void setVerticalGridVisible(boolean verticalGridVisible)
Sets if the vertical grid lines will be drawn.

Parameters:
verticalGridVisible - the new verticalGridVisible value

getEmptyText

public final String getEmptyText()
Gets text displayed when a table is empty.

Returns:
the new emptyText value

setEmptyText

public final void setEmptyText(String emptyText)
Sets text displayed when a table is empty.

Parameters:
emptyText - the new emptyText value

getColumnBandingInterval

public final int getColumnBandingInterval()
Gets the interval between which the column banding alternates. For example, a columnBandingInterval of 1 would display alternately banded columns.

Returns:
the new columnBandingInterval value

setColumnBandingInterval

public final void setColumnBandingInterval(int columnBandingInterval)
Sets the interval between which the column banding alternates. For example, a columnBandingInterval of 1 would display alternately banded columns.

Parameters:
columnBandingInterval - the new columnBandingInterval value

getRowBandingInterval

public final int getRowBandingInterval()
Gets the interval between which the row banding alternates. For example, rowBandingInterval=1 would displayalternately 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 alternates. For example, rowBandingInterval=1 would displayalternately banded rows in the Grid.

Parameters:
rowBandingInterval - the new rowBandingInterval value

getRowSelection

public final String getRowSelection()
Gets whether rows in this table selectable. Valid values are "none", "single", "multiple"

Returns:
the new rowSelection value

setRowSelection

public final void setRowSelection(String rowSelection)
Sets whether rows in this table selectable. Valid values are "none", "single", "multiple"

Parameters:
rowSelection - the new rowSelection value

isAutoSubmit

public final boolean isAutoSubmit()
Gets If set to TRUE on a form element, the component will automatically submit the enclosing form when an appropriate action takes place (a click, text change, etc.). This only takes effect if rowSelection attribute enabled.

Returns:
the new autoSubmit value

setAutoSubmit

public final void setAutoSubmit(boolean autoSubmit)
Sets If set to TRUE on a form element, the component will automatically submit the enclosing form when an appropriate action takes place (a click, text change, etc.). This only takes effect if rowSelection attribute enabled.

Parameters:
autoSubmit - the new autoSubmit value

getWidth

public final String getWidth()
Gets the width of the table. The value must either be a number of pixels or a percentage - it is not a CSS width.

Returns:
the new width value

setWidth

public final void setWidth(String width)
Sets the width of the table. The value must either be a number of pixels or a percentage - it is not a CSS width.

Parameters:
width - the new width value

getSummary

public final 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(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

getInlineStyle

public final String getInlineStyle()
Gets the CSS styles to use for this component.

Returns:
the new inlineStyle value

setInlineStyle

public final void setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component.

Parameters:
inlineStyle - the new inlineStyle value

getStyleClass

public final String getStyleClass()
Gets a CSS style class to use for this component.

Returns:
the new styleClass value

setStyleClass

public final void setStyleClass(String styleClass)
Sets a CSS style class to use for this component.

Parameters:
styleClass - the new styleClass value

getShortDesc

public final String getShortDesc()
Gets The short description of the component. This text is commonly used by user agents to display tooltip help text.

Returns:
the new shortDesc value

setShortDesc

public final void setShortDesc(String shortDesc)
Sets The short description of the component. This text is commonly used by user agents to display tooltip help text.

Parameters:
shortDesc - the new shortDesc value

getPartialTriggers

public final 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.

Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"

Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".

Returns:
the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(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.

Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"

Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".

Parameters:
partialTriggers - the new partialTriggers value

getOnclick

public final String getOnclick()
Gets an onclick Javascript handler.

Returns:
the new onclick value

setOnclick

public final void setOnclick(String onclick)
Sets an onclick Javascript handler.

Parameters:
onclick - the new onclick value

getOndblclick

public final String getOndblclick()
Gets an ondblclick Javascript handler.

Returns:
the new ondblclick value

setOndblclick

public final void setOndblclick(String ondblclick)
Sets an ondblclick Javascript handler.

Parameters:
ondblclick - the new ondblclick value

getOnmousedown

public final String getOnmousedown()
Gets an onmousedown Javascript handler.

Returns:
the new onmousedown value

setOnmousedown

public final void setOnmousedown(String onmousedown)
Sets an onmousedown Javascript handler.

Parameters:
onmousedown - the new onmousedown value

getOnmouseup

public final String getOnmouseup()
Gets an onmouseup Javascript handler.

Returns:
the new onmouseup value

setOnmouseup

public final void setOnmouseup(String onmouseup)
Sets an onmouseup Javascript handler.

Parameters:
onmouseup - the new onmouseup value

getOnmouseover

public final String getOnmouseover()
Gets an onmouseover Javascript handler.

Returns:
the new onmouseover value

setOnmouseover

public final void setOnmouseover(String onmouseover)
Sets an onmouseover Javascript handler.

Parameters:
onmouseover - the new onmouseover value

getOnmousemove

public final String getOnmousemove()
Gets an onmousemove Javascript handler.

Returns:
the new onmousemove value

setOnmousemove

public final void setOnmousemove(String onmousemove)
Sets an onmousemove Javascript handler.

Parameters:
onmousemove - the new onmousemove value

getOnmouseout

public final String getOnmouseout()
Gets an onmouseout Javascript handler.

Returns:
the new onmouseout value

setOnmouseout

public final void setOnmouseout(String onmouseout)
Sets an onmouseout Javascript handler.

Parameters:
onmouseout - the new onmouseout value

getOnkeypress

public final String getOnkeypress()
Gets an onkeypress Javascript handler.

Returns:
the new onkeypress value

setOnkeypress

public final void setOnkeypress(String onkeypress)
Sets an onkeypress Javascript handler.

Parameters:
onkeypress - the new onkeypress value

getOnkeydown

public final String getOnkeydown()
Gets an onkeydown Javascript handler.

Returns:
the new onkeydown value

setOnkeydown

public final void setOnkeydown(String onkeydown)
Sets an onkeydown Javascript handler.

Parameters:
onkeydown - the new onkeydown value

getOnkeyup

public final String getOnkeyup()
Gets an onkeyup Javascript handler.

Returns:
the new onkeyup value

setOnkeyup

public final void setOnkeyup(String onkeyup)
Sets an onkeyup Javascript handler.

Parameters:
onkeyup - the new onkeyup value

isAllDetailsEnabled

public final 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. To enable the detail rows, a "detailStamp" facet must be set on this Table.

Returns:
the new allDetailsEnabled value

setAllDetailsEnabled

public final 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. To enable the detail rows, a "detailStamp" facet must be set on this Table.

Parameters:
allDetailsEnabled - the new allDetailsEnabled value

getDefaultEventName

public String getDefaultEventName()
Description copied from class: UIXComponentBase
Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.

This method must only be called by classes that implement the interface, doing otherwise will result in an exception.

Specified by:
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getDefaultEventName in class UIXComponentBase
Returns:
null
See Also:
ClientBehaviorHolder.getDefaultEventName()

getEventNames

public Collection<String> getEventNames()
Specified by:
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
Description copied from class: UIXComponentBase
Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.

This method must only be called by classes that implement the interface, doing otherwise will result in an exception.

Specified by:
getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getClientBehaviors in class UIXComponentBase
Returns:
Read-only map of the client behaviors for this component
See Also:
ClientBehaviorHolder.getClientBehaviors()

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Description copied from class: UIXComponentBase
Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.

This method must only be called by classes that implement the interface, doing otherwise will result in an exception.

Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior in class UIXComponentBase
Parameters:
eventName - The event name
behavior - The behavior to add
See Also:
ClientBehaviorHolder.addClientBehavior(String, ClientBehavior)

getFamily

public String getFamily()
Overrides:
getFamily in class UIXTable

getBeanType

protected FacesBean.Type getBeanType()
Overrides:
getBeanType in class UIXTable


Copyright © 2001-2012 The Apache Software Foundation. All Rights Reserved.