|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.UIXNavigationHierarchy
org.apache.myfaces.trinidad.component.UIXNavigationLevel
oracle.adf.view.rich.component.rich.nav.RichNavigationPane
public class RichNavigationPane
<html:p> The navigationPane component creates a series of navigation items representing one level in a navigation hierarchy. These items may either be explicitly added as children using the commandNavigationItem component or a model of type <html:code>org.apache.myfaces.trinidad.model.MenuModel</html:code> may be bound to the navigationPane component. If a MenuModel is bound, a level along the focus path, or the next level down, will be rendered. A node that is on the focus path will be rendered as "selected". </html:p> <html:p> <html:b>Note</html:b>: The 'level' attribute is temporary. It is used to indicate the level along the focusPath to render. It will likely be replaced with an el expression in a future release. </html:p> <html:p> The MenuModel implementation that are supported out-of-the-box, namely <html:code>org.apache.myfaces.trinidad.model.ProcessMenuModel</html:code> and <html:code>org.apache.myfaces.trinidad.model.XmlMenuModel</html:code>, know how to go from the current viewId to the focusRowKey. Notice that the MenuModel has no special knowledge of page navigation and places no requirements on the nodes that go into the tree. The nodes in the tree are stamped out using the 'nodeStamp' facet, which should contain a commandNavigationItem component. This allows the default actionListener mechanism to be used for page navigation. </html:p> <html:p> NavigationPane with hint='buttons' and hint='bar' look very similar. They have different separators. Additionally, here are the differences: <html:ul> <html:li>navigationPane with hint='buttons'</html:li> <html:ul> <html:li>Used as global navigation items</html:li> <html:li>Generally used in global navigation area of the page</html:li> <html:li>When display width is more than available screen width, they wrap to the next line</html:li> </html:ul> </html:ul> <html:ul> <html:li>navigationPane with hint='bar'</html:li> <html:ul> <html:li>Used as 4th level navigation tabs</html:li> <html:li>When there is not have enough horizontal space to display all items, the overflow compressed layout manager is used and overflow button(s) are displayed.</html:li> </html:ul> </html:ul> </html:p> <html:p> The navigationPane component does not render on a printable page (<af:showPrintablePageBehavior>). </html:p> <section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children if: <html:ul> <html:li>hint="tabs"</html:li> </html:ul> This component cannot be stretched by a parent layout component that stretches its children if: <html:ul> <html:li>hint is set to anything else</html:li> </html:ul> </html:li> <html:li>This component does not stretch its children.</html:li> </html:ul> </section> <section name="Supports_Compressed_Layout"> <html:p>NavigationPane with hint='tabs' or hint='bar' support compressed layout. For hint='bar', when the content is compressed the overflow compressed layout manager is used. For hint='tabs', when the content is compressed either overflow or conveyor belt compressed layout manager will be used. For this case, the compressed layout manager used depends on the assignment of the -tr-layout-type skinning key (see skinning documentation). In order for a compressed layout component to work properly, it must be part of a supported layout on the page.</html:p> <html:p>A compressed layout (overflow or conveyor belt) component requires that it is either:</html:p> <html:ul> <html:li>in a container that stretches its children, or</html:li> <html:li>in a container that has a set width.</html:li> </html:ul> <html:p>Under these circumstances, when the compressed layout component is larger than the parent container, the compressed layout component will display buttons to support its particular compressed layout mode (overflow or conveyor belt).</html:p> <html:p>For overflow compressed layout mode, selecting the overflow button(s) will show a popup containing the items that didn't fit on the page.</html:p> <html:p>For conveyor belt compressed layout mode, selecting the conveyor belt buttons will roll the shown content. In addition, there is a conveyor belt droplist button that shows a popup containing all of the managed items.</html:p> <html:p>Setting up a compressed layout (overflow or conveyor belt) component with the following layouts is not supported. If you use one of these layouts, you may have unexpected and inconsistent results:</html:p> <html:ul> <html:li>in a container that does not stretch its children.</html:li> <html:li>in a container that displays multiple children horizontally without explicit sizes for each child. For example, a panelGroupLayout with layout='horizontal' would be invalid, but panelSplitter is OK because it has an explicitly set splitter position.</html:li> <html:li>setting the compressed layout component with a styleClass or inlineStyle that assigns a percentage width value. Note that this includes assigning styleClass='AFStretchWidth' on a compressed layout component.</html:li> </html:ul> </section>
Type | Phases | Description |
---|---|---|
oracle.adf.view.rich.event.ItemEvent |
Apply Request Values | The itemEvent is triggered when a containing object has an event on one of its child items. For example, a panelTabbed will launch an itemEvent of type 'remove' for one of its child tabs. |
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 events might include the width of a column that supported client-side resizing. |
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_ATTRIBUTES_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_COMPONENT_KEY |
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 |
CUSTOMIZATION_ID_KEY Deprecated. |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DISABLED_KEY |
static java.lang.String |
HINT_BAR |
static java.lang.String |
HINT_BUTTONS |
static java.lang.String |
HINT_CHOICE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HINT_KEY |
static java.lang.String |
HINT_LIST |
static java.lang.String |
HINT_TABS |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static java.lang.String |
ITEM_REMOVAL_ALL |
static java.lang.String |
ITEM_REMOVAL_ALL_EXCEPT_LAST |
static org.apache.myfaces.trinidad.bean.PropertyKey |
ITEM_REMOVAL_KEY |
static java.lang.String |
ITEM_REMOVAL_NONE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_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 |
TITLE_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.UIXNavigationLevel |
---|
LEVEL_KEY, NODE_STAMP_FACET, 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 |
---|
bindings |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
|
RichNavigationPane() Construct an instance of the RichNavigationPane. |
protected |
RichNavigationPane(java.lang.String rendererType) Construct an instance of the RichNavigationPane. |
Method Summary | |
---|---|
void |
addItemListener(ItemListener listener) Adds a item listener. |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
java.util.Set |
getClientAttributes() Gets a set of client attribute names. |
ClientListenerSet |
getClientListeners() Gets a set of client listeners. |
java.lang.String |
getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
java.lang.String |
getFamily() |
java.lang.String |
getHint() Gets how the navigational items are displayed. |
java.lang.String |
getInlineStyle() Gets the CSS styles to use for this component. |
ItemListener[] |
getItemListeners() Returns an array of attached item listeners. |
java.lang.String |
getItemRemoval() Gets Determines if item removal is enabled. |
java.lang.String[] |
getPartialTriggers() Gets the IDs of the components that should trigger a partial update. |
java.lang.String |
getShortDesc() Gets the short description of the component. |
java.lang.String |
getStyleClass() Gets a CSS style class to use for this component. |
java.lang.String |
getTitle() Gets the text that describes the items. |
java.util.Set<java.lang.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 |
isClientComponent() Gets whether a client-side component will be generated. |
boolean |
isDisabled() Gets whether the component is disabled. |
boolean |
isVisible() Gets the visibility of the component. |
void |
removeItemListener(ItemListener listener) Removes a item listener. |
void |
setClientAttributes(java.util.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 |
setCustomizationId(java.lang.String customizationId) Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
void |
setDisabled(boolean disabled) Sets whether the component is disabled. |
void |
setHint(java.lang.String hint) Sets how the navigational items are displayed. |
void |
setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component. |
void |
setItemRemoval(java.lang.String itemRemoval) Sets Determines if item removal is enabled. |
void |
setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update. |
void |
setShortDesc(java.lang.String shortDesc) Sets the short description of the component. |
void |
setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component. |
void |
setTitle(java.lang.String title) Sets the text that describes the items. |
void |
setUnsecure(java.util.Set<java.lang.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.UIXNavigationLevel |
---|
getLevel, getNodeStamp, getValue, getVarStatus, processFacetsAndChildren, setLevel, setNodeStamp, setValue, setVarStatus |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXNavigationHierarchy |
---|
createCollectionModel, getFocusRowKey, getMenuModel |
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 |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXCollection |
---|
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, broadcast, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, decodeChildrenImpl, encodeBegin, encodeEnd, ensureRowsAvailable, getCachingStrategy, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postCreateCollectionModel, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, queueEvent, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, 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, getRendererType, 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, 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, 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 |
---|
public static final java.lang.String HINT_TABS
public static final java.lang.String HINT_BAR
public static final java.lang.String HINT_BUTTONS
public static final java.lang.String HINT_CHOICE
public static final java.lang.String HINT_LIST
public static final java.lang.String ITEM_REMOVAL_NONE
public static final java.lang.String ITEM_REMOVAL_ALL
public static final java.lang.String ITEM_REMOVAL_ALL_EXCEPT_LAST
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISABLED_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HINT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TITLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ITEM_REMOVAL_KEY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichNavigationPane()
protected RichNavigationPane(java.lang.String rendererType)
Method Detail |
---|
public final java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final boolean isDisabled()
public final void setDisabled(boolean disabled)
disabled
- the new disabled valuepublic final java.lang.String getHint()
public final void setHint(java.lang.String hint)
hint
- the new hint valuepublic final java.lang.String getTitle()
public final void setTitle(java.lang.String title)
title
- the new title valuepublic final java.lang.String getItemRemoval()
This attribute supports these itemRemoval types:
<html:ul> <html:li> none - item removal is not enabled. This is the default value. </html:li> <html:li> all - item removal is enabled on all tabs, regardless if they are disclosed. The last tab in the navigationPane can be removed.</html:li> <html:li> allExceptLast - item removal is enabled on all tabs, regardless if they are disclosed. The last tab in the navigationPane cannot be removed.</html:li> </html:ul>Choosing to remove an item will cause an ItemEvent of type 'remove' to be launched. This event can be listened for on a commandNavigationItem using the itemEventListener attribute. It is up to the developer to handle this event and code the actual removal of the tab. This is because of the dynamic nature of the navigationPane component, which may have dynamic children. This also allows a finer level of control by the developer, who can then choose a custom implementation that may (for example) include warning dialogs, and control of which item gains focus after an item is removed.
public final void setItemRemoval(java.lang.String itemRemoval)
This attribute supports these itemRemoval types:
<html:ul> <html:li> none - item removal is not enabled. This is the default value. </html:li> <html:li> all - item removal is enabled on all tabs, regardless if they are disclosed. The last tab in the navigationPane can be removed.</html:li> <html:li> allExceptLast - item removal is enabled on all tabs, regardless if they are disclosed. The last tab in the navigationPane cannot be removed.</html:li> </html:ul>Choosing to remove an item will cause an ItemEvent of type 'remove' to be launched. This event can be listened for on a commandNavigationItem using the itemEventListener attribute. It is up to the developer to handle this event and code the actual removal of the tab. This is because of the dynamic nature of the navigationPane component, which may have dynamic children. This also allows a finer level of control by the developer, who can then choose a custom implementation that may (for example) include warning dialogs, and control of which item gains focus after an item is removed.
itemRemoval
- the new itemRemoval valuepublic final void addItemListener(ItemListener listener)
listener
- the item listener to addpublic final void removeItemListener(ItemListener listener)
listener
- the item listener to removepublic final ItemListener[] getItemListeners()
public java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXNavigationLevel
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXNavigationLevel
|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |