|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.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.UIXHierarchy
@JSFComponent public abstract class UIXHierarchy
Base class for components that take a TreeModel, which is a hierarchical model.
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 |
---|
Fields inherited from class org.apache.myfaces.trinidad.component.UIXCollection |
---|
TYPE, 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 | |
---|---|
protected |
UIXHierarchy()
|
protected |
UIXHierarchy(String rendererType)
Create a Page component with the given render-type |
Method Summary | |
---|---|
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)
|
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 |
---|
getVar |
Methods inherited from interface org.apache.myfaces.trinidad.model.RowKeyIndex |
---|
areRowsAvailable, areRowsAvailable, areRowsAvailable, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, 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 |
Constructor Detail |
---|
protected UIXHierarchy(String rendererType)
protected UIXHierarchy()
Method Detail |
---|
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)
TreeModel.getAllAncestorContainerRowKeys(Object)
public boolean isChildCollectionLocallyAvailable()
isChildCollectionLocallyAvailable
in interface TreeLocalRowKeyIndex
TreeModel.isChildCollectionLocallyAvailable()
public boolean isChildCollectionLocallyAvailable(int index)
isChildCollectionLocallyAvailable
in interface TreeLocalRowKeyIndex
index
- row index to check
TreeModel.isChildCollectionLocallyAvailable(int)
public boolean isChildCollectionLocallyAvailable(Object rowKey)
isChildCollectionLocallyAvailable
in interface TreeLocalRowKeyIndex
rowKey
- row key to check
TreeModel.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
availability
true
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
availability
true
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
availability
true
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)
protected final boolean visitHierarchy(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback, List<javax.faces.component.UIComponent> stamps, RowKeySet disclosedRowKeys)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |