Skip navigation links

oracle.adf.view.rich.component.rich.data
Class PartialRichTree

java.lang.Object
javax.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
oracle.adf.view.rich.component.rich.data.PartialRichTree

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.apache.myfaces.trinidad.component.CollectionComponent, org.apache.myfaces.trinidad.model.LocalRowKeyIndex, org.apache.myfaces.trinidad.model.RowKeyIndex, org.apache.myfaces.trinidad.model.TreeLocalRowKeyIndex

Direct Known Subclasses:

RichTree

public abstract class PartialRichTree

extends org.apache.myfaces.trinidad.component.UIXTree

implements javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer

The Tree is used to display data that is structured in a hierarchical format. This component supports multiple root elements, and it has a simple user interface (UI) - each element in the Tree is appropriately indented to indicate its level in the hierarchy, and is connected to its parent. The features of the Tree component include mechanisms for expanding and collapsing portions of the hierarchy.

The "nodeStamp" facet of the Tree is used to display the data for each element in the tree. The "nodeStamp" is repeatedly rendered (stamped) once per element. The "nodeStamp" can contain images and text items. The selection is displayed only around the text items.

Because of this stamping behavior, some components may not work inside the tree. Most components will work without problems, for example any input and output components. If you need to use multiple components inside a cell, you can wrap them inside a panelGroupLayout component. Components that themselves support stamping are not supported, such as trees within a tree or region within a tree.

<section name="Hierarchical_Selector" id="Hierarchical_Selector">

The tree and treeTable components support a focusRowKey attribute that can be set (through a backing bean or EL expression) to point to a row key for a node inside the tree (at any level).

The focusRowKey attribute is also set by the tree renderer when the user right clicks on a node and selects the "Show as top" context menu item (or the "Show as top" toolbar button/menu in panelCollection).

When the focusRowKey attribute is set, the Tree renders the node pointed to by the focusRowKey attribute as the root node in the Tree and displays a "Hierarchical Selector" icon next to the root node. Clicking the Hierarchical Selector icon, displays a Hierarchical Selector popup which shows the path to the focusRowKey from the root node of the Tree.

The pathStamp facet determines how the content of the Hierarchical Selector popup is rendered, just like the nodeStamp facet determines how the content of the tree is rendered. For example, including an af:image and an af:outputText in the pathStamp facet causes the tree to render an image and an outputText component for each node level in the Hierarchical Selector popup.

</section> <section name="Fetch_Size">

See Table Fetch Size.

</section> <section name="Emailable_and_Printable_Modes">

See Table Emailable and Printable Modes.

</section> <section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children, e.g. panelStretchLayout, panelSplitter.</html:li> <html:li>When stretching this component, the only valid setting for autoHeightRows is "-1" (a value of 0 will be treated as -1 when stretched).</html:li> <html:li>When NOT stretched, autoHeightRows="0" can be used to size the height to the fetch size, which is similar to dimensionsFrom="children". Please refer to 'autoHeightRows' attribute for more information.</html:li> <html:li>This component does not stretch its children.</html:li> </html:ul>

If the oracle.adf.view.rich.geometry.DEFAULT_DIMENSIONS context-param is set to "auto" in the project's web.xml, and the autoHeightRows value is set to 0, or is not set, the AFStretchWidth style class will be rendered for this component.

</section>

Events:

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.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXCollection

org.apache.myfaces.trinidad.component.UIXCollection.NoColumnFacetsVisitContext

Nested classes/interfaces inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex

org.apache.myfaces.trinidad.model.LocalRowKeyIndex.Confidence, org.apache.myfaces.trinidad.model.LocalRowKeyIndex.LocalCachingStrategy

Field Summary

static org.apache.myfaces.trinidad.bean.PropertyKey	ACTIVE_ROW_KEY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	AUTO_HEIGHT_ROWS_KEY
static String	BLOCK_ROW_NAVIGATION_ON_ERROR_ALWAYS
static String	BLOCK_ROW_NAVIGATION_ON_ERROR_AUTO
static org.apache.myfaces.trinidad.bean.PropertyKey	BLOCK_ROW_NAVIGATION_ON_ERROR_KEY
static String	BLOCK_ROW_NAVIGATION_ON_ERROR_NEVER
static org.apache.myfaces.trinidad.bean.PropertyKey	CLEAR_TOKEN_CACHE_ON_PPR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_ATTRIBUTES_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_COMPONENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	CONTENT_DELIVERY_IMMEDIATE
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_DELIVERY_KEY
static String	CONTENT_DELIVERY_LAZY
static String	CONTENT_DELIVERY_WHEN_AVAILABLE
static String	CONTEXT_MENU_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTEXT_MENU_ID_KEY Deprecated.
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTEXT_MENU_SELECT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static String	DISPLAY_ROW_FIRST
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAY_ROW_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAY_ROW_KEY_KEY
static String	DISPLAY_ROW_LAST
static String	DISPLAY_ROW_SELECTED
static String	EDITING_MODE_CLICK_TO_EDIT
static String	EDITING_MODE_EDIT_ALL
static org.apache.myfaces.trinidad.bean.PropertyKey	EDITING_MODE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	EMPTY_TEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	EXPAND_ALL_ENABLED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FETCH_SIZE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	NON_SCROLLABLE_ROWS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static String	PATH_STAMP_FACET
static org.apache.myfaces.trinidad.bean.PropertyKey	ROW_SELECTION_KEY
static String	ROW_SELECTION_MULTIPLE
static String	ROW_SELECTION_NONE
static String	ROW_SELECTION_SINGLE
static org.apache.myfaces.trinidad.bean.PropertyKey	SCROLL_LEFT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SCROLL_TOP_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SCROLL_TOP_ROW_KEY_KEY
static String	SELECTION_EVENT_DELAY_DISABLED
static String	SELECTION_EVENT_DELAY_ENABLED
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTION_EVENT_DELAY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SUMMARY_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	UNSECURE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VISIBLE_KEY

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 class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

protected

PartialRichTree(String rendererType) Construct an instance of the PartialRichTree.

Method Summary

void	addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
Object	getActiveRowKey() Gets this is the row that is currently active on the client.
int	getAutoHeightRows() Gets
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
String	getBlockRowNavigationOnError() Gets
Set	getClientAttributes() Gets a set of client attribute names.
Map<String,List<javax.faces.component.behavior.ClientBehavior>>	getClientBehaviors()
ClientListenerSet	getClientListeners() Gets a set of client listeners.
String	getContentDelivery() Gets whether data should be fetched when the component is rendered initially.
javax.faces.component.UIComponent	getContextMenu() popup component containing the context menu that will be shown on right click of any tree node.
String	getContextMenuId() Deprecated. This attribute is deprecated, "contextMenu" facet should be used instead.
String	getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
String	getDefaultEventName()
String	getDisplayRow() Gets the row to display in the tree during initial display.
Object	getDisplayRowKey() Gets the rowkey to display in the tree during initial display.
String	getEditingMode() Gets Indicates the mode used to edit the tree when it contains editable components.
String	getEmptyText() Gets the text of an empty tree.
Collection<String>	getEventNames()
String	getFamily()
int	getFetchSize() Gets the number of rows in the data fetch block
String	getInlineStyle() Gets the CSS styles to use for this component.
int	getNonScrollableRows() Gets The nonScrollableRows property determines the number of rows to show in email mode, print mode, or other circumstances where table scrolling is unavailable.
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 when the Hierachical Selector popup is displayed.
String	getRowSelection() Gets whether rows in this table are selectable.
int	getScrollLeft() Gets private property to indicate current horizontal scroll position .
int	getScrollTop() Gets private property to indicate current vertical scroll position .
Object	getScrollTopRowKey() Gets private property to indicate the client token for the first visible node .
String	getSelectionEventDelay() Gets whether or not it is enabled to delay row selection event for 300ms when a user navigates rows with arrow up/down key.
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 tree's purpose and structure for user agents rendering to non-visual media.
Set<String>	getUnsecure() Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
boolean	isClearTokenCacheOnPPR() Gets private property to turn on/off the clearing of the row key token cache when the copmponent is PPRed.
boolean	isClientComponent() Gets whether a client-side component will be generated.
boolean	isContextMenuSelect() Gets Indicates if we should actually select the node clicked when right clicking to show a context menu.
boolean	isExpandAllEnabled() Gets Indicates whether the "Expand/Collapse All", and "Expand/Collapse All Below" menu items are rendered.
boolean	isVisible() Gets the visibility of the component.
void	setActiveRowKey(Object activeRowKey) Sets this is the row that is currently active on the client.
void	setAutoHeightRows(int autoHeightRows) Sets
void	setBlockRowNavigationOnError(String blockRowNavigationOnError) Sets
void	setClearTokenCacheOnPPR(boolean clearTokenCacheOnPPR) Sets private property to turn on/off the clearing of the row key token cache when the copmponent is PPRed.
void	setClientAttributes(Set clientAttributes) Sets a set of client attribute names.
void	setClientComponent(boolean clientComponent) Sets whether a client-side component will be generated.
void	setClientListeners(ClientListenerSet clientListeners) Sets a set of client listeners.
void	setContentDelivery(String contentDelivery) Sets whether data should be fetched when the component is rendered initially.
void	setContextMenu(javax.faces.component.UIComponent contextMenuFacet) popup component containing the context menu that will be shown on right click of any tree node.
void	setContextMenuId(String contextMenuId) Deprecated. This attribute is deprecated, "contextMenu" facet should be used instead.
void	setContextMenuSelect(boolean contextMenuSelect) Sets Indicates if we should actually select the node clicked when right clicking to show a context menu.
void	setCustomizationId(String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
void	setDisplayRow(String displayRow) Sets the row to display in the tree during initial display.
void	setDisplayRowKey(Object displayRowKey) Sets the rowkey to display in the tree during initial display.
void	setEditingMode(String editingMode) Sets Indicates the mode used to edit the tree when it contains editable components.
void	setEmptyText(String emptyText) Sets the text of an empty tree.
void	setExpandAllEnabled(boolean expandAllEnabled) Sets Indicates whether the "Expand/Collapse All", and "Expand/Collapse All Below" menu items are rendered.
void	setFetchSize(int fetchSize) Sets the number of rows in the data fetch block
void	setInlineStyle(String inlineStyle) Sets the CSS styles to use for this component.
void	setNonScrollableRows(int nonScrollableRows) Sets The nonScrollableRows property determines the number of rows to show in email mode, print mode, or other circumstances where table scrolling is unavailable.
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 when the Hierachical Selector popup is displayed.
void	setRowSelection(String rowSelection) Sets whether rows in this table are selectable.
void	setScrollLeft(int scrollLeft) Sets private property to indicate current horizontal scroll position .
void	setScrollTop(int scrollTop) Sets private property to indicate current vertical scroll position .
void	setScrollTopRowKey(Object scrollTopRowKey) Sets private property to indicate the client token for the first visible node .
void	setSelectionEventDelay(String selectionEventDelay) Sets whether or not it is enabled to delay row selection event for 300ms when a user navigates rows with arrow up/down key.
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 tree's purpose and structure for user agents rendering to non-visual media.
void	setUnsecure(Set<String> unsecure) Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
void	setVisible(boolean visible) Sets the visibility of the component.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXTree

__encodeBegin, addFocusListener, addRowDisclosureListener, addSelectionListener, broadcast, createCollectionModel, createFacesBean, getDisclosedRowKeys, getFocusListener, getFocusListeners, getFocusRowKey, getNodeStamp, getRowDisclosureListener, getRowDisclosureListeners, getSelectedRowKeys, getSelectionListener, getSelectionListeners, getValue, getVarStatus, isImmediate, isInitiallyExpanded, postCreateCollectionModel, processFacetsAndChildren, queueEvent, removeFocusListener, removeRowDisclosureListener, removeSelectionListener, setDisclosedRowKeys, setFocusListener, setFocusRowKey, setImmediate, setInitiallyExpanded, setNodeStamp, setRowDisclosureListener, setRowDisclosureListener, setSelectedRowKeys, setSelectionListener, setSelectionListener, setValue, setVarStatus, visitChildren, visitData

Methods inherited from class org.apache.myfaces.trinidad.component.UIXHierarchy

areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, createVarStatusMap, enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getFirst, getRows, getStamps, getTreeModel, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isContainer, isContainerEmpty, visitHierarchy, visitLevel

Methods inherited from class org.apache.myfaces.trinidad.component.UIXCollection

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, processRestoreState, processSaveState, processUpdates, processValidators, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setupELVariable, setupVisitingContext, setVar, tearDownVisitingContext, updateChildrenImpl, validateChildrenImpl, visitChildrenWithoutIterating, visitUnstampedFacets

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, 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

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, 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, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, pushComponentToEL, restoreTransientState, saveTransientState, setInView

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

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

Methods inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex

areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, isRowLocallyAvailable, isRowLocallyAvailable

Field Detail

SELECTION_EVENT_DELAY_DISABLED

public static final String SELECTION_EVENT_DELAY_DISABLED

See Also:

Constant Field Values

SELECTION_EVENT_DELAY_ENABLED

public static final String SELECTION_EVENT_DELAY_ENABLED

See Also:

Constant Field Values

ROW_SELECTION_NONE

public static final String ROW_SELECTION_NONE

See Also:

Constant Field Values

ROW_SELECTION_SINGLE

public static final String ROW_SELECTION_SINGLE

See Also:

Constant Field Values

ROW_SELECTION_MULTIPLE

public static final String ROW_SELECTION_MULTIPLE

See Also:

Constant Field Values

CONTENT_DELIVERY_IMMEDIATE

public static final String CONTENT_DELIVERY_IMMEDIATE

See Also:

Constant Field Values

CONTENT_DELIVERY_LAZY

public static final String CONTENT_DELIVERY_LAZY

See Also:

Constant Field Values

CONTENT_DELIVERY_WHEN_AVAILABLE

public static final String CONTENT_DELIVERY_WHEN_AVAILABLE

See Also:

Constant Field Values

DISPLAY_ROW_FIRST

public static final String DISPLAY_ROW_FIRST

See Also:

Constant Field Values

DISPLAY_ROW_LAST

public static final String DISPLAY_ROW_LAST

See Also:

Constant Field Values

DISPLAY_ROW_SELECTED

public static final String DISPLAY_ROW_SELECTED

See Also:

Constant Field Values

EDITING_MODE_CLICK_TO_EDIT

public static final String EDITING_MODE_CLICK_TO_EDIT

See Also:

Constant Field Values

EDITING_MODE_EDIT_ALL

public static final String EDITING_MODE_EDIT_ALL

See Also:

Constant Field Values

BLOCK_ROW_NAVIGATION_ON_ERROR_ALWAYS

public static final String BLOCK_ROW_NAVIGATION_ON_ERROR_ALWAYS

See Also:

Constant Field Values

BLOCK_ROW_NAVIGATION_ON_ERROR_NEVER

public static final String BLOCK_ROW_NAVIGATION_ON_ERROR_NEVER

See Also:

Constant Field Values

BLOCK_ROW_NAVIGATION_ON_ERROR_AUTO

public static final String BLOCK_ROW_NAVIGATION_ON_ERROR_AUTO

See Also:

Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

UNSECURE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

Deprecated.

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

SELECTION_EVENT_DELAY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SELECTION_EVENT_DELAY_KEY

NON_SCROLLABLE_ROWS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey NON_SCROLLABLE_ROWS_KEY

CONTEXT_MENU_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTEXT_MENU_ID_KEY

Deprecated.

ROW_SELECTION_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_SELECTION_KEY

FETCH_SIZE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey FETCH_SIZE_KEY

CONTENT_DELIVERY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY

DISPLAY_ROW_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_ROW_KEY

DISPLAY_ROW_KEY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_ROW_KEY_KEY

ACTIVE_ROW_KEY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ACTIVE_ROW_KEY_KEY

EMPTY_TEXT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EMPTY_TEXT_KEY

SUMMARY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SUMMARY_KEY

CONTEXT_MENU_SELECT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTEXT_MENU_SELECT_KEY

EDITING_MODE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EDITING_MODE_KEY

EXPAND_ALL_ENABLED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EXPAND_ALL_ENABLED_KEY

SCROLL_TOP_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SCROLL_TOP_KEY

SCROLL_LEFT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SCROLL_LEFT_KEY

SCROLL_TOP_ROW_KEY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SCROLL_TOP_ROW_KEY_KEY

CLEAR_TOKEN_CACHE_ON_PPR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLEAR_TOKEN_CACHE_ON_PPR_KEY

AUTO_HEIGHT_ROWS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey AUTO_HEIGHT_ROWS_KEY

BLOCK_ROW_NAVIGATION_ON_ERROR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey BLOCK_ROW_NAVIGATION_ON_ERROR_KEY

PATH_STAMP_FACET

public static final String PATH_STAMP_FACET

See Also:

Constant Field Values

CONTEXT_MENU_FACET

public static final String CONTEXT_MENU_FACET

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

PartialRichTree

protected PartialRichTree(String rendererType)

Construct an instance of the PartialRichTree.

Method Detail

getPathStamp

public final javax.faces.component.UIComponent getPathStamp()

the component used to stamp each step of the focus path when the Hierachical Selector popup is displayed. This component can be a a combination of simple outputText, image, or outputFormatted tags and must not be an "input" component (EditableValueHolder) since no user input is allowed in the Hierarchical Selector popup. If this facet is not provided, then the Hierarchical Selector icon is not rendered.

setPathStamp

public final void setPathStamp(javax.faces.component.UIComponent pathStampFacet)

the component used to stamp each step of the focus path when the Hierachical Selector popup is displayed. This component can be a a combination of simple outputText, image, or outputFormatted tags and must not be an "input" component (EditableValueHolder) since no user input is allowed in the Hierarchical Selector popup. If this facet is not provided, then the Hierarchical Selector icon is not rendered.

getContextMenu

public final javax.faces.component.UIComponent getContextMenu()

popup component containing the context menu that will be shown on right click of any tree node. The af:popup must contain an af:menu to display the context menu

setContextMenu

public final void setContextMenu(javax.faces.component.UIComponent contextMenuFacet)

popup component containing the context menu that will be shown on right click of any tree node. The af:popup must contain an af:menu to display the context menu

getInlineStyle

public final String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Returns:

the new inlineStyle value

setInlineStyle

public final void setInlineStyle(String inlineStyle)

Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final String getStyleClass()

Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Returns:

the new styleClass value

setStyleClass

public final void setStyleClass(String styleClass)

Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.

Parameters:

styleClass - the new styleClass value

getShortDesc

public final String getShortDesc()

Gets the short description of the component. The shortDesc text may be used in two different ways, depending on the component.

For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.

shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.

Returns:

the new shortDesc value

setShortDesc

public final void setShortDesc(String shortDesc)

Sets the short description of the component. The shortDesc text may be used in two different ways, depending on the component.

For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.

shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final Set<String> getUnsecure()

Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Returns:

the new unsecure value

setUnsecure

public final void setUnsecure(Set<String> unsecure)

Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Parameters:

unsecure - the new unsecure value

isVisible

public final boolean isVisible()

Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.

Parameters:

visible - the new visible value

getCustomizationId

@Deprecated
public final String getCustomizationId()

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(String customizationId)

Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.

Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

public final 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. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Returns:

the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(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. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Parameters:

partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

getSelectionEventDelay

public final String getSelectionEventDelay()

Gets whether or not it is enabled to delay row selection event for 300ms when a user navigates rows with arrow up/down key. When it is enabled, it can improve the performance by avoiding sending many events to server while a user keeps arrow up/down key down to navigate. It can have a value of enabled/disabled. The default value is disabled.

Returns:

the new selectionEventDelay value

setSelectionEventDelay

public final void setSelectionEventDelay(String selectionEventDelay)

Sets whether or not it is enabled to delay row selection event for 300ms when a user navigates rows with arrow up/down key. When it is enabled, it can improve the performance by avoiding sending many events to server while a user keeps arrow up/down key down to navigate. It can have a value of enabled/disabled. The default value is disabled.

Parameters:

selectionEventDelay - the new selectionEventDelay value

getNonScrollableRows

public final int getNonScrollableRows()

Gets The nonScrollableRows property determines the number of rows to show in email mode, print mode, or other circumstances where table scrolling is unavailable. This property will not have an affect outside of these circumstances.

Returns:

the new nonScrollableRows value

setNonScrollableRows

public final void setNonScrollableRows(int nonScrollableRows)

Sets The nonScrollableRows property determines the number of rows to show in email mode, print mode, or other circumstances where table scrolling is unavailable. This property will not have an affect outside of these circumstances.

Parameters:

nonScrollableRows - the new nonScrollableRows value

getContextMenuId

@Deprecated
public final String getContextMenuId()

Deprecated. This attribute is deprecated, "contextMenu" facet should be used instead.

Gets A search expression to identify the popup component containing the context menu that will be shown within the tree body. Expressions are relative to this tree component and must account for NamingContainers (for example, tree and panelCollection are NamingContainer components). You can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will pop out of one NamingContainer (including component itself if it is a NamingContainer) and begin search from there, ":::" will pop out of two NamingContainers, etc.

Returns:

the new contextMenuId value

setContextMenuId

@Deprecated
public final void setContextMenuId(String contextMenuId)

Deprecated. This attribute is deprecated, "contextMenu" facet should be used instead.

Sets A search expression to identify the popup component containing the context menu that will be shown within the tree body. Expressions are relative to this tree component and must account for NamingContainers (for example, tree and panelCollection are NamingContainer components). You can prepend a single colon to start the search from the root, or multiple colons to move up through the NamingContainers. For example, a leading "::" will pop out of one NamingContainer (including component itself if it is a NamingContainer) and begin search from there, ":::" will pop out of two NamingContainers, etc.

Parameters:

contextMenuId - the new contextMenuId value

getRowSelection

public final String getRowSelection()

Gets whether rows in this table are selectable. Use the value "single" to enable single selection and "multiple" to enable multiple selection.

Returns:

the new rowSelection value

setRowSelection

public final void setRowSelection(String rowSelection)

Sets whether rows in this table are selectable. Use the value "single" to enable single selection and "multiple" to enable multiple selection.

Parameters:

rowSelection - the new rowSelection value

getFetchSize

public final int getFetchSize()

Gets the number of rows in the data fetch block

Returns:

the new fetchSize value

setFetchSize

public final void setFetchSize(int fetchSize)

Sets the number of rows in the data fetch block

Parameters:

fetchSize - the new fetchSize value

getContentDelivery

public final String getContentDelivery()

Gets whether data should be fetched when the component is rendered initially. When contentDelivery is "immediate", data is fetched and inlined into the component chrome. If contentDelivery is "lazy", data will be fetched and delivered to the client during a subsequent request. If contentDelivery is set to "whenAvailable", upon initial rendering, the renderer queries the model for available data. Data is fetched and rendered immediately if model indicates that data is available. So contentDelivery="whenAvailable" behaves like "immediate" if data is available upon initial rendering.

Returns:

the new contentDelivery value

setContentDelivery

public final void setContentDelivery(String contentDelivery)

Sets whether data should be fetched when the component is rendered initially. When contentDelivery is "immediate", data is fetched and inlined into the component chrome. If contentDelivery is "lazy", data will be fetched and delivered to the client during a subsequent request. If contentDelivery is set to "whenAvailable", upon initial rendering, the renderer queries the model for available data. Data is fetched and rendered immediately if model indicates that data is available. So contentDelivery="whenAvailable" behaves like "immediate" if data is available upon initial rendering.

Parameters:

contentDelivery - the new contentDelivery value

getDisplayRow

public final String getDisplayRow()

Gets the row to display in the tree during initial display. The possible values are "first" to display the first row, "last" to display the last row and "selected" to display the first selected row in the tree. The default value for this is null which means that the first row is displayed.

Returns:

the new displayRow value

setDisplayRow

public final void setDisplayRow(String displayRow)

Sets the row to display in the tree during initial display. The possible values are "first" to display the first row, "last" to display the last row and "selected" to display the first selected row in the tree. The default value for this is null which means that the first row is displayed.

Parameters:

displayRow - the new displayRow value

getDisplayRowKey

public final Object getDisplayRowKey()

Gets the rowkey to display in the tree during initial display. Specifying this attribute will override the displayRow attribute.

Returns:

the new displayRowKey value

setDisplayRowKey

public final void setDisplayRowKey(Object displayRowKey)

Sets the rowkey to display in the tree during initial display. Specifying this attribute will override the displayRow attribute.

Parameters:

displayRowKey - the new displayRowKey value

getActiveRowKey

public final Object getActiveRowKey()

Gets this is the row that is currently active on the client. In click-to-edit mode, the active row will be made editable and is brought into view (if not already visible). Upon initial display, the click-to-edit component defaults the active row to the first visible row.

Returns:

the new activeRowKey value

setActiveRowKey

public final void setActiveRowKey(Object activeRowKey)

Sets this is the row that is currently active on the client. In click-to-edit mode, the active row will be made editable and is brought into view (if not already visible). Upon initial display, the click-to-edit component defaults the active row to the first visible row.

Parameters:

activeRowKey - the new activeRowKey value

getEmptyText

public final String getEmptyText()

Gets the text of an empty tree. If the text is enclosed in an open and closing html tag, it will be formatted. The formatting behavior is similar to outputFormatted component. If it is not enclosed in an open and closing html tag, it will not be formatted.

Returns:

the new emptyText value

setEmptyText

public final void setEmptyText(String emptyText)

Sets the text of an empty tree. If the text is enclosed in an open and closing html tag, it will be formatted. The formatting behavior is similar to outputFormatted component. If it is not enclosed in an open and closing html tag, it will not be formatted.

Parameters:

emptyText - the new emptyText value

getSummary

public final String getSummary()

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

Returns:

the new summary value

setSummary

public final void setSummary(String summary)

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

Parameters:

summary - the new summary value

isContextMenuSelect

public final boolean isContextMenuSelect()

Gets Indicates if we should actually select the node clicked when right clicking to show a context menu. By default the node is selected before the context menu is displayed. However if contextMenuSelect="false", and if user right clicks a node, the new node is highlighted and the highlighting for the currently selected node(s) is cleared when the context menus is displayed. The highlighting of the currently selected nodes(s) is restored after the context menu is dismissed. It should be noted that when the context menu is displayed, the attribute selectedRowKeys still contains the selected node(s). The highlighted row key is established as a currency in the tree when the action for context menu item is executed. The currency in the tree can be retrieved by calling "tree.getRowKey()".

Returns:

the new contextMenuSelect value

setContextMenuSelect

public final void setContextMenuSelect(boolean contextMenuSelect)

Sets Indicates if we should actually select the node clicked when right clicking to show a context menu. By default the node is selected before the context menu is displayed. However if contextMenuSelect="false", and if user right clicks a node, the new node is highlighted and the highlighting for the currently selected node(s) is cleared when the context menus is displayed. The highlighting of the currently selected nodes(s) is restored after the context menu is dismissed. It should be noted that when the context menu is displayed, the attribute selectedRowKeys still contains the selected node(s). The highlighted row key is established as a currency in the tree when the action for context menu item is executed. The currency in the tree can be retrieved by calling "tree.getRowKey()".

Parameters:

contextMenuSelect - the new contextMenuSelect value

getEditingMode

public final String getEditingMode()

Gets Indicates the mode used to edit the tree when it contains editable components. When a tree is rendered as readOnly, the editingMode attribute is ignored. The possible values are "clickToEdit" and "editAll". In "editAll" mode all the editable components are displayed at a time in the table view area. In "clickToEdit" mode a single node is editable at a time. In "clickToEdit" mode a single row editable at a time. The following is the behavior:

1. Stay in edit mode: If in edit mode, stay in edit mode when a read/only cell is reached via keyboard navigation.
2. Enter key navigation: When in edit mode, ensure that pressing Enter or Shift+Enter navigates to the adjacent node when possible.
3. Esc key reverts cell edits: When in edit mode, pressing the Esc key reverts all edits made to cells in a node and disables edit mode.
4. Input Field Text Selection: When a cell contains an input text field widget, the text is selected automatically when the widget has focus.

Returns:

the new editingMode value

setEditingMode

public final void setEditingMode(String editingMode)

Sets Indicates the mode used to edit the tree when it contains editable components. When a tree is rendered as readOnly, the editingMode attribute is ignored. The possible values are "clickToEdit" and "editAll". In "editAll" mode all the editable components are displayed at a time in the table view area. In "clickToEdit" mode a single node is editable at a time. In "clickToEdit" mode a single row editable at a time. The following is the behavior:

1. Stay in edit mode: If in edit mode, stay in edit mode when a read/only cell is reached via keyboard navigation.
2. Enter key navigation: When in edit mode, ensure that pressing Enter or Shift+Enter navigates to the adjacent node when possible.
3. Esc key reverts cell edits: When in edit mode, pressing the Esc key reverts all edits made to cells in a node and disables edit mode.
4. Input Field Text Selection: When a cell contains an input text field widget, the text is selected automatically when the widget has focus.

Parameters:

editingMode - the new editingMode value

isExpandAllEnabled

public final boolean isExpandAllEnabled()

Gets Indicates whether the "Expand/Collapse All", and "Expand/Collapse All Below" menu items are rendered. These menu items are rendered by default.

Returns:

the new expandAllEnabled value

setExpandAllEnabled

public final void setExpandAllEnabled(boolean expandAllEnabled)

Sets Indicates whether the "Expand/Collapse All", and "Expand/Collapse All Below" menu items are rendered. These menu items are rendered by default.

Parameters:

expandAllEnabled - the new expandAllEnabled value

getScrollTop

public final int getScrollTop()

Gets private property to indicate current vertical scroll position .

Returns:

the new scrollTop value

setScrollTop

public final void setScrollTop(int scrollTop)

Sets private property to indicate current vertical scroll position .

Parameters:

scrollTop - the new scrollTop value

getScrollLeft

public final int getScrollLeft()

Gets private property to indicate current horizontal scroll position .

Returns:

the new scrollLeft value

setScrollLeft

public final void setScrollLeft(int scrollLeft)

Sets private property to indicate current horizontal scroll position .

Parameters:

scrollLeft - the new scrollLeft value

getScrollTopRowKey

public final Object getScrollTopRowKey()

Gets private property to indicate the client token for the first visible node .

Returns:

the new scrollTopRowKey value

setScrollTopRowKey

public final void setScrollTopRowKey(Object scrollTopRowKey)

Sets private property to indicate the client token for the first visible node .

Parameters:

scrollTopRowKey - the new scrollTopRowKey value

isClearTokenCacheOnPPR

public final boolean isClearTokenCacheOnPPR()

Gets private property to turn on/off the clearing of the row key token cache when the copmponent is PPRed. Default is true

Returns:

the new clearTokenCacheOnPPR value

setClearTokenCacheOnPPR

public final void setClearTokenCacheOnPPR(boolean clearTokenCacheOnPPR)

Sets private property to turn on/off the clearing of the row key token cache when the copmponent is PPRed. Default is true

Parameters:

clearTokenCacheOnPPR - the new clearTokenCacheOnPPR value

getAutoHeightRows

public final int getAutoHeightRows()

Gets

The number of rows used to size the tree height.

If the oracle.adf.view.rich.geometry.DEFAULT_DIMENSIONS context-param is set to "auto" in the project's web.xml, the default value for this attribute will be 0. Otherwise, the default value will be -1 (no auto-sizing for any number of rows).

• In a flow layout, specifying the 'autoHeightRows' attribute causes the height of the tree to shrink/grow as nodes are expanded/collapsed in the UI.
• The height will grow to a maximum of 'autoHeightRows' after which a scrollbar is shown.
• This attribute is also supported when the component is inside PanelCollection.
• A value of 0 can be used to default the autoHeightRows to the current fetchSize.
• 'autoHeightRows' value cannot be larger than "fetchSize" attribute.
• If a value larger than fetchSize is specified, the value is capped at the fetchSize.
• If a value larger than the number of rows is specified, the number of rows in the component is used to size the component height.
• 'autoHeightRows' works with contentDelivery=immediate/lazy/whenAvailable.
• 'autoHeightRows' attribute has no effect in screen reader mode.
• Note that specifying a CSS "height" in the "inlineStyle" attribute will have no effect and will get overridden by the auto-sized height.
• Specifying CSS "min-height" and "max-height" values in the "inlineStyle" attribute is not recommended and is incompatible with the autoHeightRows attribute.
• When the component is placed in a layout-managing container, such as panelSplitter, it will be sized by the container (no auto-sizing will occur).

Returns:

the new autoHeightRows value

setAutoHeightRows

public final void setAutoHeightRows(int autoHeightRows)

Sets

The number of rows used to size the tree height.

If the oracle.adf.view.rich.geometry.DEFAULT_DIMENSIONS context-param is set to "auto" in the project's web.xml, the default value for this attribute will be 0. Otherwise, the default value will be -1 (no auto-sizing for any number of rows).

• In a flow layout, specifying the 'autoHeightRows' attribute causes the height of the tree to shrink/grow as nodes are expanded/collapsed in the UI.
• The height will grow to a maximum of 'autoHeightRows' after which a scrollbar is shown.
• This attribute is also supported when the component is inside PanelCollection.
• A value of 0 can be used to default the autoHeightRows to the current fetchSize.
• 'autoHeightRows' value cannot be larger than "fetchSize" attribute.
• If a value larger than fetchSize is specified, the value is capped at the fetchSize.
• If a value larger than the number of rows is specified, the number of rows in the component is used to size the component height.
• 'autoHeightRows' works with contentDelivery=immediate/lazy/whenAvailable.
• 'autoHeightRows' attribute has no effect in screen reader mode.
• Note that specifying a CSS "height" in the "inlineStyle" attribute will have no effect and will get overridden by the auto-sized height.
• Specifying CSS "min-height" and "max-height" values in the "inlineStyle" attribute is not recommended and is incompatible with the autoHeightRows attribute.
• When the component is placed in a layout-managing container, such as panelSplitter, it will be sized by the container (no auto-sizing will occur).

Parameters:

autoHeightRows - the new autoHeightRows value

getBlockRowNavigationOnError

public final String getBlockRowNavigationOnError()

Gets

Whether we want to block row navigation in case of validation failure.

This is when you select a row and do some editing inside the table or in a related form, and this editing causes some validation failures. At this time, if you click on a different row in table, we want to block you from moving to the new row.

possible values are: always, never and auto. default value is auto.

• always means we block the row navigation
• never means we don't block and let the row navigation happen
• auto means the framework will make the decision

Returns:

the new blockRowNavigationOnError value

setBlockRowNavigationOnError

public final void setBlockRowNavigationOnError(String blockRowNavigationOnError)

Sets

Whether we want to block row navigation in case of validation failure.

This is when you select a row and do some editing inside the table or in a related form, and this editing causes some validation failures. At this time, if you click on a different row in table, we want to block you from moving to the new row.

possible values are: always, never and auto. default value is auto.

• always means we block the row navigation
• never means we don't block and let the row navigation happen
• auto means the framework will make the decision

Parameters:

blockRowNavigationOnError - the new blockRowNavigationOnError value

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class org.apache.myfaces.trinidad.component.UIXComponentBase

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()

Specified by:

getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getClientBehaviors in class org.apache.myfaces.trinidad.component.UIXComponentBase

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)

Specified by:

addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

addClientBehavior in class org.apache.myfaces.trinidad.component.UIXComponentBase

getFamily

public String getFamily()

Overrides:

getFamily in class org.apache.myfaces.trinidad.component.UIXTree

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXTree

Skip navigation links