oracle.adf.view.faces.component.core.data
Class CoreTreeTable

java.lang.Object
  javax.faces.component.UIComponent
      oracle.adf.view.faces.component.UIXComponent
          oracle.adf.view.faces.component.UIXComponentBase
              oracle.adf.view.faces.component.UIXCollection
                  oracle.adf.view.faces.component.UIXHierarchy
                      oracle.adf.view.faces.component.UIXTree
                          oracle.adf.view.faces.component.UIXTreeTable
                              oracle.adf.view.faces.component.core.data.CoreTreeTable

All Implemented Interfaces:

CollectionComponent, NamingContainer, RowKeyIndex, StateHolder

public class CoreTreeTable

extends UIXTreeTable

The ADF TreeTable is used to display data that is structured in a hierarchical format. This component displays a hierarchy in a UI similar to an ADF Table, and is more elaborate than the Tree component. TreeTable supports displaying columns of data per element in the hierarchy. Unlike the Tree component, TreeTable only supports single rooted hierarchies. The features of the TreeTable component include mechanisms for focusing in on subtrees (within the main tree), as well as expanding and collapsing elements in the hierarchy.

Like the Table, the TreeTable's children must be ADF Column components. Like the Tree, the TreeTable has a "nodeStamp" facet which renders the "Object Name" Column. The "Object Name" Column contains the primary identifier of an element in the hierarchy. For example, in an organization chart of employees, the "Object Name" Column might be the employee name.

Example:

In the following example, The "Object Name" Column is the "Employee Name" Column. For each element (that is, employee) the TreeTable stamps out the name, ID and the department.

 <af:treeTable var="node" value="#{myBean.orgChart.root}">
   <f:facet name="nodeStamp">
     <af:column>
       <f:facet name="header">
         <af:outputText value="Employee Name"/>
       </f:facet>
       <af:outputText value="#{node.ename}"/>
     </af:column>
   </f:facet>
   <af:column>
     <f:facet name="header">
       <af:outputText value="Employee Id"/>
     </f:facet>
     <af:outputText value="#{node.empid}"/>
   </af:column>
   <af:column>
     <f:facet name="header">
       <af:outputText value="Department"/>
     </f:facet>
     <af:outputText value="#{node.dname}"/>
   </af:column>
 </af:treeTable>

*

This bean is not supported on the following agent types: pda, phone, voice.

Events:

Type	Phases	Description
oracle.adf.view.faces.event.DisclosureAllEvent	Apply Request Values Invoke Application	Event delivered when user clicks "expand-all" or "collapse-all" links. This event has an isExpandAll method that returns whether the user wants to show or hide all the subtrees.
oracle.adf.view.faces.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.
oracle.adf.view.faces.event.SelectionEvent	Apply Request Values Invoke Application	Event delivered when user makes a selection of rows on the table.
oracle.adf.view.faces.event.DisclosureEvent	Apply Request Values Invoke Application	Event delivered when user expands or collapses a subtree.

Field Summary

static java.lang.String	ACTIONS_FACET
static java.lang.String	BANDING_COLUMN Enumerated value indicating that columns should be alternately banded.
static PropertyKey	BANDING_INTERVAL_KEY
static PropertyKey	BANDING_KEY
static java.lang.String	BANDING_NONE Enumerated value indicating that the table shouldn't be banded.
static java.lang.String	BANDING_ROW Enumerated value indicating that rows should be alternately banded.
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	EMPTY_TEXT_KEY
static PropertyKey	EXPAND_ALL_ENABLED_KEY
static java.lang.String	FOOTER_FACET
static java.lang.String	HEADER_FACET
static PropertyKey	INLINE_STYLE_KEY
static PropertyKey	ONCLICK_KEY
static PropertyKey	ONDBLCLICK_KEY
static PropertyKey	ONKEYDOWN_KEY
static PropertyKey	ONKEYPRESS_KEY
static PropertyKey	ONKEYUP_KEY
static PropertyKey	ONMOUSEDOWN_KEY
static PropertyKey	ONMOUSEMOVE_KEY
static PropertyKey	ONMOUSEOUT_KEY
static PropertyKey	ONMOUSEOVER_KEY
static PropertyKey	ONMOUSEUP_KEY
static PropertyKey	PARTIAL_TRIGGERS_KEY
static java.lang.String	PATH_STAMP_FACET
static java.lang.String	SELECTION_FACET
static PropertyKey	SHORT_DESC_KEY
static PropertyKey	STYLE_CLASS_KEY
static PropertyKey	SUMMARY_KEY
static FacesBean.Type	TYPE
static PropertyKey	WIDTH_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXTreeTable

