|
||||||||||
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.UIXTree
public class UIXTree
Type | Phases | Description |
---|---|---|
org.apache.myfaces.trinidad.event.RowDisclosureEvent |
Apply Request Values Invoke Application |
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.FocusEvent |
Apply Request Values Invoke Application |
Event delivered when user clicks to focus on (or zoom into) a particular element's subtree of children. The TreeTable responds to this event by modifying the "focusPath" property appropriately. Subsequently, any registered FocusListener instances are called. |
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 events might include the width of a column that supported client-side resizing. |
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
static PropertyKey |
DISCLOSED_ROW_KEYS_KEY
|
static PropertyKey |
FOCUS_LISTENER_KEY
|
static PropertyKey |
FOCUS_ROW_KEY_KEY
|
static PropertyKey |
IMMEDIATE_KEY
|
static PropertyKey |
INITIALLY_EXPANDED_KEY
|
static java.lang.String |
NODE_STAMP_FACET
|
static PropertyKey |
ROW_DISCLOSURE_LISTENER_KEY
|
static PropertyKey |
SELECTED_ROW_KEYS_KEY
|
static PropertyKey |
SELECTION_LISTENER_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 interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
|
UIXTree()
Construct an instance of the UIXTree. |
protected |
UIXTree(java.lang.String rendererType)
Construct an instance of the UIXTree. |
Method Summary | |
---|---|
protected void |
__encodeBegin(javax.faces.context.FacesContext context)
|
void |
addFocusListener(FocusListener listener)
Adds a focus listener. |
void |
addRowDisclosureListener(RowDisclosureListener listener)
Adds a rowDisclosure listener. |
void |
addSelectionListener(SelectionListener listener)
Adds a selection listener. |
void |
broadcast(javax.faces.event.FacesEvent event)
Delivers an event. |
CollectionModel |
createCollectionModel(CollectionModel current,
java.lang.Object value)
Creates the CollectionModel to use with this component. |
protected FacesBean.Type |
getBeanType()
|
RowKeySet |
getDisclosedRowKeys()
Gets the set of disclosed rows for this component. |
java.lang.String |
getFamily()
|
javax.faces.el.MethodBinding |
getFocusListener()
Gets a method reference to a focus listener |
FocusListener[] |
getFocusListeners()
Returns an array of attached focus listeners. |
java.lang.Object |
getFocusRowKey()
Gets the rowKey of the currently focused row. |
javax.faces.component.UIComponent |
getNodeStamp()
the component to use to stamp each element in the tree. |
javax.faces.el.MethodBinding |
getRowDisclosureListener()
Gets a method reference to an ExpansionListener |
RowDisclosureListener[] |
getRowDisclosureListeners()
Returns an array of attached rowDisclosure listeners. |
RowKeySet |
getSelectedRowKeys()
Gets the selection state for this component. |
javax.faces.el.MethodBinding |
getSelectionListener()
Gets a method reference to a selection listener |
SelectionListener[] |
getSelectionListeners()
Returns an array of attached selection listeners. |
java.lang.Object |
getValue()
Gets the hierarchy of tree data - must be of type org.apache.myfaces.trinidad.model.TreeModel |
java.lang.String |
getVarStatus()
Gets Name of the EL variable used to reference the varStatus information. |
boolean |
isImmediate()
Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component. |
boolean |
isInitiallyExpanded()
Gets If upon initial rendering, the current subtree under the focused row path should be expanded. |
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 |
removeFocusListener(FocusListener listener)
Removes a focus listener. |
void |
removeRowDisclosureListener(RowDisclosureListener listener)
Removes a rowDisclosure listener. |
void |
removeSelectionListener(SelectionListener listener)
Removes a selection listener. |
void |
setDisclosedRowKeys(RowKeySet disclosedRowKeys)
Sets the set of disclosed rows for this component. |
void |
setFocusListener(javax.faces.el.MethodBinding focusListener)
Sets a method reference to a focus listener |
void |
setFocusRowKey(java.lang.Object focusRowKey)
Sets the rowKey of the currently focused row. |
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 |
setInitiallyExpanded(boolean initiallyExpanded)
Sets If upon initial rendering, the current subtree under the focused row path should be expanded. |
void |
setNodeStamp(javax.faces.component.UIComponent nodeStampFacet)
the component to use to stamp each element in the tree. |
void |
setRowDisclosureListener(javax.faces.el.MethodBinding rowDisclosureListener)
Sets a method reference to an ExpansionListener |
void |
setSelectedRowKeys(RowKeySet selectedRowKeys)
Sets the selection state for this component. |
void |
setSelectionListener(javax.faces.el.MethodBinding selectionListener)
Sets a method reference to a selection listener |
void |
setValue(java.lang.Object value)
Sets the hierarchy of tree data - must be of type org.apache.myfaces.trinidad.model.TreeModel |
void |
setVarStatus(java.lang.String varStatus)
Sets Name of the EL variable used to reference the varStatus information. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXHierarchy |
---|
enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getFirst, getRows, getStamps, getTreeModel, isContainer, isContainerEmpty |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXCollection |
---|
clearCurrencyStringCache, createVarStatusMap, decodeChildrenImpl, encodeBegin, encodeEnd, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getCurrencyString, getLocalClientId, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getVar, isRowAvailable, isRowAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setVar, updateChildrenImpl, validateChildrenImpl |
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 |
---|
getRowCount, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, setRowIndex, setRowKey |
Field Detail |
---|
public static final FacesBean.Type TYPE
public static final PropertyKey SELECTED_ROW_KEYS_KEY
public static final PropertyKey IMMEDIATE_KEY
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 VAR_STATUS_KEY
public static final PropertyKey VALUE_KEY
public static final PropertyKey FOCUS_ROW_KEY_KEY
public static final PropertyKey FOCUS_LISTENER_KEY
public static final PropertyKey INITIALLY_EXPANDED_KEY
public static final java.lang.String NODE_STAMP_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public UIXTree()
protected UIXTree(java.lang.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, java.lang.Object value)
UIXCollection
createCollectionModel
in class UIXHierarchy
current
- the current CollectionModel, or null if there is none.value
- this is the value returned from UIXCollection.getValue()
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 void __encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
java.io.IOException
UIXCollection.__encodeBegin(javax.faces.context.FacesContext)
public final javax.faces.component.UIComponent getNodeStamp()
public final void setNodeStamp(javax.faces.component.UIComponent nodeStampFacet)
public 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.faces.el.MethodBinding getRowDisclosureListener()
public final void setRowDisclosureListener(javax.faces.el.MethodBinding rowDisclosureListener)
rowDisclosureListener
- the new rowDisclosureListener valuepublic final RowKeySet getDisclosedRowKeys()
public final void setDisclosedRowKeys(RowKeySet disclosedRowKeys)
disclosedRowKeys
- the new disclosedRowKeys valuepublic final javax.faces.el.MethodBinding getSelectionListener()
public final void setSelectionListener(javax.faces.el.MethodBinding selectionListener)
selectionListener
- the new selectionListener valuepublic final java.lang.String getVarStatus()
getVarStatus
in class UIXCollection
UIXCollection.createVarStatusMap()
public final void setVarStatus(java.lang.String varStatus)
varStatus
- the new varStatus valuepublic final java.lang.Object getValue()
This is a required property on the component.
getValue
in class UIXCollection
public final void setValue(java.lang.Object value)
This is a required property on the component.
value
- the new value valuepublic final java.lang.Object getFocusRowKey()
getFocusRowKey
in class UIXHierarchy
public final void setFocusRowKey(java.lang.Object focusRowKey)
focusRowKey
- the new focusRowKey valuepublic final javax.faces.el.MethodBinding getFocusListener()
public final void setFocusListener(javax.faces.el.MethodBinding focusListener)
focusListener
- the new focusListener valuepublic final boolean isInitiallyExpanded()
public final void setInitiallyExpanded(boolean initiallyExpanded)
initiallyExpanded
- the new initiallyExpanded 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 addFocusListener(FocusListener listener)
listener
- the focus listener to addpublic final void removeFocusListener(FocusListener listener)
listener
- the focus listener to removepublic final FocusListener[] getFocusListeners()
public java.lang.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 |