Skip navigation links

oracle.adf.view.rich.component.rich.nav
Class RichNavigationPane

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

All Implemented Interfaces:

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

public class RichNavigationPane

extends org.apache.myfaces.trinidad.component.UIXNavigationLevel

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

<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> <html:b>Note</html:b>: When using Facelets for the page declaration language (PDL), the 'nodestamp' facet should still contain only one commandNavigationItem. Multiple components are not supported by this facet. </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 there is not have enough horizontal space to display all items, 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, they are put into overflow and an overflow button is 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:li>hint="bar"</html:li> </html:ul> This component cannot be stretched by a parent layout component that stretches its children if: <html:ul> <html:li>hint="buttons"</html:li> <html:li>hint="choice"</html:li> </html:ul> </html:li> <html:li>This component does not stretch its children.</html:li> </html:ul> </section> <section name="Overflow"> <html:p>NavigationPane with hint='tabs' or hint='bar' is an overflow component. It must be part of a supported layout in order to work properly on the page.</html:p> <html:p>An overflow 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 overflow component is larger than the parent container, the overflow component will display an overflow button. Selecting the overflow button will show a popup containing the items that didn't fit on the page.</html:p> <html:p>Setting up an overflow 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 overflow component with a styleClass or inlineStyle that assigns a percentage width value. Note that this includes assigning styleClass='AFStretchWidth' on an overflow component.</html:li> </html:ul> </section>

Events:

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 event might include the width of a column that supported client-side resizing.

Nested Class Summary

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

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

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

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

Field Summary

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

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

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	addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
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.
java.util.Map<java.lang.String,java.util.List<javax.faces.component.behavior.ClientBehavior>>	getClientBehaviors()
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	getDefaultEventName()
java.util.Collection<java.lang.String>	getEventNames()
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, visitChildren, visitData

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, enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getFirst, getRows, getStamps, getTreeModel, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isContainer, isContainerEmpty, visitHierarchy, visitLevel

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

areRowsAvailable, areRowsAvailable, areRowsAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, broadcast, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, createVarStatusMap, decodeChildrenImpl, defaultVisitChildren, encodeBegin, encodeEnd, getCachingStrategy, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getVar, invokeOnComponent, isRowAvailable, 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, visitChildrenWithoutIterating, visitUnstampedFacets

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

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

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

addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView

Methods inherited from class java.lang.Object

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

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

getVar

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

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

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

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

Field Detail

HINT_TABS

public static final java.lang.String HINT_TABS

See Also:

Constant Field Values

HINT_BAR

public static final java.lang.String HINT_BAR

See Also:

Constant Field Values

HINT_BUTTONS

public static final java.lang.String HINT_BUTTONS

See Also:

Constant Field Values

HINT_CHOICE

public static final java.lang.String HINT_CHOICE

See Also:

Constant Field Values

HINT_LIST

public static final java.lang.String HINT_LIST

See Also:

Constant Field Values

ITEM_REMOVAL_NONE

public static final java.lang.String ITEM_REMOVAL_NONE

See Also:

Constant Field Values

ITEM_REMOVAL_ALL

public static final java.lang.String ITEM_REMOVAL_ALL

See Also:

Constant Field Values

ITEM_REMOVAL_ALL_EXCEPT_LAST

public static final java.lang.String ITEM_REMOVAL_ALL_EXCEPT_LAST

See Also:

Constant Field Values

TYPE

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

INLINE_STYLE_KEY

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

STYLE_CLASS_KEY

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

SHORT_DESC_KEY

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

UNSECURE_KEY

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

VISIBLE_KEY

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

CUSTOMIZATION_ID_KEY

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

Deprecated.

CLIENT_COMPONENT_KEY

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

CLIENT_ATTRIBUTES_KEY

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

PARTIAL_TRIGGERS_KEY

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

CLIENT_LISTENERS_KEY

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

DISABLED_KEY

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

HINT_KEY

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

TITLE_KEY

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

ITEM_REMOVAL_KEY

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

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

RichNavigationPane

public RichNavigationPane()

Construct an instance of the RichNavigationPane.

RichNavigationPane

protected RichNavigationPane(java.lang.String rendererType)

Construct an instance of the RichNavigationPane.

Method Detail

getInlineStyle

public final java.lang.String getInlineStyle()

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

Returns:

the new inlineStyle value

setInlineStyle

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

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

Parameters:

inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()

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

Returns:

the new styleClass value

setStyleClass

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

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

Parameters:

styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.

Returns:

the new shortDesc value

setShortDesc

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

Sets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.

Parameters:

shortDesc - the new shortDesc value

getUnsecure

public final 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. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Returns:

the new unsecure value

setUnsecure

public final void setUnsecure(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. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.

Parameters:

unsecure - the new unsecure value

isVisible

public final boolean isVisible()

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

Returns:

the new visible value

setVisible

public final void setVisible(boolean visible)

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

Parameters:

visible - the new visible value

getCustomizationId

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

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

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

Returns:

the new customizationId value

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String customizationId)

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

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

Parameters:

customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()

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

Returns:

the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)

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

Parameters:

clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()

Gets a set of client attribute names.

Returns:

the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)

Sets a set of client attribute names.

Parameters:

clientAttributes - the new clientAttributes value

getPartialTriggers

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

Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Returns:

the new partialTriggers value

setPartialTriggers

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

Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.

Parameters:

partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()

Gets a set of client listeners.

Returns:

the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)

Sets a set of client listeners.

Parameters:

clientListeners - the new clientListeners value

isDisabled

public final boolean isDisabled()

Gets whether the component is disabled.

Returns:

the new disabled value

setDisabled

public final void setDisabled(boolean disabled)

Sets whether the component is disabled.

Parameters:

disabled - the new disabled value

getHint

public final java.lang.String getHint()

Gets how the navigational items are displayed. Options are:

• bar - display items separated by a bar
• buttons - display items with a vertical separator between them
• choice - display items in a popup list when icon is clicked
• list - display items in a bulleted list
• tabs - display each item in a tab

Returns:

the new hint value

setHint

public final void setHint(java.lang.String hint)

Sets how the navigational items are displayed. Options are:

• bar - display items separated by a bar
• buttons - display items with a vertical separator between them
• choice - display items in a popup list when icon is clicked
• list - display items in a bulleted list
• tabs - display each item in a tab

Parameters:

hint - the new hint value

getTitle

public final java.lang.String getTitle()

Gets the text that describes the items. (This attribute is only applicable if the rendering hint supports it, e.g. "choice".)

Returns:

the new title value

setTitle

public final void setTitle(java.lang.String title)

Sets the text that describes the items. (This attribute is only applicable if the rendering hint supports it, e.g. "choice".)

Parameters:

title - the new title value

getItemRemoval

public final java.lang.String getItemRemoval()

Gets Determines if item removal is enabled. Item removal is only supported if hint=tabs.

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.

Returns:

the new itemRemoval value

setItemRemoval

public final void setItemRemoval(java.lang.String itemRemoval)

Sets Determines if item removal is enabled. Item removal is only supported if hint=tabs.

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.

Parameters:

itemRemoval - the new itemRemoval value

addItemListener

public final void addItemListener(ItemListener listener)

Adds a item listener.

Parameters:

listener - the item listener to add

removeItemListener

public final void removeItemListener(ItemListener listener)

Removes a item listener.

Parameters:

listener - the item listener to remove

getItemListeners

public final ItemListener[] getItemListeners()

Returns an array of attached item listeners.

Returns:

an array of attached item listeners.

getDefaultEventName

public java.lang.String getDefaultEventName()

Specified by:

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

Overrides:

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

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

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

getClientBehaviors

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

Specified by:

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

Overrides:

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

addClientBehavior

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

Specified by:

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

Overrides:

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

getFamily

public java.lang.String getFamily()

Overrides:

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

getBeanType

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

Overrides:

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

Skip navigation links