DISCLOSURE_ALL_LISTENER_KEY, FOCUS_LISTENER_KEY, RANGE_CHANGE_LISTENER_KEY, ROWS_BY_DEPTH_KEY, SELECTION_LISTENER_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXTree

DISCLOSURE_LISTENER_KEY, FOCUS_ROW_KEY_KEY, IMMEDIATE_KEY, NODE_STAMP_FACET, TREE_STATE_KEY, VALUE_KEY, VAR_KEY, VAR_STATUS_KEY

Fields inherited from class oracle.adf.view.faces.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

	CoreTreeTable() Construct an instance of the CoreTreeTable.
protected	CoreTreeTable(java.lang.String rendererType) Construct an instance of the CoreTreeTable.

Method Summary

UIComponent	getActions() the component used for performing treeTable actions that are independent of element selection.
java.lang.String	getBanding() Gets the banding type to use on this table.
int	getBandingInterval() Gets the number of rows in each banding group.
protected FacesBean.Type	getBeanType()
java.lang.String	getEmptyText() Gets the text to display inside this component when it is empty
java.lang.String	getFamily()
UIComponent	getFooter() the component used to render the table footer.
UIComponent	getHeader() the component used to render the table header.
java.lang.String	getInlineStyle() Gets the inline CSS style for this element
java.lang.String	getOnclick() Gets an onclick Javascript handler.
java.lang.String	getOndblclick() Gets an ondblclick Javascript handler.
java.lang.String	getOnkeydown() Gets an onkeydown Javascript handler.
java.lang.String	getOnkeypress() Gets an onkeypress Javascript handler.
java.lang.String	getOnkeyup() Gets an onkeyup Javascript handler.
java.lang.String	getOnmousedown() Gets an onmousedown Javascript handler.
java.lang.String	getOnmousemove() Gets an onmousemove Javascript handler.
java.lang.String	getOnmouseout() Gets an onmouseout Javascript handler.
java.lang.String	getOnmouseover() Gets an onmouseover Javascript handler.
java.lang.String	getOnmouseup() Gets an onmouseup Javascript handler.
java.lang.String[]	getPartialTriggers() Gets the IDs of the components that should trigger a partial update.
UIComponent	getPathStamp() the component used to stamp each step of the focus path of this treeTable.
UIComponent	getSelection() the component used for selecting rows in the treeTable.
java.lang.String	getShortDesc() Gets the short description of the bean.
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
java.lang.String	getSummary() Gets the summary of this table's purpose and structure for user agents rendering to non-visual media.
java.lang.String	getWidth() Gets the width of this component.
boolean	isExpandAllEnabled() Gets Whether the Expand All, Collapse All links should be rendered.
void	setActions(UIComponent actionsFacet) the component used for performing treeTable actions that are independent of element selection.
void	setBanding(java.lang.String banding) Sets the banding type to use on this table.
void	setBandingInterval(int bandingInterval) Sets the number of rows in each banding group.
void	setEmptyText(java.lang.String emptyText) Sets the text to display inside this component when it is empty
void	setExpandAllEnabled(boolean expandAllEnabled) Sets Whether the Expand All, Collapse All links should be rendered.
void	setFooter(UIComponent footerFacet) the component used to render the table footer.
void	setHeader(UIComponent headerFacet) the component used to render the table header.
void	setInlineStyle(java.lang.String inlineStyle) Sets the inline CSS style for this element
void	setOnclick(java.lang.String onclick) Sets an onclick Javascript handler.
void	setOndblclick(java.lang.String ondblclick) Sets an ondblclick Javascript handler.
void	setOnkeydown(java.lang.String onkeydown) Sets an onkeydown Javascript handler.
void	setOnkeypress(java.lang.String onkeypress) Sets an onkeypress Javascript handler.
void	setOnkeyup(java.lang.String onkeyup) Sets an onkeyup Javascript handler.
void	setOnmousedown(java.lang.String onmousedown) Sets an onmousedown Javascript handler.
void	setOnmousemove(java.lang.String onmousemove) Sets an onmousemove Javascript handler.
void	setOnmouseout(java.lang.String onmouseout) Sets an onmouseout Javascript handler.
void	setOnmouseover(java.lang.String onmouseover) Sets an onmouseover Javascript handler.
void	setOnmouseup(java.lang.String onmouseup) Sets an onmouseup Javascript handler.
void	setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update.
void	setPathStamp(UIComponent pathStampFacet) the component used to stamp each step of the focus path of this treeTable.
void	setSelection(UIComponent selectionFacet) the component used for selecting rows in the treeTable.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the bean.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.
void	setSummary(java.lang.String summary) Sets the summary of this table's purpose and structure for user agents rendering to non-visual media.
void	setWidth(java.lang.String width) Sets the width of this component.

