@JSFComponent public abstract class UIXHierarchy extends UIXCollection implements CollectionComponent, LocalRowKeyIndex, TreeLocalRowKeyIndex
UIXCollection.NoColumnFacetsVisitContext
UIXComponentBase.ComponentSystemEventListenerWrapper
LocalRowKeyIndex.Confidence, LocalRowKeyIndex.LocalCachingStrategy
TYPE, VAR_KEY
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
Modifier | Constructor and Description |
---|---|
protected |
UIXHierarchy() |
protected |
UIXHierarchy(String rendererType)
Create a Page component with the given render-type
|
Modifier and Type | Method and Description |
---|---|
boolean |
areRowsLocallyAvailable(int startIndex,
int rowCount,
RowKeySet disclosedRowKeys)
Check if a range of rows is locally available starting from a row index.
|
boolean |
areRowsLocallyAvailable(int rowCount,
RowKeySet disclosedRowKeys)
Check if a range of rows is locally available starting from current position.
|
boolean |
areRowsLocallyAvailable(Object startRowKey,
int rowCount,
RowKeySet disclosedRowKeys)
Check if a range of rows is locally available starting from a row key.
|
CollectionModel |
createCollectionModel(CollectionModel current,
Object value)
Creates the CollectionModel to use with this component.
|
protected Map<String,Object> |
createVarStatusMap()
Enhances the varStatusMap created by the super class to include:
"hierarchicalIndex" - returns an array containing the row indices of heirarchy of the currrent row, for e.g.
|
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.
|
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
|
int |
getFirst()
Gets the index of the first visible row in this tree
|
abstract Object |
getFocusRowKey() |
int |
getRows()
Gets the maximum number of rows that this tree should show at a time.
|
protected List<javax.faces.component.UIComponent> |
getStamps()
Gets the UIComponents that are considered stamps.
|
protected TreeModel |
getTreeModel()
Gets the TreeModel that this tree is displaying.
|
boolean |
isChildCollectionLocallyAvailable()
Indicates whether data for a child model (children of the current node) is
locally available.
|
boolean |
isChildCollectionLocallyAvailable(int index)
Indicates whether child data for the node with the given index is
locally available.
|
boolean |
isChildCollectionLocallyAvailable(Object rowKey)
Indicates whether child data for the node with the given row key is
locally available.
|
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 boolean |
visitHierarchy(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback,
List<javax.faces.component.UIComponent> stamps,
RowKeySet disclosedRowKeys) |
protected boolean |
visitLevel(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback,
List<javax.faces.component.UIComponent> stamps) |
areRowsAvailable, areRowsAvailable, areRowsAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, broadcast, 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, getValue, getVar, getVarStatus, invokeOnComponent, isRowAvailable, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postCreateCollectionModel, postRowDataChange, preRowDataChange, processComponent, processDecodes, processEvent, processFacetsAndChildren, processFlattenedChildrenBegin, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setupELVariable, setupVisitingContext, setVar, tearDownVisitingContext, updateChildrenImpl, validateChildrenImpl, visitChildren, visitChildrenWithoutIterating, visitData, visitUnstampedFacets
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBeanType, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getFamily, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getPassThroughAttributes, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, 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, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getVar
areRowsAvailable, areRowsAvailable, areRowsAvailable, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, isRowAvailable, setRowIndex, setRowKey
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, isRowLocallyAvailable, isRowLocallyAvailable
protected UIXHierarchy(String rendererType)
protected UIXHierarchy()
public CollectionModel createCollectionModel(CollectionModel current, Object value)
UIXCollection
postCreateCollectionModel
createCollectionModel
in class UIXCollection
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)
public int getFirst()
getFirst
in interface CollectionComponent
public int getRows()
getRows
in interface CollectionComponent
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 boolean isChildCollectionLocallyAvailable()
isChildCollectionLocallyAvailable
in interface TreeLocalRowKeyIndex
TreeModel.isChildCollectionLocallyAvailable()
public boolean isChildCollectionLocallyAvailable(int index)
isChildCollectionLocallyAvailable
in interface TreeLocalRowKeyIndex
index
- row index to checkTreeModel.isChildCollectionLocallyAvailable(int)
public boolean isChildCollectionLocallyAvailable(Object rowKey)
isChildCollectionLocallyAvailable
in interface TreeLocalRowKeyIndex
rowKey
- row key to checkTreeModel.isChildCollectionLocallyAvailable(Object)
public boolean areRowsLocallyAvailable(int startIndex, int rowCount, RowKeySet disclosedRowKeys)
areRowsLocallyAvailable
in interface TreeLocalRowKeyIndex
startIndex
- staring index for the rangerowCount
- number of rows in the rangedisclosedRowKeys
- set of expanded nodes which may fall within the range to check for
availabilitytrue
if range of rows is locally available flase
otherwiseTreeModel.areRowsLocallyAvailable(int, int, RowKeySet)
public boolean areRowsLocallyAvailable(Object startRowKey, int rowCount, RowKeySet disclosedRowKeys)
areRowsLocallyAvailable
in interface TreeLocalRowKeyIndex
startRowKey
- staring row key for the rangerowCount
- number of rows in the rangedisclosedRowKeys
- set of expanded nodes which may fall within the range to check for
availabilitytrue
if range of rows is locally available flase
otherwiseTreeModel.areRowsLocallyAvailable(Object, int, RowKeySet)
public boolean areRowsLocallyAvailable(int rowCount, RowKeySet disclosedRowKeys)
areRowsLocallyAvailable
in interface TreeLocalRowKeyIndex
rowCount
- number of rows in the rangedisclosedRowKeys
- set of expanded nodes which may fall within the range to check for
availabilitytrue
if range of rows is locally available flase
otherwiseTreeModel.areRowsLocallyAvailable(int , RowKeySet)
protected Map<String,Object> createVarStatusMap()
createVarStatusMap
in class UIXCollection
protected final TreeModel getTreeModel()
protected List<javax.faces.component.UIComponent> getStamps()
UIXCollection
getStamps
in class UIXCollection
public abstract Object getFocusRowKey()
protected final boolean visitLevel(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback, List<javax.faces.component.UIComponent> stamps)
Copyright © 2001-2017 The Apache Software Foundation. All Rights Reserved.