Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.0.0)

E12063-01


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

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXCollection
                  extended by org.apache.myfaces.trinidad.component.UIXHierarchy
                      extended by oracle.adf.view.faces.bi.component.hierarchyViewer.UIHierarchyViewer

All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder, org.apache.myfaces.trinidad.component.CollectionComponent, org.apache.myfaces.trinidad.model.RowKeyIndex

public class UIHierarchyViewer
extends org.apache.myfaces.trinidad.component.UIXHierarchy
Since:
release specific (what release of product did this appear in)

Field Summary
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 CUSTOMIZATION_ID_KEY
           
protected static java.lang.String DEFAULT_CONTENT_DELIVERY_MODE
           
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
           
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 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 org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey PERSIST_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 javax.faces.component.NamingContainer
SEPARATOR_CHAR

 

Constructor Summary
UIHierarchyViewer()
          Constructs an instance of the UIHierarchyViewer.

 

Method Summary
 void broadcast(javax.faces.event.FacesEvent event)
          Delivers a wrapped event to the appropriate component.
protected  void broadcastNodeActionEvent(NodeActionEvent nae)
           
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 java.lang.String getClientRowKey()
           
 java.lang.String getContentDelivery()
          Gets whether data should be fetched when the component is rendered initially.
 java.lang.String getCustomizationId()
          Gets The id used to locate this component when applying persistent customizations.
 int getDisplayLevelsAncestor()
           
 int getDisplayLevelsChildren()
           
 java.lang.String[] getDontPersist()
          Gets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
 java.lang.String getFamily()
           
 java.lang.Object getFocusRowKey()
           
 java.lang.String getInlineStyle()
          Gets the CSS styles to use for this component.
 java.lang.String getLayout()
           
 int getLevelFetchSize()
           
 java.util.Locale getLocale()
          Retrieves the locale for the Topology Viewer.
 javax.el.MethodExpression getNavigateUpListener()
           
 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".
 java.lang.String getRendererType()
           
 javax.el.MethodExpression getSelectionListener()
           
 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()
           
protected  void processFacetsAndChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
           
 void queueEvent(javax.faces.event.FacesEvent event)
          Queues an event.
 void setContentDelivery(java.lang.String deliveryMode)
          Sets whether data should be fetched when the component is rendered initially.
 void setCustomizationId(java.lang.String customizationId)
          Sets The id used to locate this component when applying persistent customizations.
 void setDisplayLevelsAncestor(int nDisplayLevelsAncestor)
           
 void setDisplayLevelsChildren(int nDisplayLevelsChildren)
           
 void setDontPersist(java.lang.String[] dontPersist)
          Sets List of persistent attributes that are restricted from persisting to a registered "Persistent Change Manager".
 void setFocusRowKey(java.lang.Object focusRowKey)
           
 void setInlineStyle(java.lang.String inlineStyle)
          Sets the CSS styles to use for this component.
 void setLayout(java.lang.String layout)
           
 void setLevelFetchSize(int levelFetchSize)
           
 void setLocale(java.util.Locale locale)
          Specifies the locale for the Topology Viewer.
 void setNavigateUpListener(javax.el.MethodExpression navigateUpLIstener)
           
 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".
 void setRowKey(java.lang.Object rowKey)
          Makes a row current.
 void setSelectionListener(javax.el.MethodExpression selectionListener)
           
 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)
           

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXHierarchy
createCollectionModel, enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getFirst, getRows, getStamps, getTreeModel, isContainer, isContainerEmpty

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXCollection
clearCurrencyStringCache, createVarStatusMap, decodeChildrenImpl, encodeBegin, encodeEnd, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isSortable, 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, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, encodeAll, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendersChildren, getValueBinding, getValueExpression, isRendered, isTransient, markInitialState, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, 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
processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren

 

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

 

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

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

SELECTION_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SELECTION_LISTENER_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

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_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

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

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

public final java.lang.String getCustomizationId()
Gets The id used to locate this component when applying persistent customizations. Components without a customizationId set can not save customizations to the persistent store. Instead, any customizations will at most only apply to the current Session. Each customizationId must be unique in the document.
Returns:
the new customizationId value

setCustomizationId

public final void setCustomizationId(java.lang.String customizationId)
Sets The id used to locate this component when applying persistent customizations. Components without a customizationId set can not save customizations to the persistent store. Instead, any customizations will at most only apply to the current Session. Each customizationId must be unique in the document.
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. 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.
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. 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.
Parameters:
contentDelivery - the new contentDelivery value

getLayout

public final java.lang.String getLayout()

setLayout

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

getFocusRowKey

public final java.lang.Object getFocusRowKey()
Specified by:
getFocusRowKey in class org.apache.myfaces.trinidad.component.UIXHierarchy

setFocusRowKey

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

getDisplayLevelsChildren

public final int getDisplayLevelsChildren()

setDisplayLevelsChildren

public final void setDisplayLevelsChildren(int nDisplayLevelsChildren)

getDisplayLevelsAncestor

public final int getDisplayLevelsAncestor()

setDisplayLevelsAncestor

public final void setDisplayLevelsAncestor(int nDisplayLevelsAncestor)

getLevelFetchSize

public final int getLevelFetchSize()

setLevelFetchSize

public final void setLevelFetchSize(int levelFetchSize)

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)

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

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()

setSelectionListener

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

getNavigateUpListener

public final javax.el.MethodExpression getNavigateUpListener()

setNavigateUpListener

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

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.0.0)

E12063-01


Copyright © 1997, 2008, Oracle. All rights reserved.