|
||||||||||
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
org.apache.myfaces.trinidad.component.UIXNavigationHierarchy
org.apache.myfaces.trinidad.component.UIXNavigationTree
public class UIXNavigationTree
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.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 |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
static PropertyKey |
DISCLOSED_ROW_KEYS_KEY
|
static PropertyKey |
IMMEDIATE_KEY
|
static String |
NODE_STAMP_FACET
|
static PropertyKey |
ROW_DISCLOSURE_LISTENER_KEY
|
static PropertyKey |
START_LEVEL_KEY
|
static FacesBean.Type |
TYPE
|
static PropertyKey |
VALUE_KEY
|
static PropertyKey |
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 | |
---|---|
|
UIXNavigationTree()
Construct an instance of the UIXNavigationTree. |
protected |
UIXNavigationTree(String rendererType)
Construct an instance of the UIXNavigationTree. |
Method Summary | |
---|---|
void |
addRowDisclosureListener(RowDisclosureListener listener)
Adds a rowDisclosure listener. |
void |
broadcast(javax.faces.event.FacesEvent event)
Delivers an event. |
CollectionModel |
createCollectionModel(CollectionModel current,
Object value)
Creates the CollectionModel to use with this component. |
protected FacesBean |
createFacesBean(String rendererType)
|
protected FacesBean.Type |
getBeanType()
|
RowKeySet |
getDisclosedRowKeys()
Gets the set of disclosed rows for this component. |
String |
getFamily()
|
javax.faces.component.UIComponent |
getNodeStamp()
the component to use to stamp each element in the tree. |
javax.el.MethodExpression |
getRowDisclosureListener()
Gets a method reference to an ExpansionListener |
RowDisclosureListener[] |
getRowDisclosureListeners()
Returns an array of attached rowDisclosure listeners. |
int |
getStartLevel()
Gets the starting level, based on a 0 based index, in the menuModel to render based on the focusPath of the menuModel. |
Object |
getValue()
Gets the hierarchy of tree data - must be of type org.apache.myfaces.trinidad.model.MenuModel |
String |
getVarStatus()
Gets Name of the EL variable used to reference the varStatus information. |
boolean |
isImmediate()
Gets whether data validation should be skipped when row disclosure events are generated by this component. |
protected void |
processFacetsAndChildren(javax.faces.context.FacesContext context,
javax.faces.event.PhaseId phaseId)
Process this component's facets and children. |
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 |
setDisclosedRowKeys(RowKeySet disclosedRowKeys)
Sets the set of disclosed rows for this component. |
void |
setImmediate(boolean immediate)
Sets whether data validation should be skipped when row disclosure events are generated by this component. |
void |
setNodeStamp(javax.faces.component.UIComponent nodeStampFacet)
the component to use to stamp each element in the tree. |
void |
setRowDisclosureListener(javax.el.MethodExpression rowDisclosureListener)
Sets a method reference to an ExpansionListener |
void |
setStartLevel(int startLevel)
Sets the starting level, based on a 0 based index, in the menuModel to render based on the focusPath of the menuModel. |
void |
setValue(Object value)
Sets the hierarchy of tree data - must be of type org.apache.myfaces.trinidad.model.MenuModel |
void |
setVarStatus(String varStatus)
Sets Name of the EL variable used to reference the varStatus information. |
protected boolean |
visitChildren(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback)
Override default children visiting code to visit the facets and facets of the columns before delegating to the visitData to visit the individual rows of data. |
protected boolean |
visitData(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback)
Visit the rows and children of the columns of the collection per row-index. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXNavigationHierarchy |
---|
getFocusRowKey, getMenuModel |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXHierarchy |
---|
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, createVarStatusMap, enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getFirst, getRows, getStamps, getTreeModel, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isContainer, isContainerEmpty, visitHierarchy, visitLevel |
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 |
Field Detail |
---|
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 VALUE_KEY
public static final PropertyKey START_LEVEL_KEY
public static final PropertyKey VAR_STATUS_KEY
public static final PropertyKey IMMEDIATE_KEY
public static final String NODE_STAMP_FACET
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
Constructor Detail |
---|
public UIXNavigationTree()
protected UIXNavigationTree(String rendererType)
Method Detail |
---|
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
public CollectionModel createCollectionModel(CollectionModel current, Object value)
UIXCollection
postCreateCollectionModel
createCollectionModel
in class UIXNavigationHierarchy
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 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 UIXCollection
protected boolean visitChildren(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback)
UIXCollection
Override default children visiting code to visit the facets and facets of the columns
before delegating to the visitData
to visit the individual rows of data.
Subclasses should override this method if they wish to change the way in which the non-stamped
children are visited. If they wish to change the wash the the stamped children are visited,
they should override visitData
instead.
visitChildren
in class UIXCollection
visitContext
- the VisitContext
for this visitcallback
- the VisitCallback
instance
true
if all of the children to visit have been visitedUIXCollection.visitData(javax.faces.component.visit.VisitContext, javax.faces.component.visit.VisitCallback)
protected boolean visitData(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback)
UIXCollection
visitData
in class UIXCollection
visitContext
- The visiting contextcallback
- The visit callback
UIXCollection.visitChildren(VisitContext, VisitCallback)
protected FacesBean createFacesBean(String rendererType)
createFacesBean
in class UIXComponentBase
public final javax.faces.component.UIComponent getNodeStamp()
public final void setNodeStamp(javax.faces.component.UIComponent nodeStampFacet)
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 Object getValue()
getValue
in class UIXCollection
public final void setValue(Object value)
value
- the new value valuepublic final int getStartLevel()
public final void setStartLevel(int startLevel)
startLevel
- the new startLevel valuepublic final String getVarStatus()
getVarStatus
in class UIXCollection
UIXCollection.createVarStatusMap()
public final void setVarStatus(String varStatus)
varStatus
- the new varStatus valuepublic final boolean isImmediate()
public final void setImmediate(boolean immediate)
immediate
- the new immediate 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 String getFamily()
getFamily
in class UIXComponentBase
protected FacesBean.Type getBeanType()
getBeanType
in class UIXComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |