public class UIXListView extends UIXIterator implements javax.faces.component.NamingContainer
UIXListView is a component that is similar to UIXIterator. In addition it adds support for selection and grouping. The grouping support add Tree Like functionaliy via the TreeModel class.
Type | Phases | Description |
---|---|---|
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.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.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 PropertyKey |
GROUP_DISCLOSED_ROW_KEYS_KEY |
static PropertyKey |
GROUP_DISCLOSURE_LISTENER_KEY |
static PropertyKey |
SELECTED_ROW_KEYS_KEY |
static PropertyKey |
SELECTION_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 |
---|---|
|
UIXListView()
Construct an instance of the UIXListView.
|
protected |
UIXListView(String rendererType)
Construct an instance of the UIXListView.
|
Modifier and Type | Method and Description |
---|---|
void |
addRowDisclosureListener(RowDisclosureListener listener)
Adds a rowDisclosure listener.
|
void |
addSelectionListener(SelectionListener listener)
Adds a selection listener.
|
void |
broadcast(javax.faces.event.FacesEvent event)
Delivers a wrapped event to the appropriate component.
|
protected FacesBean |
createFacesBean(String rendererType) |
void |
enterContainer()
Treats the current element as a parent element and steps into the children.
|
void |
exitContainer()
Changes the rowData to be the parent rowData.
|
List<Object> |
getAllAncestorContainerRowKeys(Object childRowKey)
Gets the all the rowKeys of the ancestors of the given child row.
|
protected FacesBean.Type |
getBeanType() |
Object |
getContainerRowKey()
Gets the rowKey of the current row's container.
|
Object |
getContainerRowKey(Object childKey)
Gets the rowKey of the given row's container.
|
int |
getDepth()
Gets the depth of the current row in this tree hierarchy
|
int |
getDepth(Object rowKey)
Gets the depth of the current row in this tree hierarchy
|
String |
getFamily() |
RowKeySet |
getGroupDisclosedRowKeys()
Gets the set of disclosed groups for this component.
|
javax.el.MethodExpression |
getGroupDisclosureListener()
Gets a method reference to a group disclosure listener
|
RowDisclosureListener[] |
getRowDisclosureListeners()
Returns an array of attached rowDisclosure listeners.
|
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.
|
boolean |
isContainer()
Checks to see if the current element is a container of other elements.
|
boolean |
isContainerEmpty()
Checks to see if the container is empty.
|
protected void |
postCreateCollectionModel(CollectionModel model)
Hook called with the result of
createCollectionModel . |
void |
queueEvent(javax.faces.event.FacesEvent event)
Sets the phaseID of UI events depending on the "immediate" property.
|
void |
removeRowDisclosureListener(RowDisclosureListener listener)
Removes a rowDisclosure listener.
|
void |
removeSelectionListener(SelectionListener listener)
Removes a selection listener.
|
void |
setGroupDisclosedRowKeys(RowKeySet groupDisclosedRowKeys)
Sets the set of disclosed groups for this component.
|
void |
setGroupDisclosureListener(javax.el.MethodExpression groupDisclosureListener)
Sets a method reference to a group disclosure listener
|
void |
setSelectedRowKeys(RowKeySet selectedRowKeys)
Sets the selection state for this component.
|
void |
setSelectionListener(javax.el.MethodExpression selectionListener)
Sets a method reference to a selection listener
|
createCollectionModel, createVarStatusMap, encodeChildren, getFirst, getRendersChildren, getRows, getValue, getVarStatus, isFlatteningChildren, processFacetsAndChildren, 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, getStamps, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processEvent, processFlattenedChildrenBegin, processRestoreState, processSaveState, processUpdates, processValidators, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setupELVariable, setupVisitingContext, setVar, tearDownVisitingContext, updateChildrenImpl, validateChildrenImpl, visitChildren, visitChildrenWithoutIterating, visitUnstampedFacets
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, decode, decodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, 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
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, isRowLocallyAvailable, isRowLocallyAvailable
public static final FacesBean.Type TYPE
public static final PropertyKey SELECTED_ROW_KEYS_KEY
public static final PropertyKey GROUP_DISCLOSED_ROW_KEYS_KEY
public static final PropertyKey SELECTION_LISTENER_KEY
public static final PropertyKey GROUP_DISCLOSURE_LISTENER_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public UIXListView()
protected UIXListView(String rendererType)
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
- a FacesEventjavax.faces.event.AbortProcessingException
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 FacesBean createFacesBean(String rendererType)
createFacesBean
in class UIXComponentBase
public final void enterContainer()
isContainer()
returns true.TreeModel.enterContainer()
public final void exitContainer()
TreeModel.exitContainer()
public final boolean isContainer()
TreeModel.isContainer()
public boolean isContainerEmpty()
TreeModel.isContainerEmpty()
public int getDepth()
TreeModel.getDepth()
public int getDepth(Object rowKey)
TreeModel.getDepth(Object)
public Object getContainerRowKey()
TreeModel.getContainerRowKey()
public Object getContainerRowKey(Object childKey)
TreeModel.getContainerRowKey(Object)
public List<Object> getAllAncestorContainerRowKeys(Object childRowKey)
public final RowKeySet getSelectedRowKeys()
public final void setSelectedRowKeys(RowKeySet selectedRowKeys)
selectedRowKeys
- the new selectedRowKeys valuepublic final RowKeySet getGroupDisclosedRowKeys()
public final void setGroupDisclosedRowKeys(RowKeySet groupDisclosedRowKeys)
groupDisclosedRowKeys
- the new groupDisclosedRowKeys valuepublic final javax.el.MethodExpression getSelectionListener()
public final void setSelectionListener(javax.el.MethodExpression selectionListener)
selectionListener
- the new selectionListener valuepublic final javax.el.MethodExpression getGroupDisclosureListener()
public final void setGroupDisclosureListener(javax.el.MethodExpression groupDisclosureListener)
groupDisclosureListener
- the new groupDisclosureListener valuepublic 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 addRowDisclosureListener(RowDisclosureListener listener)
listener
- the rowDisclosure listener to addpublic final void removeRowDisclosureListener(RowDisclosureListener listener)
listener
- the rowDisclosure listener to removepublic final RowDisclosureListener[] getRowDisclosureListeners()
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.