Methods inherited from class oracle.adf.view.faces.component.UIXTreeTable

addFocusListener, addRangeChangeListener, addSelectionListener, broadcast, getDisclosureAllListener, getFirst, getFocusListener, getFocusListeners, getRangeChangeListener, getRangeChangeListeners, getRows, getRowsByDepth, getSelectionListener, getSelectionListeners, getStamps, processFacetsAndChildren, removeFocusListener, removeRangeChangeListener, removeSelectionListener, restoreStampState, restoreState, saveStampState, saveState, setDisclosureAllListener, setFirst, setFocusListener, setRangeChangeListener, setRowsByDepth, setSelectionListener

Methods inherited from class oracle.adf.view.faces.component.UIXTree

addDisclosureListener, createCollectionModel, getDisclosureListener, getDisclosureListeners, getFocusRowKey, getNodeStamp, getSelectionState, getTreeState, getValue, getVar, getVarStatus, isImmediate, queueEvent, removeDisclosureListener, setDisclosureListener, setFocusRowKey, setImmediate, setNodeStamp, setTreeState, setValue, setVar, setVarStatus

Methods inherited from class oracle.adf.view.faces.component.UIXHierarchy

enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getTreeModel, isContainer, isContainerEmpty

Methods inherited from class oracle.adf.view.faces.component.UIXCollection

clearCurrencyStringCache, createVarStatusMap, decodeChildrenImpl, encodeBegin, encodeEnd, getCollectionModel, getCollectionModel, getCurrencyString, getLocalClientId, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, isRowAvailable, isRowAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, resetStampState, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, updateChildrenImpl, validateChildrenImpl

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addAttributeChange, addAttributeChange, addAttributeChangeListener, addFacesListener, createFacesBean, decode, decodeChildren, encodeAll, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString, updateChildren, validateChildren

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.adf.view.faces.model.RowKeyIndex

getRowCount, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, setRowIndex, setRowKey

Field Detail

BANDING_ROW

public static final java.lang.String BANDING_ROW

Enumerated value indicating that rows should be alternately banded.

See Also:

Constant Field Values

BANDING_NONE

public static final java.lang.String BANDING_NONE

Enumerated value indicating that the table shouldn't be banded.

See Also:

Constant Field Values

BANDING_COLUMN

public static final java.lang.String BANDING_COLUMN

Enumerated value indicating that columns should be alternately banded.

See Also:

Constant Field Values

TYPE

public static final FacesBean.Type TYPE

EXPAND_ALL_ENABLED_KEY

public static final PropertyKey EXPAND_ALL_ENABLED_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

WIDTH_KEY

public static final PropertyKey WIDTH_KEY

EMPTY_TEXT_KEY

public static final PropertyKey EMPTY_TEXT_KEY

SUMMARY_KEY

public static final PropertyKey SUMMARY_KEY

BANDING_KEY

public static final PropertyKey BANDING_KEY

BANDING_INTERVAL_KEY

public static final PropertyKey BANDING_INTERVAL_KEY

ACTIONS_FACET

public static final java.lang.String ACTIONS_FACET

See Also:

Constant Field Values

PATH_STAMP_FACET

public static final java.lang.String PATH_STAMP_FACET

See Also:

Constant Field Values

FOOTER_FACET

public static final java.lang.String FOOTER_FACET

See Also:

Constant Field Values

HEADER_FACET

public static final java.lang.String HEADER_FACET

See Also:

Constant Field Values

SELECTION_FACET

public static final java.lang.String SELECTION_FACET

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

CoreTreeTable

public CoreTreeTable()

Construct an instance of the CoreTreeTable.

CoreTreeTable

protected CoreTreeTable(java.lang.String rendererType)

Construct an instance of the CoreTreeTable.

Method Detail

getActions

public final UIComponent getActions()

the component used for performing treeTable actions that are independent of element selection.

setActions

public final void setActions(UIComponent actionsFacet)

the component used for performing treeTable actions that are independent of element selection.

getPathStamp

public final UIComponent getPathStamp()

