|
||||||||||
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
org.apache.myfaces.trinidad.component.UIXTreeTable
public class UIXTreeTable
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 |
RANGE_CHANGE_LISTENER_KEY
|
static PropertyKey |
ROOT_NODE_RENDERED_KEY
|
static PropertyKey |
ROWS_BY_DEPTH_KEY
|
static FacesBean.Type |
TYPE
|
Fields inherited from class org.apache.myfaces.trinidad.component.UIXTree |
---|
DISCLOSED_ROW_KEYS_KEY, FOCUS_LISTENER_KEY, FOCUS_ROW_KEY_KEY, IMMEDIATE_KEY, INITIALLY_EXPANDED_KEY, NODE_STAMP_FACET, ROW_DISCLOSURE_LISTENER_KEY, SELECTED_ROW_KEYS_KEY, SELECTION_LISTENER_KEY, VALUE_KEY, 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 | |
---|---|
|
UIXTreeTable()
Construct an instance of the UIXTreeTable. |
protected |
UIXTreeTable(java.lang.String rendererType)
Construct an instance of the UIXTreeTable. |
Method Summary | |
---|---|
void |
addRangeChangeListener(RangeChangeListener listener)
Adds a RangeChangeListener. |
void |
broadcast(javax.faces.event.FacesEvent event)
Delivers an event. |
protected FacesBean.Type |
getBeanType()
|
java.lang.String |
getFamily()
|
int |
getFirst()
Gets the range start index for the current collection. |
javax.faces.el.MethodBinding |
getRangeChangeListener()
Gets a method reference to a rangeChange listener that will be called when a new range is selected. |
RangeChangeListener[] |
getRangeChangeListeners()
Retrieves all RangeChangeListeners |
int |
getRows()
Gets the maximum number of rows to show. |
int[] |
getRowsByDepth()
Gets the maximum number of records that can be displayed at one time (range size). |
protected java.util.List |
getStamps()
Gets the stamps. |
boolean |
isRootNodeRendered()
Gets If the root node should be rendered or not. |
protected void |
processFacetsAndChildren(javax.faces.context.FacesContext context,
javax.faces.event.PhaseId phaseId)
Process this component's facets and children. |
void |
removeRangeChangeListener(RangeChangeListener listener)
Removes a RangeChangeListener. |
protected void |
restoreStampState(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent stamp,
java.lang.Object stampState)
Restores the state for the given stamp. |
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
|
protected java.lang.Object |
saveStampState(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent stamp)
Saves the state for the given stamp. |
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setFirst(int index)
Sets the range start index for the current collection. |
void |
setRangeChangeListener(javax.faces.el.MethodBinding rangeChangeListener)
Sets a method reference to a rangeChange listener that will be called when a new range is selected. |
void |
setRootNodeRendered(boolean rootNodeRendered)
Sets If the root node should be rendered or not. |
void |
setRowsByDepth(int[] rowsByDepth)
Sets the maximum number of records that can be displayed at one time (range size). |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXHierarchy |
---|
enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, 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, 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 ROOT_NODE_RENDERED_KEY
public static final PropertyKey ROWS_BY_DEPTH_KEY
public static final PropertyKey RANGE_CHANGE_LISTENER_KEY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public UIXTreeTable()
protected UIXTreeTable(java.lang.String rendererType)
Method Detail |
---|
public final int getRows()
getRowsByDepth()
.
getRows
in interface CollectionComponent
getRows
in class UIXHierarchy
public final int getFirst()
getFirst
in interface CollectionComponent
getFirst
in class UIXHierarchy
UIXCollection.getRowData()
public void setFirst(int index)
index
- zero based index of the row that must be displayed first.UIXCollection.getRowData()
public void addRangeChangeListener(RangeChangeListener listener)
public void removeRangeChangeListener(RangeChangeListener listener)
public RangeChangeListener[] getRangeChangeListeners()
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class UIXCollection
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class UIXCollection
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
UIXTree
broadcast
in class UIXTree
event
- a FacesEvent
javax.faces.event.AbortProcessingException
protected final java.util.List getStamps()
getStamps
in class UIXHierarchy
protected final void restoreStampState(javax.faces.context.FacesContext context, javax.faces.component.UIComponent stamp, java.lang.Object stampState)
restoreStampState
in class UIXCollection
protected final java.lang.Object saveStampState(javax.faces.context.FacesContext context, javax.faces.component.UIComponent stamp)
saveStampState
in class UIXCollection
protected final 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 UIXTree
public final boolean isRootNodeRendered()
public final void setRootNodeRendered(boolean rootNodeRendered)
rootNodeRendered
- the new rootNodeRendered valuepublic final int[] getRowsByDepth()
public final void setRowsByDepth(int[] rowsByDepth)
rowsByDepth
- the new rowsByDepth valuepublic final javax.faces.el.MethodBinding getRangeChangeListener()
public final void setRangeChangeListener(javax.faces.el.MethodBinding rangeChangeListener)
rangeChangeListener
- the new rangeChangeListener valuepublic java.lang.String getFamily()
getFamily
in class UIXTree
protected FacesBean.Type getBeanType()
getBeanType
in class UIXTree
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |