public class UIXTreeTable extends UIXTree
| 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.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 event might include the width of a column that supported client-side resizing. |
UIXCollection.NoColumnFacetsVisitContextLocalRowKeyIndex.Confidence, LocalRowKeyIndex.LocalCachingStrategy| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static 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 |
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_KEYVAR_KEYBINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY| Modifier | Constructor and Description |
|---|---|
|
UIXTreeTable()
Construct an instance of the UIXTreeTable.
|
protected |
UIXTreeTable(String rendererType)
Construct an instance of the UIXTreeTable.
|
| Modifier and Type | Method and Description |
|---|---|
protected void |
__encodeBegin(javax.faces.context.FacesContext context)
Override to update the container client id cache before encode
|
void |
addRangeChangeListener(RangeChangeListener listener)
Adds a RangeChangeListener.
|
void |
broadcast(javax.faces.event.FacesEvent event)
Delivers an event.
|
void |
decode(javax.faces.context.FacesContext context)
Override to update the container client id cache before decode
|
protected FacesBean.Type |
getBeanType() |
String |
getContainerClientId(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent child)
Override to return clientd ids with no currency for items in header/footer facets
|
String |
getFamily() |
int |
getFirst()
Gets the range start index for the current collection.
|
javax.el.MethodExpression |
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 List<javax.faces.component.UIComponent> |
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 |
processUpdates(javax.faces.context.FacesContext context)
Override to update the container client id cache before updates
|
void |
processValidators(javax.faces.context.FacesContext context)
Override to update the container client id cache before validations
|
void |
removeRangeChangeListener(RangeChangeListener listener)
Removes a RangeChangeListener.
|
protected void |
restoreStampState(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent stamp,
Object stampState)
Restores the state for the given stamp.
|
void |
restoreState(javax.faces.context.FacesContext context,
Object state) |
protected Object |
saveStampState(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent stamp)
Saves the state for the given stamp.
|
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 binding)
Deprecated.
|
void |
setRangeChangeListener(javax.el.MethodExpression 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).
|
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.
|
protected boolean |
visitUnstampedFacets(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback)
Hook method for subclasses to override to change the behavior
of how unstamped facets of the UIXCollection are visited.
|
addFocusListener, addRowDisclosureListener, addSelectionListener, createCollectionModel, createFacesBean, getDisclosedRowKeys, getFocusListener, getFocusListeners, getFocusRowKey, getNodeStamp, getRowDisclosureListener, getRowDisclosureListeners, getSelectedRowKeys, getSelectionListener, getSelectionListeners, getValue, getVarStatus, isImmediate, isInitiallyExpanded, postCreateCollectionModel, queueEvent, removeFocusListener, removeRowDisclosureListener, removeSelectionListener, setDisclosedRowKeys, setFocusListener, setFocusRowKey, setImmediate, setInitiallyExpanded, setNodeStamp, setRowDisclosureListener, setRowDisclosureListener, setSelectedRowKeys, setSelectionListener, setSelectionListener, setValue, setVarStatusareRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, createVarStatusMap, enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getTreeModel, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isContainer, isContainerEmpty, visitHierarchy, visitLevelareRowsAvailable, areRowsAvailable, areRowsAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, 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, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processEvent, processRestoreState, processSaveState, resetStampState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setupVisitingContext, setVar, tearDownVisitingContext, updateChildrenImpl, validateChildrenImpl, visitChildrenWithoutIteratingadaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, 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, validateChildrenaddPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, visitAllChildren, visitChildren, visitTree, visitTreeencodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, pushComponentToEL, setInViewclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetVarareRowsAvailable, areRowsAvailable, areRowsAvailable, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, isRowAvailable, setRowIndex, setRowKeyareRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, isRowLocallyAvailable, isRowLocallyAvailablepublic 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 String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public UIXTreeTable()
protected UIXTreeTable(String rendererType)
public void decode(javax.faces.context.FacesContext context)
decode in class UIXComponentBasepublic void processValidators(javax.faces.context.FacesContext context)
processValidators in class UIXCollectionpublic void processUpdates(javax.faces.context.FacesContext context)
processUpdates in class UIXCollectionprotected void __encodeBegin(javax.faces.context.FacesContext context)
throws IOException
__encodeBegin in class UIXTreeIOExceptionUIXCollection.__encodeBegin(javax.faces.context.FacesContext)public String getContainerClientId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent child)
getContainerClientId in class UIXComponentBaseUIXComponentBase.getClientId(FacesContext context)@Deprecated public void setRangeChangeListener(javax.faces.el.MethodBinding binding)
public final int getRows()
getRowsByDepth().getRows in interface CollectionComponentgetRows in class UIXHierarchypublic final int getFirst()
getFirst in interface CollectionComponentgetFirst in class UIXHierarchyUIXCollection.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 Object saveState(javax.faces.context.FacesContext context)
saveState in interface javax.faces.component.StateHoldersaveState in class UIXCollectionpublic void restoreState(javax.faces.context.FacesContext context,
Object state)
restoreState in interface javax.faces.component.StateHolderrestoreState in class UIXCollectionpublic void broadcast(javax.faces.event.FacesEvent event)
throws javax.faces.event.AbortProcessingException
UIXTreeprotected final List<javax.faces.component.UIComponent> getStamps()
getStamps in class UIXHierarchyprotected final void restoreStampState(javax.faces.context.FacesContext context,
javax.faces.component.UIComponent stamp,
Object stampState)
restoreStampState in class UIXCollectionprotected final Object saveStampState(javax.faces.context.FacesContext context, javax.faces.component.UIComponent stamp)
saveStampState in class UIXCollectionprotected void processFacetsAndChildren(javax.faces.context.FacesContext context,
javax.faces.event.PhaseId phaseId)
UIXCollectionUIXCollection.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 UIXTreeprotected 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 UIXTreevisitContext - the VisitContext for this visitcallback - the VisitCallback instancetrue if all of the children to visit have been visitedUIXCollection.visitData(javax.faces.component.visit.VisitContext, javax.faces.component.visit.VisitCallback)protected boolean visitUnstampedFacets(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback)
UIXCollectionvisitUnstampedFacets in class UIXCollectionprotected boolean visitData(javax.faces.component.visit.VisitContext visitContext,
javax.faces.component.visit.VisitCallback callback)
UIXCollectionvisitData in class UIXTreevisitContext - The visiting contextcallback - The visit callbackUIXCollection.visitChildren(VisitContext, VisitCallback)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.el.MethodExpression getRangeChangeListener()
public final void setRangeChangeListener(javax.el.MethodExpression rangeChangeListener)
rangeChangeListener - the new rangeChangeListener valueprotected FacesBean.Type getBeanType()
getBeanType in class UIXTreeCopyright © 2001-2016 The Apache Software Foundation. All Rights Reserved.