public class UIXTable extends UIXIterator implements CollectionComponent
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. |
UIXCollection.NoColumnFacetsVisitContext
UIXComponentBase.ComponentSystemEventListenerWrapper
LocalRowKeyIndex.Confidence, LocalRowKeyIndex.LocalCachingStrategy
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static String |
DETAIL_STAMP_FACET |
static PropertyKey |
DISCLOSED_ROW_KEYS_KEY |
static PropertyKey |
IMMEDIATE_KEY |
static PropertyKey |
RANGE_CHANGE_LISTENER_KEY |
static PropertyKey |
ROW_DISCLOSURE_LISTENER_KEY |
static PropertyKey |
SELECTED_ROW_KEYS_KEY |
static PropertyKey |
SELECTION_LISTENER_KEY |
static PropertyKey |
SHOW_ALL_KEY |
static PropertyKey |
SORT_LISTENER_KEY |
static FacesBean.Type |
TYPE |
FIRST_KEY, ROWS_KEY, VALUE_KEY, VAR_STATUS_KEY
VAR_KEY
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
Modifier | Constructor and Description |
---|---|
|
UIXTable()
Construct an instance of the UIXTable.
|
protected |
UIXTable(String rendererType)
Construct an instance of the UIXTable.
|
Modifier and Type | Method and Description |
---|---|
void |
addRangeChangeListener(RangeChangeListener listener)
Adds a rangeChange listener.
|
void |
addRowDisclosureListener(RowDisclosureListener listener)
Adds a rowDisclosure listener.
|
void |
addSelectionListener(SelectionListener listener)
Adds a selection listener.
|
void |
addSortListener(SortListener listener)
Adds a sort listener.
|
void |
broadcast(javax.faces.event.FacesEvent event)
Delivers an event to the appropriate listeners.
|
protected CollectionModel |
createCollectionModel(CollectionModel current,
Object value)
Creates the CollectionModel to use with this component.
|
protected FacesBean |
createFacesBean(String rendererType) |
void |
decode(javax.faces.context.FacesContext context)
Override to update the container client id cache before decode
|
protected FacesBean.Type |
getBeanType() |
String |
getContainerClientId(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent child)
Override to return clientd ids with no currency for items in header/footer facets
|
javax.faces.component.UIComponent |
getDetailStamp()
the component to stamp below every row which is disclosed.
|
RowKeySet |
getDisclosedRowKeys()
Gets the set of disclosed rows for this component.
|
String |
getFamily() |
javax.el.MethodExpression |
getRangeChangeListener()
Gets a method reference to a rangeChange listener that
will be called when a new range is selected.
|
RangeChangeListener[] |
getRangeChangeListeners()
Returns an array of attached rangeChange listeners.
|
javax.el.MethodExpression |
getRowDisclosureListener()
Gets a method reference to an ExpansionListener
|
RowDisclosureListener[] |
getRowDisclosureListeners()
Returns an array of attached rowDisclosure listeners.
|
Object |
getSelectedRowData()
Gets the data for the first selected row.
|
RowKeySet |
getSelectedRowKeys()
Gets the selection state for this component.
|
javax.el.MethodExpression |
getSelectionListener()
Gets a method reference to a selection listener
|
SelectionListener[] |
getSelectionListeners()
Returns an array of attached selection listeners.
|
javax.el.MethodExpression |
getSortListener()
Gets a method reference to a sort listener
|
SortListener[] |
getSortListeners()
Returns an array of attached sort listeners.
|
protected List<javax.faces.component.UIComponent> |
getStamps()
Gets the stamps.
|
boolean |
isImmediate()
Gets whether or not data validation - client-side or
server-side -
should take place when
events are generated by this component.
|
boolean |
isShowAll()
Gets whether the "Show All" option is selected.
|
protected void |
postCreateCollectionModel(CollectionModel model)
Hook called with the result of
createCollectionModel . |
protected void |
processFacetsAndChildren(javax.faces.context.FacesContext context,
javax.faces.event.PhaseId phaseId)
Process this component's facets and children.
|
protected void |
processStamps(javax.faces.context.FacesContext context,
javax.faces.event.PhaseId phaseId) |
void |
processUpdates(javax.faces.context.FacesContext context)
Override to update the container client id cache before updates
|
void |
processValidators(javax.faces.context.FacesContext context)
Override to update the container client id cache before validations
|
void |
queueEvent(javax.faces.event.FacesEvent event)
Sets the phaseID of UI events depending on the "immediate" property.
|
void |
removeRangeChangeListener(RangeChangeListener listener)
Removes a rangeChange listener.
|
void |
removeRowDisclosureListener(RowDisclosureListener listener)
Removes a rowDisclosure listener.
|
void |
removeSelectionListener(SelectionListener listener)
Removes a selection listener.
|
void |
removeSortListener(SortListener listener)
Removes a sort listener.
|
protected void |
restoreStampState(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent stamp,
Object stampState)
Restores the state for the given stamp.
|
void |
restoreState(javax.faces.context.FacesContext context,
Object state) |
protected Object |
saveStampState(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent stamp)
Saves the state for the given stamp.
|
Object |
saveState(javax.faces.context.FacesContext context) |
void |
setDetailStamp(javax.faces.component.UIComponent detailStampFacet)
the component to stamp below every row which is disclosed.
|
void |
setDisclosedRowKeys(RowKeySet disclosedRowKeys)
Sets the set of disclosed rows for this component.
|
void |
setImmediate(boolean immediate)
Sets whether or not data validation - client-side or
server-side -
should take place when
events are generated by this component.
|
void |
setRangeChangeListener(javax.faces.el.MethodBinding binding)
Deprecated.
|
void |
setRangeChangeListener(javax.el.MethodExpression rangeChangeListener)
Sets a method reference to a rangeChange listener that
will be called when a new range is selected.
|
void |
setRowDisclosureListener(javax.faces.el.MethodBinding binding)
Deprecated.
|
void |
setRowDisclosureListener(javax.el.MethodExpression rowDisclosureListener)
Sets a method reference to an ExpansionListener
|
void |
setRowIndex(int rowIndex)
Makes a row current.
|
void |
setRowKey(Object rowKey)
Makes a row current.
|
void |
setSelectedRowKeys(RowKeySet selectedRowKeys)
Sets the selection state for this component.
|
void |
setSelectionListener(javax.faces.el.MethodBinding binding)
Deprecated.
|
void |
setSelectionListener(javax.el.MethodExpression selectionListener)
Sets a method reference to a selection listener
|
void |
setShowAll(boolean showAll)
Sets whether the "Show All" option is selected.
|
void |
setSortCriteria(List<SortCriterion> criteria)
Sorts this collection by the given criteria.
|
void |
setSortListener(javax.faces.el.MethodBinding binding)
Deprecated.
|
void |
setSortListener(javax.el.MethodExpression sortListener)
Sets a method reference to a sort listener
|
createVarStatusMap, encodeChildren, getFirst, getRendersChildren, getRows, getValue, getVarStatus, isFlatteningChildren, processFlattenedChildren, setFirst, setRows, setValue, setVarStatus, visitData
areRowsAvailable, areRowsAvailable, areRowsAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, decodeChildrenImpl, defaultVisitChildren, encodeBegin, encodeEnd, ensureRowsAvailable, 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, processFlattenedChildrenBegin, processRestoreState, processSaveState, resetStampState, setClientRowKey, setCurrencyString, setupELVariable, setupVisitingContext, setVar, tearDownVisitingContext, updateChildrenImpl, validateChildrenImpl, visitChildren, visitChildrenWithoutIterating, visitUnstampedFacets
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, decodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getDefaultEventName, 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, removeComponentChangeFilter, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, validateChildren
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, visitAllChildren, visitChildren, visitTree, visitTree
encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getFirst, getRows, getVar
areRowsAvailable, areRowsAvailable, areRowsAvailable, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, isRowAvailable
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, isRowLocallyAvailable, isRowLocallyAvailable
public static final FacesBean.Type TYPE
public static final PropertyKey ROW_DISCLOSURE_LISTENER_KEY
public static final PropertyKey DISCLOSED_ROW_KEYS_KEY
public static final PropertyKey SELECTION_LISTENER_KEY
public static final PropertyKey SELECTED_ROW_KEYS_KEY
public static final PropertyKey IMMEDIATE_KEY
public static final PropertyKey SORT_LISTENER_KEY
public static final PropertyKey RANGE_CHANGE_LISTENER_KEY
public static final PropertyKey SHOW_ALL_KEY
public static final String DETAIL_STAMP_FACET
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public UIXTable()
protected UIXTable(String rendererType)
public void decode(javax.faces.context.FacesContext context)
decode
in class UIXComponentBase
public void processValidators(javax.faces.context.FacesContext context)
processValidators
in class UIXCollection
public void processUpdates(javax.faces.context.FacesContext context)
processUpdates
in class UIXCollection
public String getContainerClientId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent child)
getContainerClientId
in class UIXComponentBase
UIXComponentBase.getClientId(FacesContext context)
public void setSortCriteria(List<SortCriterion> criteria)
UIXCollection
setSortCriteria
in class UIXCollection
criteria
- Each element in this List must be of type SortCriterion.SortCriterion
,
CollectionModel.setSortCriteria(java.util.List<org.apache.myfaces.trinidad.model.SortCriterion>)
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class UIXCollection
event
- a FacesEventpublic void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class UIXCollection
event
- javax.faces.event.AbortProcessingException
@Deprecated public void setRangeChangeListener(javax.faces.el.MethodBinding binding)
@Deprecated public void setSortListener(javax.faces.el.MethodBinding binding)
@Deprecated public void setRowDisclosureListener(javax.faces.el.MethodBinding binding)
@Deprecated public void setSelectionListener(javax.faces.el.MethodBinding binding)
public Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class UIXCollection
public void restoreState(javax.faces.context.FacesContext context, Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class UIXCollection
public Object getSelectedRowData()
protected void processFacetsAndChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
UIXCollection
UIXCollection.processComponent(javax.faces.context.FacesContext, javax.faces.component.UIComponent, javax.faces.event.PhaseId)
as many times as necessary for each facet and child.
UIXCollection.processComponent(javax.faces.context.FacesContext, javax.faces.component.UIComponent, javax.faces.event.PhaseId)
may be called repeatedly for the same child if that child is
being stamped.processFacetsAndChildren
in class UIXIterator
protected final List<javax.faces.component.UIComponent> getStamps()
getStamps
in class UIXCollection
protected final Object saveStampState(javax.faces.context.FacesContext context, javax.faces.component.UIComponent stamp)
saveStampState
in class UIXCollection
protected final void restoreStampState(javax.faces.context.FacesContext context, javax.faces.component.UIComponent stamp, Object stampState)
restoreStampState
in class UIXCollection
protected final CollectionModel createCollectionModel(CollectionModel current, Object value)
UIXCollection
postCreateCollectionModel
createCollectionModel
in class UIXIterator
current
- the current CollectionModel, or null if there is none.value
- this is the value returned from UIXCollection.getValue()
UIXCollection.postCreateCollectionModel(org.apache.myfaces.trinidad.model.CollectionModel)
protected void postCreateCollectionModel(CollectionModel model)
UIXCollection
createCollectionModel
.
Subclasses can use this method to perform initialization after the CollectionModel
is fully initialized.
Subclassers should call super before accessing any component state to ensure
that superclass initialization has been performed.postCreateCollectionModel
in class UIXCollection
model
- The model instance returned by
UIXCollection.createCollectionModel(org.apache.myfaces.trinidad.model.CollectionModel, java.lang.Object)
protected void processStamps(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
protected FacesBean createFacesBean(String rendererType)
createFacesBean
in class UIXComponentBase
public void setRowKey(Object rowKey)
UIXCollection
UIXCollection.preRowDataChange()
and
UIXCollection.postRowDataChange()
as appropriate.setRowKey
in interface RowKeyIndex
setRowKey
in class UIXCollection
rowKey
- The rowKey of the row that should be made current. Use null
to clear the current row.CollectionModel.setRowKey(java.lang.Object)
public void setRowIndex(int rowIndex)
UIXCollection
UIXCollection.preRowDataChange()
and
UIXCollection.postRowDataChange()
as appropriate.setRowIndex
in interface RowKeyIndex
setRowIndex
in class UIXCollection
rowIndex
- The rowIndex of the row that should be made current. Use -1
to clear the current row.DataModel.setRowIndex(int)
public final javax.faces.component.UIComponent getDetailStamp()
public final void setDetailStamp(javax.faces.component.UIComponent detailStampFacet)
public final javax.el.MethodExpression getRowDisclosureListener()
public final void setRowDisclosureListener(javax.el.MethodExpression rowDisclosureListener)
rowDisclosureListener
- the new rowDisclosureListener valuepublic final RowKeySet getDisclosedRowKeys()
public final void setDisclosedRowKeys(RowKeySet disclosedRowKeys)
disclosedRowKeys
- the new disclosedRowKeys valuepublic final javax.el.MethodExpression getSelectionListener()
public final void setSelectionListener(javax.el.MethodExpression selectionListener)
selectionListener
- the new selectionListener valuepublic final RowKeySet getSelectedRowKeys()
public final void setSelectedRowKeys(RowKeySet selectedRowKeys)
selectedRowKeys
- the new selectedRowKeys valuepublic final boolean isImmediate()
public final void setImmediate(boolean immediate)
immediate
- the new immediate valuepublic final javax.el.MethodExpression getSortListener()
public final void setSortListener(javax.el.MethodExpression sortListener)
sortListener
- the new sortListener valuepublic final javax.el.MethodExpression getRangeChangeListener()
public final void setRangeChangeListener(javax.el.MethodExpression rangeChangeListener)
rangeChangeListener
- the new rangeChangeListener valuepublic final boolean isShowAll()
public final void setShowAll(boolean showAll)
showAll
- the new showAll valuepublic final void addRowDisclosureListener(RowDisclosureListener listener)
listener
- the rowDisclosure listener to addpublic final void removeRowDisclosureListener(RowDisclosureListener listener)
listener
- the rowDisclosure listener to removepublic final RowDisclosureListener[] getRowDisclosureListeners()
public final void addSelectionListener(SelectionListener listener)
listener
- the selection listener to addpublic final void removeSelectionListener(SelectionListener listener)
listener
- the selection listener to removepublic final SelectionListener[] getSelectionListeners()
public final void addRangeChangeListener(RangeChangeListener listener)
listener
- the rangeChange listener to addpublic final void removeRangeChangeListener(RangeChangeListener listener)
listener
- the rangeChange listener to removepublic final RangeChangeListener[] getRangeChangeListeners()
public final void addSortListener(SortListener listener)
listener
- the sort listener to addpublic final void removeSortListener(SortListener listener)
listener
- the sort listener to removepublic final SortListener[] getSortListeners()
public String getFamily()
getFamily
in class UIXIterator
protected FacesBean.Type getBeanType()
getBeanType
in class UIXIterator
Copyright © 2001-2017 The Apache Software Foundation. All Rights Reserved.