public class CoreTreeTable extends UIXTreeTable implements javax.faces.component.behavior.ClientBehaviorHolder
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.NoColumnFacetsVisitContext
UIXComponentBase.ComponentSystemEventListenerWrapper
LocalRowKeyIndex.Confidence, LocalRowKeyIndex.LocalCachingStrategy
HEIGHT_KEY, RANGE_CHANGE_LISTENER_KEY, ROOT_NODE_RENDERED_KEY, ROWS_BY_DEPTH_KEY
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
VAR_KEY
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY
Modifier | Constructor and Description |
---|---|
|
CoreTreeTable()
Construct an instance of the CoreTreeTable.
|
protected |
CoreTreeTable(String rendererType)
Construct an instance of the CoreTreeTable.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName,
javax.faces.component.behavior.ClientBehavior behavior)
Utility method to assist sub-classes in the implementation of the
ClientBehaviorHolder interface. |
javax.faces.component.UIComponent |
getActions()
content to be rendered inline with the navigation bar.
|
protected FacesBean.Type |
getBeanType() |
Map<String,List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors()
Utility method to assist sub-classes in the implementation of the
ClientBehaviorHolder interface. |
int |
getColumnBandingInterval()
Gets the interval between which the column banding alternates.
|
String |
getDefaultEventName()
Utility method to assist sub-classes in the implementation of the
ClientBehaviorHolder interface. |
String |
getEmptyText()
Gets text displayed when a table is empty.
|
Collection<String> |
getEventNames() |
String |
getFamily() |
javax.faces.component.UIComponent |
getFooter()
the component used to render the table footer.
|
javax.faces.component.UIComponent |
getHeader()
the component used to render the table header.
|
String |
getInlineStyle()
Gets the CSS styles to use for this component.
|
String |
getOnclick()
Gets an onclick Javascript handler.
|
String |
getOndblclick()
Gets an ondblclick Javascript handler.
|
String |
getOnkeydown()
Gets an onkeydown Javascript handler.
|
String |
getOnkeypress()
Gets an onkeypress Javascript handler.
|
String |
getOnkeyup()
Gets an onkeyup Javascript handler.
|
String |
getOnmousedown()
Gets an onmousedown Javascript handler.
|
String |
getOnmousemove()
Gets an onmousemove Javascript handler.
|
String |
getOnmouseout()
Gets an onmouseout Javascript handler.
|
String |
getOnmouseover()
Gets an onmouseover Javascript handler.
|
String |
getOnmouseup()
Gets an onmouseup Javascript handler.
|
String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update.
|
javax.faces.component.UIComponent |
getPathStamp()
the component used to stamp each step of the focus path of this
treeTable.
|
int |
getRowBandingInterval()
Gets the interval between which the row banding alternates.
|
String |
getRowSelection()
Gets whether rows in this table selectable.
|
String |
getShortDesc()
Gets The short description of the component.
|
String |
getStyleClass()
Gets a CSS style class to use for this component.
|
String |
getSummary()
Gets the summary of this table's purpose and structure
for user agents rendering to non-visual media.
|
String |
getWidth()
Gets the width of the table.
|
boolean |
isAutoSubmit()
Gets If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
|
boolean |
isExpandAllEnabled()
Gets Whether the Expand All, Collapse All links should be rendered.
|
boolean |
isHorizontalGridVisible()
Gets if the horizontal grid lines will be drawn.
|
boolean |
isVerticalGridVisible()
Gets if the vertical grid lines will be drawn.
|
void |
setActions(javax.faces.component.UIComponent actionsFacet)
content to be rendered inline with the navigation bar.
|
void |
setAutoSubmit(boolean autoSubmit)
Sets If set to TRUE on a form element, the component will automatically submit
the enclosing form when an appropriate action takes place (a click, text
change, etc.).
|
void |
setColumnBandingInterval(int columnBandingInterval)
Sets the interval between which the column banding alternates.
|
void |
setEmptyText(String emptyText)
Sets text displayed when a table is empty.
|
void |
setExpandAllEnabled(boolean expandAllEnabled)
Sets Whether the Expand All, Collapse All links should be rendered.
|
void |
setFooter(javax.faces.component.UIComponent footerFacet)
the component used to render the table footer.
|
void |
setHeader(javax.faces.component.UIComponent headerFacet)
the component used to render the table header.
|
void |
setHorizontalGridVisible(boolean horizontalGridVisible)
Sets if the horizontal grid lines will be drawn.
|
void |
setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component.
|
void |
setOnclick(String onclick)
Sets an onclick Javascript handler.
|
void |
setOndblclick(String ondblclick)
Sets an ondblclick Javascript handler.
|
void |
setOnkeydown(String onkeydown)
Sets an onkeydown Javascript handler.
|
void |
setOnkeypress(String onkeypress)
Sets an onkeypress Javascript handler.
|
void |
setOnkeyup(String onkeyup)
Sets an onkeyup Javascript handler.
|
void |
setOnmousedown(String onmousedown)
Sets an onmousedown Javascript handler.
|
void |
setOnmousemove(String onmousemove)
Sets an onmousemove Javascript handler.
|
void |
setOnmouseout(String onmouseout)
Sets an onmouseout Javascript handler.
|
void |
setOnmouseover(String onmouseover)
Sets an onmouseover Javascript handler.
|
void |
setOnmouseup(String onmouseup)
Sets an onmouseup Javascript handler.
|
void |
setPartialTriggers(String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update.
|
void |
setPathStamp(javax.faces.component.UIComponent pathStampFacet)
the component used to stamp each step of the focus path of this
treeTable.
|
void |
setRowBandingInterval(int rowBandingInterval)
Sets the interval between which the row banding alternates.
|
void |
setRowSelection(String rowSelection)
Sets whether rows in this table selectable.
|
void |
setShortDesc(String shortDesc)
Sets The short description of the component.
|
void |
setStyleClass(String styleClass)
Sets a CSS style class to use for this component.
|
void |
setSummary(String summary)
Sets the summary of this table's purpose and structure
for user agents rendering to non-visual media.
|
void |
setVerticalGridVisible(boolean verticalGridVisible)
Sets if the vertical grid lines will be drawn.
|
void |
setWidth(String width)
Sets the width of the table.
|
__encodeBegin, addRangeChangeListener, broadcast, decode, getContainerClientId, getFirst, getHeight, getRangeChangeListener, getRangeChangeListeners, getRows, getRowsByDepth, getStamps, isRootNodeRendered, processFacetsAndChildren, processUpdates, processValidators, removeRangeChangeListener, restoreStampState, restoreState, saveStampState, saveState, setFirst, setHeight, setRangeChangeListener, setRangeChangeListener, setRootNodeRendered, setRowsByDepth, visitChildren, visitData, visitUnstampedFacets
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, setVarStatus
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, createVarStatusMap, enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getTreeModel, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isContainer, isContainerEmpty, visitHierarchy, visitLevel
areRowsAvailable, 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, processFlattenedChildrenBegin, processRestoreState, processSaveState, resetStampState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setupELVariable, setupVisitingContext, setVar, tearDownVisitingContext, updateChildrenImpl, validateChildrenImpl, visitChildrenWithoutIterating
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, 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, validateChildren
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, visitAllChildren, visitChildren, visitTree, visitTree
encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getVar
areRowsAvailable, areRowsAvailable, areRowsAvailable, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, isRowAvailable, setRowIndex, setRowKey
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, isRowLocallyAvailable, isRowLocallyAvailable
public static final String ROW_SELECTION_NONE
public static final String ROW_SELECTION_SINGLE
public static final String ROW_SELECTION_MULTIPLE
public static final FacesBean.Type TYPE
public static final PropertyKey HORIZONTAL_GRID_VISIBLE_KEY
public static final PropertyKey VERTICAL_GRID_VISIBLE_KEY
public static final PropertyKey EMPTY_TEXT_KEY
public static final PropertyKey COLUMN_BANDING_INTERVAL_KEY
public static final PropertyKey ROW_BANDING_INTERVAL_KEY
public static final PropertyKey ROW_SELECTION_KEY
public static final PropertyKey AUTO_SUBMIT_KEY
public static final PropertyKey WIDTH_KEY
public static final PropertyKey SUMMARY_KEY
public static final PropertyKey INLINE_STYLE_KEY
public static final PropertyKey STYLE_CLASS_KEY
public static final PropertyKey SHORT_DESC_KEY
public static final PropertyKey PARTIAL_TRIGGERS_KEY
public static final PropertyKey ONCLICK_KEY
public static final PropertyKey ONDBLCLICK_KEY
public static final PropertyKey ONMOUSEDOWN_KEY
public static final PropertyKey ONMOUSEUP_KEY
public static final PropertyKey ONMOUSEOVER_KEY
public static final PropertyKey ONMOUSEMOVE_KEY
public static final PropertyKey ONMOUSEOUT_KEY
public static final PropertyKey ONKEYPRESS_KEY
public static final PropertyKey ONKEYDOWN_KEY
public static final PropertyKey ONKEYUP_KEY
public static final PropertyKey EXPAND_ALL_ENABLED_KEY
public static final String FOOTER_FACET
public static final String HEADER_FACET
public static final String ACTIONS_FACET
public static final String PATH_STAMP_FACET
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public CoreTreeTable()
protected CoreTreeTable(String rendererType)
public final javax.faces.component.UIComponent getFooter()
public final void setFooter(javax.faces.component.UIComponent footerFacet)
public final javax.faces.component.UIComponent getHeader()
public final void setHeader(javax.faces.component.UIComponent headerFacet)
public final javax.faces.component.UIComponent getActions()
public final void setActions(javax.faces.component.UIComponent actionsFacet)
public final javax.faces.component.UIComponent getPathStamp()
public final void setPathStamp(javax.faces.component.UIComponent pathStampFacet)
public final boolean isHorizontalGridVisible()
public final void setHorizontalGridVisible(boolean horizontalGridVisible)
horizontalGridVisible
- the new horizontalGridVisible valuepublic final boolean isVerticalGridVisible()
public final void setVerticalGridVisible(boolean verticalGridVisible)
verticalGridVisible
- the new verticalGridVisible valuepublic final String getEmptyText()
public final void setEmptyText(String emptyText)
emptyText
- the new emptyText valuepublic final int getColumnBandingInterval()
public final void setColumnBandingInterval(int columnBandingInterval)
columnBandingInterval
- the new columnBandingInterval valuepublic final int getRowBandingInterval()
public final void setRowBandingInterval(int rowBandingInterval)
rowBandingInterval
- the new rowBandingInterval valuepublic final String getRowSelection()
public final void setRowSelection(String rowSelection)
rowSelection
- the new rowSelection valuepublic final boolean isAutoSubmit()
public final void setAutoSubmit(boolean autoSubmit)
autoSubmit
- the new autoSubmit valuepublic final String getWidth()
public final void setWidth(String width)
width
- the new width valuepublic final String getSummary()
public final void setSummary(String summary)
summary
- the new summary valuepublic final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
public final void setShortDesc(String shortDesc)
shortDesc
- the new shortDesc valuepublic final String[] getPartialTriggers()
This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".
public final void setPartialTriggers(String[] partialTriggers)
This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.
Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"
Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".
partialTriggers
- the new partialTriggers valuepublic final String getOnclick()
public final void setOnclick(String onclick)
onclick
- the new onclick valuepublic final String getOndblclick()
public final void setOndblclick(String ondblclick)
ondblclick
- the new ondblclick valuepublic final String getOnmousedown()
public final void setOnmousedown(String onmousedown)
onmousedown
- the new onmousedown valuepublic final String getOnmouseup()
public final void setOnmouseup(String onmouseup)
onmouseup
- the new onmouseup valuepublic final String getOnmouseover()
public final void setOnmouseover(String onmouseover)
onmouseover
- the new onmouseover valuepublic final String getOnmousemove()
public final void setOnmousemove(String onmousemove)
onmousemove
- the new onmousemove valuepublic final String getOnmouseout()
public final void setOnmouseout(String onmouseout)
onmouseout
- the new onmouseout valuepublic final String getOnkeypress()
public final void setOnkeypress(String onkeypress)
onkeypress
- the new onkeypress valuepublic final String getOnkeydown()
public final void setOnkeydown(String onkeydown)
onkeydown
- the new onkeydown valuepublic final String getOnkeyup()
public final void setOnkeyup(String onkeyup)
onkeyup
- the new onkeyup valuepublic final boolean isExpandAllEnabled()
public final void setExpandAllEnabled(boolean expandAllEnabled)
expandAllEnabled
- the new expandAllEnabled valuepublic String getDefaultEventName()
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class UIXComponentBase
ClientBehaviorHolder.getDefaultEventName()
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class UIXComponentBase
ClientBehaviorHolder.getClientBehaviors()
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
UIXComponentBase
ClientBehaviorHolder
interface.
This method must only be called by classes that implement the interface, doing otherwise will result in an exception.
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class UIXComponentBase
eventName
- The event namebehavior
- The behavior to addClientBehaviorHolder.addClientBehavior(String, ClientBehavior)
public String getFamily()
getFamily
in class UIXTreeTable
protected FacesBean.Type getBeanType()
getBeanType
in class UIXTreeTable
Copyright © 2001-2017 The Apache Software Foundation. All Rights Reserved.