the component used to stamp each step of the focus path of this treeTable.

setPathStamp

public final void setPathStamp(UIComponent pathStampFacet)

the component used to stamp each step of the focus path of this treeTable.

getFooter

public final UIComponent getFooter()

the component used to render the table footer.

setFooter

public final void setFooter(UIComponent footerFacet)

the component used to render the table footer.

getHeader

public final UIComponent getHeader()

the component used to render the table header.

setHeader

public final void setHeader(UIComponent headerFacet)

the component used to render the table header.

getSelection

public final UIComponent getSelection()

the component used for selecting rows in the treeTable.

setSelection

public final void setSelection(UIComponent selectionFacet)

the component used for selecting rows in the treeTable.

isExpandAllEnabled

public final boolean isExpandAllEnabled()

Gets Whether the Expand All, Collapse All links should be rendered.

setExpandAllEnabled

public final void setExpandAllEnabled(boolean expandAllEnabled)

Sets Whether the Expand All, Collapse All links should be rendered.

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

getPartialTriggers

public final java.lang.String[] getPartialTriggers()

Gets the IDs of the components that should trigger a partial update. 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.

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)

Sets the IDs of the components that should trigger a partial update. 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.

getOnclick

public final java.lang.String getOnclick()

Gets an onclick Javascript handler.

setOnclick

public final void setOnclick(java.lang.String onclick)

Sets an onclick Javascript handler.

getOndblclick

public final java.lang.String getOndblclick()

Gets an ondblclick Javascript handler.

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)

Sets an ondblclick Javascript handler.

getOnmousedown

public final java.lang.String getOnmousedown()

Gets an onmousedown Javascript handler.

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)

Sets an onmousedown Javascript handler.

getOnmouseup

public final java.lang.String getOnmouseup()

Gets an onmouseup Javascript handler.

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)

Sets an onmouseup Javascript handler.

getOnmouseover

public final java.lang.String getOnmouseover()

Gets an onmouseover Javascript handler.

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)

Sets an onmouseover Javascript handler.

getOnmousemove

public final java.lang.String getOnmousemove()

Gets an onmousemove Javascript handler.

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)

Sets an onmousemove Javascript handler.

getOnmouseout

public final java.lang.String getOnmouseout()

Gets an onmouseout Javascript handler.

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)

Sets an onmouseout Javascript handler.

getOnkeypress

public final java.lang.String getOnkeypress()

Gets an onkeypress Javascript handler.

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)

Sets an onkeypress Javascript handler.

getOnkeydown

public final java.lang.String getOnkeydown()

Gets an onkeydown Javascript handler.

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)

Sets an onkeydown Javascript handler.

getOnkeyup

public final java.lang.String getOnkeyup()

Gets an onkeyup Javascript handler.

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)

Sets an onkeyup Javascript handler.

getStyleClass

public final java.lang.String getStyleClass()

Gets the CSS style class of the bean.

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets the CSS style class of the bean.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the inline CSS style for this element

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the inline CSS style for this element

getWidth

public final java.lang.String getWidth()

Gets the width of this component.

setWidth

public final void setWidth(java.lang.String width)

Sets the width of this component.

getEmptyText

public final java.lang.String getEmptyText()

Gets the text to display inside this component when it is empty

setEmptyText

public final void setEmptyText(java.lang.String emptyText)

Sets the text to display inside this component when it is empty

getSummary

public final java.lang.String getSummary()

Gets the summary of this table's purpose and structure for user agents rendering to non-visual media.

setSummary

public final void setSummary(java.lang.String summary)

Sets the summary of this table's purpose and structure for user agents rendering to non-visual media.

getBanding

public final java.lang.String getBanding()

Gets the banding type to use on this table. Three values are allowed:

• none: (the default) the table isn't banded
• row: rows will be alternately banded
• column: columns will be alternately banded

setBanding

public final void setBanding(java.lang.String banding)

Sets the banding type to use on this table. Three values are allowed:

• none: (the default) the table isn't banded
• row: rows will be alternately banded
• column: columns will be alternately banded

getBandingInterval

public final int getBandingInterval()

Gets the number of rows in each banding group. For example, if "bandingInterval" is set to "2", then two rows/columns will be light, followed by two that are dark, etc.

setBandingInterval

public final void setBandingInterval(int bandingInterval)

Sets the number of rows in each banding group. For example, if "bandingInterval" is set to "2", then two rows/columns will be light, followed by two that are dark, etc.

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIXTreeTable

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXTreeTable