oracle.adf.view.faces.bi.component.hierarchyViewer
Class UIHierarchyViewer

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
                      oracle.adf.view.faces.bi.component.hierarchyViewer.UIHierarchyViewer

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder, oracle.adf.view.rich.dnd.DragSourceFactory, org.apache.myfaces.trinidad.component.CollectionComponent, org.apache.myfaces.trinidad.model.LocalRowKeyIndex, org.apache.myfaces.trinidad.model.RowKeyIndex, org.apache.myfaces.trinidad.model.TreeLocalRowKeyIndex

public class UIHierarchyViewer
extends org.apache.myfaces.trinidad.component.UIXHierarchy
implements oracle.adf.view.rich.dnd.DragSourceFactory

Since:

release specific (what release of product did this appear in)

Nested Class Summary

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	CLIENT_LISTENERS_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_DELIVERY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTROL_PANEL_BEHAVIOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY
protected static java.lang.String	DEFAULT_CONTENT_DELIVERY_MODE
protected static java.lang.String	DEFAULT_CONTROL_PANEL_BEHAVIOR
protected static int	DEFAULT_DISPLAY_LEVELS_ANCESTOR
protected static int	DEFAULT_DISPLAY_LEVELS_CHILDREN
protected static java.lang.String	DEFAULT_LAYOUT
protected static int	DEFAULT_LEVEL_FETCH_SIZE
protected static java.lang.String	DEFAULT_NODE_SELECTION
protected static java.lang.String	DEFAULT_PANNING
static org.apache.myfaces.trinidad.bean.PropertyKey	DETAIL_WINDOW_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISCLOSED_ROW_KEYS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAY_LEVELS_ANCESTOR_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAY_LEVELS_CHILDREN_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DONT_PERSIST_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	EMPTY_TEXT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	FOCUS_ROW_KEY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LAYOUT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	LEVEL_FETCH_SIZE
static org.apache.myfaces.trinidad.bean.PropertyKey	LOCALE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	NAVIGATE_UP_LISTENER_KEY
static java.lang.String	NODE_DETAIL Deprecated. don't use featuresOff="nodeDetail" use detailWindow="none" instead
static org.apache.myfaces.trinidad.bean.PropertyKey	NODE_SELECTION_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PANNING_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PERFORMANCE_FLAGS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PERSIST_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	POPUP_CONTEXT_ROW_KEY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ROW_DISCLOSURE_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTED_ROW_KEYS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SELECTION_LISTENER_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	VALUE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	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

bindings

Fields inherited from interface oracle.adf.view.rich.dnd.DragSourceFactory

DEFAULT_DRAGSOURCE

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UIHierarchyViewer()
Constructs an instance of the UIHierarchyViewer.

Method Summary

void	addRowDisclosureListener(org.apache.myfaces.trinidad.event.RowDisclosureListener listener) Adds a rowDisclosure listener.
void	addSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener) Adds a selection listener.
void	broadcast(javax.faces.event.FacesEvent event) Delivers a wrapped event to the appropriate component.
protected void	broadcastNodeActionEvent(NodeActionEvent nae)
oracle.adf.view.rich.dnd.DragSource	createDragSource(java.lang.String name, java.util.Set<oracle.adf.view.rich.dnd.DnDAction> allowedActions, oracle.adf.view.rich.dnd.DnDAction defaultAction, java.lang.String discriminant, javax.el.MethodExpression dragDropEndListener, java.util.Map<java.lang.String,?> properties)
java.lang.CharSequence	createDragSourceBehavior(java.lang.String name, oracle.adf.view.rich.dnd.DragSource dragSource, java.util.Set<oracle.adf.view.rich.dnd.DnDAction> allowedActions, oracle.adf.view.rich.dnd.DnDAction defaultAction, java.lang.String discriminant, javax.el.MethodExpression dragDropEndListener, java.util.Map<java.lang.String,?> properties)
javax.faces.component.UIComponent	findChildComponent(javax.faces.context.FacesContext context, java.lang.Class<?> compClass) Find the child component that rendered=true For internal use only
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
oracle.adf.view.rich.event.ClientListenerSet	getClientListeners() Gets a set of client listeners.
java.lang.String	getClientRowKey()
java.lang.String	getContentDelivery() Gets whether data should be fetched when the component is rendered initially.
java.lang.String	getControlPanelBehavior() Gets the behavior of the control panel.
java.lang.Object	getCurrentRowData() Get the row data object for the current row.
java.lang.String	getCustomizationId() Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
java.lang.String	getDetailWindow() Gets the detail window of the hierarchy.
org.apache.myfaces.trinidad.model.RowKeySet	getDisclosedRowKeys() Gets the set of disclosed rows for this component.
int	getDisplayLevelsAncestor() Gets the number of ancestor levels to display during initial render.
int	getDisplayLevelsChildren() Gets the number of child levels to display during initial render.
java.lang.String[]	getDontPersist() Gets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
java.lang.String	getEmptyText() Retrieves the text of an empty hierarchyViewer.
java.lang.String	getFamily()
java.lang.Object	getFocusRowKey() Gets the rowKey of the currently focused row.
java.lang.String	getInlineStyle() Gets the CSS styles to use for this component.
java.lang.String	getLayout() Gets the layout of the hierarchy.
int	getLevelFetchSize() Gets the number of child nodes that will be fetched and displayed at a single time for each expanded parent node.
java.util.Locale	getLocale() Retrieves the locale for the Topology Viewer.
javax.el.MethodExpression	getNavigateUpListener() Gets a method reference to a navigate up listener
java.lang.String	getNodeSelection() Gets the selection mode.
java.lang.String	getPanning() Gets the panning mode of the hierarchy.
java.lang.String[]	getPartialTriggers() Retrieves the ids of the partial triggers for the Topology Viewer.
java.lang.String[]	getPersist() Gets List of persistent attributes that are persisting to a registered "Persistent Change Manager".
protected java.lang.Object	getPopupContextRowKey() For internal use only
java.lang.String	getRendererType()
javax.el.MethodExpression	getRowDisclosureListener() Gets a method reference to an ExpansionListener
org.apache.myfaces.trinidad.event.RowDisclosureListener[]	getRowDisclosureListeners() Returns an array of attached rowDisclosure listeners.
org.apache.myfaces.trinidad.model.RowKeySet	getSelectedRowKeys() Gets the selection state for this component.
javax.el.MethodExpression	getSelectionListener() Gets a method reference to a selection listener
org.apache.myfaces.trinidad.event.SelectionListener[]	getSelectionListeners() Returns an array of attached selection listeners.
java.lang.String	getStyleClass() Gets a CSS style class to use for this component.
java.lang.String	getSummary() Gets the summary of this table's purpose and structure for user agents rendering to non-visual media.
java.lang.Object	getValue() Retrieves the model used for this Topology Viewer.
java.lang.String	getVarStatus()
boolean	invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback)
protected void	processFacetsAndChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
void	queueEvent(javax.faces.event.FacesEvent event) Queues an event.
void	removeRowDisclosureListener(org.apache.myfaces.trinidad.event.RowDisclosureListener listener) Removes a rowDisclosure listener.
void	removeSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener) Removes a selection listener.
void	saveToSessionChangeManager(java.lang.String attributeName, java.lang.Object attributeValue) For internal use only
void	setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners) Sets a set of client listeners.
void	setContentDelivery(java.lang.String deliveryMode) Sets whether data should be fetched when the component is rendered initially.
void	setControlPanelBehavior(java.lang.String cbehavior) Sets the behavior of the control panel.
void	setCustomizationId(java.lang.String customizationId) Deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
void	setDetailWindow(java.lang.String detailWindow) Sets the detail window of the hierarchy.
void	setDisclosedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet disclosedRowKeys) Sets the set of disclosed rows for this component.
void	setDisplayLevelsAncestor(int nDisplayLevelsAncestor) Sets the number of ancestor levels to display during initial render.
void	setDisplayLevelsChildren(int nDisplayLevelsChildren) Sets the number of child levels to display during initial render.
void	setDontPersist(java.lang.String[] dontPersist) Sets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
void	setEmptyText(java.lang.String emptyText) Sets the text of an empty hierarchyViewer.
void	setFocusRowKey(java.lang.Object focusRowKey) Sets the rowKey of the currently focused row.
void	setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component.
void	setLayout(java.lang.String layout) Sets the layout of the hierarchy.
void	setLevelFetchSize(int levelFetchSize) Sets the number of child nodes that will be fetched and displayed at a single time for each expanded parent node.
void	setLocale(java.util.Locale locale) Specifies the locale for the Topology Viewer.
void	setNavigateUpListener(javax.el.MethodExpression navigateUpLIstener) Sets a method reference to a navigate up listener
void	setNodeSelection(java.lang.String nodeSelection) Sets the selection mode.
void	setPanning(java.lang.String panning) Sets the panning mode of the hierarchy.
void	setPartialTriggers(java.lang.String[] ids) Specifies the ids of the partial triggers for the Topology Viewer.
void	setPersist(java.lang.String[] persist) Sets List of persistent attributes that are persisting to a registered "Persistent Change Manager".
protected void	setPopupContextRowKey(java.lang.Object rowKey) For internal use only
void	setRowDisclosureListener(javax.el.MethodExpression rowDisclosureListener) Sets a method reference to an ExpansionListener
void	setRowKey(java.lang.Object rowKey) Makes a row current.
void	setSelectedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet selectedRowKeys) Sets the selection state for this component.
void	setSelectionListener(javax.el.MethodExpression selectionListener) Sets a method reference to a selection listener
void	setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component.
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	setValue(java.lang.Object value) Specified the model for the Topology Viewer.
void	setVarStatus(java.lang.String varStatus) For internal use only
boolean	visitTree(org.apache.myfaces.trinidad.component.visit.VisitContext visitContext, org.apache.myfaces.trinidad.component.visit.VisitCallback callback)

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

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

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

areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, decodeChildrenImpl, encodeBegin, encodeEnd, ensureRowsAvailable, getCachingStrategy, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getVar, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postCreateCollectionModel, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setSortCriteria, setVar, updateChildrenImpl, validateChildrenImpl

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

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, validateChildren

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

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.myfaces.trinidad.component.CollectionComponent

getVar

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

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

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

TYPE

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

VALUE_KEY

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

PARTIAL_TRIGGERS_KEY

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

CONTENT_DELIVERY_KEY

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

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

SUMMARY_KEY

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

CUSTOMIZATION_ID_KEY

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

PERSIST_KEY

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

DONT_PERSIST_KEY

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

LOCALE_KEY

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

LAYOUT_KEY

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

VAR_STATUS_KEY

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

FOCUS_ROW_KEY_KEY

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

SELECTED_ROW_KEYS_KEY

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

DISPLAY_LEVELS_CHILDREN_KEY

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

DISPLAY_LEVELS_ANCESTOR_KEY

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

NODE_SELECTION_KEY

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

CONTROL_PANEL_BEHAVIOR_KEY

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

LEVEL_FETCH_SIZE

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

NAVIGATE_UP_LISTENER_KEY

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

PANNING_KEY

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

PERFORMANCE_FLAGS_KEY

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

POPUP_CONTEXT_ROW_KEY_KEY

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

EMPTY_TEXT_KEY

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

DISCLOSED_ROW_KEYS_KEY

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

ROW_DISCLOSURE_LISTENER_KEY

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

SELECTION_LISTENER_KEY

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

CLIENT_LISTENERS_KEY

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

DETAIL_WINDOW_KEY

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

DEFAULT_CONTENT_DELIVERY_MODE

protected static final java.lang.String DEFAULT_CONTENT_DELIVERY_MODE

See Also:

Constant Field Values

DEFAULT_LAYOUT

protected static final java.lang.String DEFAULT_LAYOUT

See Also:

Constant Field Values

DEFAULT_PANNING

protected static final java.lang.String DEFAULT_PANNING

See Also:

Constant Field Values

DEFAULT_NODE_SELECTION

protected static final java.lang.String DEFAULT_NODE_SELECTION

See Also:

Constant Field Values

DEFAULT_CONTROL_PANEL_BEHAVIOR

protected static final java.lang.String DEFAULT_CONTROL_PANEL_BEHAVIOR

See Also:

Constant Field Values

DEFAULT_DISPLAY_LEVELS_CHILDREN

protected static final int DEFAULT_DISPLAY_LEVELS_CHILDREN

See Also:

Constant Field Values

DEFAULT_DISPLAY_LEVELS_ANCESTOR

protected static final int DEFAULT_DISPLAY_LEVELS_ANCESTOR

See Also:

Constant Field Values

DEFAULT_LEVEL_FETCH_SIZE

protected static final int DEFAULT_LEVEL_FETCH_SIZE

See Also:

Constant Field Values

NODE_DETAIL

public static final java.lang.String NODE_DETAIL

Deprecated. don't use featuresOff="nodeDetail" use detailWindow="none" instead

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

UIHierarchyViewer

public UIHierarchyViewer()

Constructs an instance of the UIHierarchyViewer.

Method Detail

getFamily

public java.lang.String getFamily()

Specified by:

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

getRendererType

public java.lang.String getRendererType()

Overrides:

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

getBeanType

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

Overrides:

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

getClientListeners

public final oracle.adf.view.rich.event.ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). In cases like this, you can use a different skin (or define your own) that defines a skinning key for that inner DOM element where its background color is inhibited (e.g. with -tr-inhibit: background-color) or otherwise set to the color you want.

Returns:

the new inlineStyle value

setInlineStyle

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

Sets the CSS styles to use for this component. This is intended for basic style changes; you should use the skinning mechanism if you require any complex style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Many components are composed of several DOM elements which may have their own styles applied to them. Defining a style in the inlineStyle may not always give you what you want. For example, if one of the inner DOM elements for this component has a background color specified for it in the skin, setting a background color in the inlineStyle may not provide any visible change (at least for where that inner DOM element exists) because the inner DOM element's background color will win (since that DOM element is essentially layered on top of the root element). In cases like this, you can use a different skin (or define your own) that defines a skinning key for that inner DOM element where its background color is inhibited (e.g. with -tr-inhibit: background-color) or otherwise set to the color you want.

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()

Gets a CSS style class to use for this component.

Returns:

the new styleClass value

setStyleClass

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

Sets a CSS style class to use for this component.

Parameters:

styleClass - the new styleClass value

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.

Returns:

the new summary value

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.

Parameters:

summary - the new summary value

getPersist

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

Gets List of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.

Returns:

the new persist value

setPersist

public final void setPersist(java.lang.String[] persist)

Sets List of persistent attributes that are persisting to a registered "Persistent Change Manager". Persistent attributes, by default, always persist to a session.

Parameters:

persist - the new persist value

getDontPersist

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

Gets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.

Returns:

the new dontPersist value

setDontPersist

public final void setDontPersist(java.lang.String[] dontPersist)

Sets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager". Persistent attributes would still persist to a session.

Parameters:

dontPersist - the new dontPersist value

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()

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(java.lang.String customizationId)

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

getValue

public final java.lang.Object getValue()

Retrieves the model used for this Topology Viewer.

Specified by:

getValue in class org.apache.myfaces.trinidad.component.UIXCollection

Returns:

The model used for this Topology Viewer.

See Also:

setValue(java.lang.Object)

setValue

public final void setValue(java.lang.Object value)

Specified the model for the Topology Viewer.

See Also:

getValue()

getLocale

public final java.util.Locale getLocale()

Retrieves the locale for the Topology Viewer.

Returns:

The locale for the Topology Viewer.

See Also:

setLocale(java.util.Locale)

setLocale

public final void setLocale(java.util.Locale locale)

Specifies the locale for the Topology Viewer.

Parameters:

locale - The locale for the Topology Viewer.

See Also:

getLocale()

setPartialTriggers

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

Specifies the ids of the partial triggers for the Topology Viewer.

Parameters:

ids - The ids of the partial trigger components for the Topology Viewer.

See Also:

getPartialTriggers()

getPartialTriggers

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

Retrieves the ids of the partial triggers for the Topology Viewer.

Returns:

ids The ids of the partial trigger components for the Topology Viewer.

See Also:

setPartialTriggers(java.lang.String[])

getContentDelivery

public final java.lang.String getContentDelivery()

Gets whether data should be fetched when the component is rendered initially. Options are "lazy", "immediate", and "whenAvailable". If "lazy", then the hierarchyViewer content is fetched after the hierarchyViewer is sent to the browser. If "immediate", then the hierarchyViewer content is immediately sent to the browser. If "whenAvailable", then "immediate" content delivery is used if the data is already available; otherwise "lazy" content delivery is used. The default value is "whenAvailable".

Returns:

the new contentDelivery value

setContentDelivery

public final void setContentDelivery(java.lang.String deliveryMode)

Sets whether data should be fetched when the component is rendered initially. Options are "lazy", "immediate", and "whenAvailable". If "lazy", then the hierarchyViewer content is fetched after the hierarchyViewer is sent to the browser. If "immediate", then the hierarchyViewer content is immediately sent to the browser. If "whenAvailable", then "immediate" content delivery is used if the data is already available; otherwise "lazy" content delivery is used. The default value is "whenAvailable".

Parameters:

contentDelivery - the new contentDelivery value

getLayout

public final java.lang.String getLayout()

Gets the layout of the hierarchy. Valid values are: "hier_vert_top" - top-to-bottom vertical hierarchy "hier_vert_bottom" - bottom-to-top vertical hierarchy "hier_horz_left" - left-to-right horizontal hierarchy "hier_horz_right" - right-to-left horizontal hierarchy "hier_horz_start" - horizontal hierarchy whose direction depends on the locale "hier_horz_end" - horizontal hierarchy whose direction depends on the locale "tree" - indented tree "radial" - layout with root node in center and successive child levels radiating outward from their parent nodes "circle" - layout with root node in center and all leaf nodes arranged in concentric circle, with parent nodes arranged within the circle

Returns:

the new layout value

setLayout

public final void setLayout(java.lang.String layout)

Sets the layout of the hierarchy. Valid values are: "hier_vert_top" - top-to-bottom vertical hierarchy "hier_vert_bottom" - bottom-to-top vertical hierarchy "hier_horz_left" - left-to-right horizontal hierarchy "hier_horz_right" - right-to-left horizontal hierarchy "hier_horz_start" - horizontal hierarchy whose direction depends on the locale "hier_horz_end" - horizontal hierarchy whose direction depends on the locale "tree" - indented tree "radial" - layout with root node in center and successive child levels radiating outward from their parent nodes "circle" - layout with root node in center and all leaf nodes arranged in concentric circle, with parent nodes arranged within the circle

Parameters:

layout - the new layout value

getPanning

public final java.lang.String getPanning()

Gets the panning mode of the hierarchy. Valid values are: "default" - default click-and-drag panning "tilt" - default click-and-drag panning with automatic tilt panning enabled

Returns:

the new panning value

setPanning

public final void setPanning(java.lang.String panning)

Sets the panning mode of the hierarchy. Valid values are: "default" - default click-and-drag panning "tilt" - default click-and-drag panning with automatic tilt panning enabled

Parameters:

layout - the new layout value

getPopupContextRowKey

protected final java.lang.Object getPopupContextRowKey()

For internal use only

setPopupContextRowKey

protected final void setPopupContextRowKey(java.lang.Object rowKey)

For internal use only

invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                                 java.lang.String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException

Overrides:

invokeOnComponent in class org.apache.myfaces.trinidad.component.UIXCollection

Throws:

javax.faces.FacesException

getCurrentRowData

public final java.lang.Object getCurrentRowData()

Get the row data object for the current row. This method returns the same object as getRowData().

Returns:

row data object for the current row

getNodeSelection

public final java.lang.String getNodeSelection()

Gets the selection mode. Valid values are: "none" - no nodes can be selected "single" - a single node can be selected "multiple" - multiple nodes can be selected

Returns:

the new nodeSelection value

setNodeSelection

public final void setNodeSelection(java.lang.String nodeSelection)

Sets the selection mode. Valid values are: "none" - no nodes can be selected "single" - a single node can be selected "multiple" - multiple nodes can be selected

Parameters:

nodeSelection - the new nodeSelection value

getControlPanelBehavior

public final java.lang.String getControlPanelBehavior()

Gets the behavior of the control panel. Valid values are: "initCollapsed" - initially collapsed "initExpanded" - initially expanded "hidden" - hidden from view

Returns:

the new nodeSelection value

setControlPanelBehavior

public final void setControlPanelBehavior(java.lang.String cbehavior)

Sets the behavior of the control panel. Valid values are: "initCollapsed" - initially collapsed "initExpanded" - initially expanded "hidden" - hidden from view

Parameters:

nodeSelection - the new nodeSelection value

getFocusRowKey

public final java.lang.Object getFocusRowKey()

Gets the rowKey of the currently focused row. The rowKeys of the ancestor rows of the focus row are added to the expandedRowKeys RowKeySet by default.

Specified by:

getFocusRowKey in class org.apache.myfaces.trinidad.component.UIXHierarchy

Returns:

the new focusRowKey value

setFocusRowKey

public final void setFocusRowKey(java.lang.Object focusRowKey)

Sets the rowKey of the currently focused row. The rowKeys of the ancestor rows of the focus row are added to the expandedRowKeys RowKeySet by default.

Parameters:

focusRowKey - the new focusRowKey value

getSelectedRowKeys

public final org.apache.myfaces.trinidad.model.RowKeySet getSelectedRowKeys()

Gets the selection state for this component.

Returns:

the new selectedRowKeys value

setSelectedRowKeys

public final void setSelectedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet selectedRowKeys)

Sets the selection state for this component.

Parameters:

selectedRowKeys - the new selectedRowKeys value

getDisplayLevelsChildren

public final int getDisplayLevelsChildren()

Gets the number of child levels to display during initial render. This property is 0-based. A value of 0 means that no child levels below the root will be shown; the root itself will be shown. The default value is 1, which means that the root and the first level of children will be shown.

Returns:

the new displayLevelsChildren value

setDisplayLevelsChildren

public final void setDisplayLevelsChildren(int nDisplayLevelsChildren)

Sets the number of child levels to display during initial render. This property is 0-based. A value of 0 means that no child levels below the root will be shown; the root itself will be shown. The default value is 1, which means that the root and the first level of children will be shown.

Parameters:

displayLevelsChildren - the new displayLevelsChildren value

getDisplayLevelsAncestor

public final int getDisplayLevelsAncestor()

Gets the number of ancestor levels to display during initial render. This property is 0-based. A value of 0 means that no ancestor levels above the root will be shown. The default value is 0.

Returns:

the new displayLevelsAncestor value

setDisplayLevelsAncestor

public final void setDisplayLevelsAncestor(int nDisplayLevelsAncestor)

Sets the number of ancestor levels to display during initial render. This property is 0-based. A value of 0 means that no ancestor levels above the root will be shown. The default value is 0.

Parameters:

displayLevelsAncestor - the new displayLevelsAncestor value

getLevelFetchSize

public final int getLevelFetchSize()

Gets the number of child nodes that will be fetched and displayed at a single time for each expanded parent node. Additional child nodes may be fetched and displayed by using the lateral navigation controls shown in the hierarchy viewer. The default value is 25.

Returns:

the new levelFetchSize value

setLevelFetchSize

public final void setLevelFetchSize(int levelFetchSize)

Sets the number of child nodes that will be fetched and displayed at a single time for each expanded parent node. Additional child nodes may be fetched and displayed by using the lateral navigation controls shown in the hierarchy viewer. The default value is 25.

Parameters:

levelFetchSize - the new levelFetchSize value

getVarStatus

public final java.lang.String getVarStatus()

Specified by:

getVarStatus in class org.apache.myfaces.trinidad.component.UIXCollection

setVarStatus

public final void setVarStatus(java.lang.String varStatus)

For internal use only

findChildComponent

public javax.faces.component.UIComponent findChildComponent(javax.faces.context.FacesContext context,
                                                            java.lang.Class<?> compClass)

Find the child component that rendered=true For internal use only

processFacetsAndChildren

protected void processFacetsAndChildren(javax.faces.context.FacesContext context,
                                        javax.faces.event.PhaseId phaseId)

Specified by:

processFacetsAndChildren in class org.apache.myfaces.trinidad.component.UIXCollection

getClientRowKey

public java.lang.String getClientRowKey()

Overrides:

getClientRowKey in class org.apache.myfaces.trinidad.component.UIXCollection

setRowKey

public void setRowKey(java.lang.Object rowKey)

Makes a row current. This method calls UIXCollection.preRowDataChange() and UIXCollection.postRowDataChange() as appropriate.

Specified by:

setRowKey in interface org.apache.myfaces.trinidad.model.RowKeyIndex

Overrides:

setRowKey in class org.apache.myfaces.trinidad.component.UIXCollection

Parameters:

rowKey - The rowKey of the row that should be made current. Use null to clear the current row.

See Also:

CollectionModel.setRowKey(java.lang.Object)

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Queues an event. If there is a currency set on this table, then the event will be wrapped so that when it is finally delivered, the correct currency will be restored.

Overrides:

queueEvent in class org.apache.myfaces.trinidad.component.UIXCollection

Parameters:

event - a FacesEvent

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Delivers a wrapped event to the appropriate component. If the event is a special wrapped event, it is unwrapped.

Overrides:

broadcast in class org.apache.myfaces.trinidad.component.UIXCollection

Parameters:

event - a FacesEvent

Throws:

javax.faces.event.AbortProcessingException

broadcastNodeActionEvent

protected void broadcastNodeActionEvent(NodeActionEvent nae)

getSelectionListener

public final javax.el.MethodExpression getSelectionListener()

Gets a method reference to a selection listener

Returns:

the new selectionListener value

setSelectionListener

public final void setSelectionListener(javax.el.MethodExpression selectionListener)

Sets a method reference to a selection listener

Parameters:

selectionListener - the new selectionListener value

getNavigateUpListener

public final javax.el.MethodExpression getNavigateUpListener()

Gets a method reference to a navigate up listener

Returns:

the new navigateUpListener value

setNavigateUpListener

public final void setNavigateUpListener(javax.el.MethodExpression navigateUpLIstener)

Sets a method reference to a navigate up listener

Parameters:

navigateUpListener - the new navigateUpListener value

getSelectionListeners

public final org.apache.myfaces.trinidad.event.SelectionListener[] getSelectionListeners()

Returns an array of attached selection listeners.

Returns:

an array of attached selection listeners.

addSelectionListener

public final void addSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener)

Adds a selection listener.

Parameters:

listener - the selection listener to add

removeSelectionListener

public final void removeSelectionListener(org.apache.myfaces.trinidad.event.SelectionListener listener)

Removes a selection listener.

Parameters:

listener - the selection listener to remove

getDisclosedRowKeys

public final org.apache.myfaces.trinidad.model.RowKeySet getDisclosedRowKeys()

Gets the set of disclosed rows for this component. Each entry in the set is a rowKey.

Returns:

the new disclosedRowKeys value

setDisclosedRowKeys

public final void setDisclosedRowKeys(org.apache.myfaces.trinidad.model.RowKeySet disclosedRowKeys)

Sets the set of disclosed rows for this component. Each entry in the set is a rowKey.

Parameters:

disclosedRowKeys - the new disclosedRowKeys value

getRowDisclosureListener

public final javax.el.MethodExpression getRowDisclosureListener()

Gets a method reference to an ExpansionListener

Returns:

the new rowDisclosureListener value

setRowDisclosureListener

public final void setRowDisclosureListener(javax.el.MethodExpression rowDisclosureListener)

Sets a method reference to an ExpansionListener

Parameters:

rowDisclosureListener - the new rowDisclosureListener value

getRowDisclosureListeners

public final org.apache.myfaces.trinidad.event.RowDisclosureListener[] getRowDisclosureListeners()

Returns an array of attached rowDisclosure listeners.

Returns:

an array of attached rowDisclosure listeners.

addRowDisclosureListener

public final void addRowDisclosureListener(org.apache.myfaces.trinidad.event.RowDisclosureListener listener)

Adds a rowDisclosure listener.

Parameters:

listener - the rowDisclosure listener to add

removeRowDisclosureListener

public final void removeRowDisclosureListener(org.apache.myfaces.trinidad.event.RowDisclosureListener listener)

Removes a rowDisclosure listener.

Parameters:

listener - the rowDisclosure listener to remove

getEmptyText

public java.lang.String getEmptyText()

Retrieves the text of an empty hierarchyViewer. If the text is enclosed in an html tag, it will be formatted. The formatting behavior is similar to outputFormatted component.

Returns:

the text to show in an empty hierarchyViewer

setEmptyText

public void setEmptyText(java.lang.String emptyText)

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

Parameters:

emptyText - the text to show in an empty hierarchyViewer

saveToSessionChangeManager

public void saveToSessionChangeManager(java.lang.String attributeName,
                                       java.lang.Object attributeValue)

For internal use only

visitTree

public boolean visitTree(org.apache.myfaces.trinidad.component.visit.VisitContext visitContext,
                         org.apache.myfaces.trinidad.component.visit.VisitCallback callback)

Overrides:

visitTree in class org.apache.myfaces.trinidad.component.UIXComponent

getDetailWindow

public final java.lang.String getDetailWindow()

Gets the detail window of the hierarchy. Valid values are: "default" - show the detail window when hovering a node that is not at 76 - 100% zoom level. "none" - suppress the detail window

Returns:

the detailWindwo value

setDetailWindow

public final void setDetailWindow(java.lang.String detailWindow)

Sets the detail window of the hierarchy. Valid values are: "default" - show the detail window when hovering a node that is not at 76 - 100% zoom level. "none" - suppress the detail window

Parameters:

detailWindow - the new detailWindow value

createDragSource

public oracle.adf.view.rich.dnd.DragSource createDragSource(java.lang.String name,
                                                            java.util.Set<oracle.adf.view.rich.dnd.DnDAction> allowedActions,
                                                            oracle.adf.view.rich.dnd.DnDAction defaultAction,
                                                            java.lang.String discriminant,
                                                            javax.el.MethodExpression dragDropEndListener,
                                                            java.util.Map<java.lang.String,?> properties)

Specified by:

createDragSource in interface oracle.adf.view.rich.dnd.DragSourceFactory

createDragSourceBehavior

public java.lang.CharSequence createDragSourceBehavior(java.lang.String name,
                                                       oracle.adf.view.rich.dnd.DragSource dragSource,
                                                       java.util.Set<oracle.adf.view.rich.dnd.DnDAction> allowedActions,
                                                       oracle.adf.view.rich.dnd.DnDAction defaultAction,
                                                       java.lang.String discriminant,
                                                       javax.el.MethodExpression dragDropEndListener,
                                                       java.util.Map<java.lang.String,?> properties)

Specified by:

createDragSourceBehavior in interface oracle.adf.view.rich.dnd.DragSourceFactory