Skip navigation links

oracle.adf.view.rich.component
Class UIXMenuBar

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXPanel
oracle.adf.view.rich.component.UIXMenuBar

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

RichMenuBar

public class UIXMenuBar

extends org.apache.myfaces.trinidad.component.UIXPanel

Events:

Type	Phases	Description
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

class

UIXMenuBar.MenuNavigationHierarchy Inner class that provides the collection and navigable hierarchy behavior.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	NODE_STAMP_FACET
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_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	VAR_STATUS_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

Constructor Summary

	UIXMenuBar() Construct an instance of the UIXMenuBar.
protected	UIXMenuBar(java.lang.String rendererType) Construct an instance of the UIXMenuBar.

Method Summary

void	broadcast(javax.faces.event.FacesEvent event) Delivers a wrapped event to the appropriate component.
protected void	decodeChildrenImpl(javax.faces.context.FacesContext context) Calls processFacetsAndChildren on the collection object.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
UIXMenuBar.MenuNavigationHierarchy	getCollectionObject()
java.lang.String	getFamily()
javax.faces.component.UIComponent	getNodeStamp() the component to use to stamp each element in the navigation.
java.lang.Object	getValue() Gets the hierarchy of navigation data - must be of type org.apache.myfaces.trinidad.model.MenuModel.
java.lang.String	getVar() Gets Name of the EL variable used to reference each element of this collection.
java.lang.String	getVarStatus() Gets Name of the EL variable used to reference the varStatus information.
void	queueEvent(javax.faces.event.FacesEvent event) Queues an event.
void	setNodeStamp(javax.faces.component.UIComponent nodeStampFacet) the component to use to stamp each element in the navigation.
void	setValue(java.lang.Object value) Sets the hierarchy of navigation data - must be of type org.apache.myfaces.trinidad.model.MenuModel.
void	setVar(java.lang.String var) Sets Name of the EL variable used to reference each element of this collection.
void	setVarStatus(java.lang.String varStatus) Sets Name of the EL variable used to reference the varStatus information.

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

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

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

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, 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

Field Detail

TYPE

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

VAR_KEY

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

VALUE_KEY

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

VAR_STATUS_KEY

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

NODE_STAMP_FACET

public static final java.lang.String NODE_STAMP_FACET

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

UIXMenuBar

public UIXMenuBar()

Construct an instance of the UIXMenuBar.

UIXMenuBar

protected UIXMenuBar(java.lang.String rendererType)

Construct an instance of the UIXMenuBar.

Method Detail

getCollectionObject

public UIXMenuBar.MenuNavigationHierarchy getCollectionObject()

Returns:

returns the collection object associated with the model

decodeChildrenImpl

protected void decodeChildrenImpl(javax.faces.context.FacesContext context)

Calls processFacetsAndChildren on the collection object.

Overrides:

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

Parameters:

context - the current FacesContext

queueEvent

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

Queues an event. If there is a currency set on the menuModel, 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.UIXComponentBase

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.UIXComponentBase

Parameters:

event - a FacesEvent

Throws:

javax.faces.event.AbortProcessingException

getNodeStamp

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

the component to use to stamp each element in the navigation. A CommandNavigationItem is expected. This facet is only needed when attaching the menuBar to a menu model.

setNodeStamp

public final void setNodeStamp(javax.faces.component.UIComponent nodeStampFacet)

the component to use to stamp each element in the navigation. A CommandNavigationItem is expected. This facet is only needed when attaching the menuBar to a menu model.

getVar

public final java.lang.String getVar()

Gets Name of the EL variable used to reference each element of this collection. Once this component has completed rendering, this variable is removed (or reverted back to its previous value). This attribute is only needed when attaching the menuBar to a menu model.

Returns:

the new var value

setVar

public final void setVar(java.lang.String var)

Sets Name of the EL variable used to reference each element of this collection. Once this component has completed rendering, this variable is removed (or reverted back to its previous value). This attribute is only needed when attaching the menuBar to a menu model.

Parameters:

var - the new var value

getValue

public final java.lang.Object getValue()

Gets the hierarchy of navigation data - must be of type org.apache.myfaces.trinidad.model.MenuModel. This attribute is only needed when attaching the menuBar to a menu model.

Returns:

the new value value

setValue

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

Sets the hierarchy of navigation data - must be of type org.apache.myfaces.trinidad.model.MenuModel. This attribute is only needed when attaching the menuBar to a menu model.

Parameters:

value - the new value value

getVarStatus

public final java.lang.String getVarStatus()

Gets Name of the EL variable used to reference the varStatus information. Once this component has completed rendering, this variable is removed (or reverted back to its previous value). The VarStatus provides contextual information about the state of the component to EL expressions. For components that iterate, varStatus also provides loop counter information. Please see the this component's documentation for the specific properties on the varStatus. The common properties on varStatus include:

• "model" - returns the CollectionModel for this component
• "index" - returns the zero based row index

This attribute is only needed when attaching the menuBar to a menu model.

Returns:

the new varStatus value

setVarStatus

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

Sets Name of the EL variable used to reference the varStatus information. Once this component has completed rendering, this variable is removed (or reverted back to its previous value). The VarStatus provides contextual information about the state of the component to EL expressions. For components that iterate, varStatus also provides loop counter information. Please see the this component's documentation for the specific properties on the varStatus. The common properties on varStatus include:

• "model" - returns the CollectionModel for this component
• "index" - returns the zero based row index

This attribute is only needed when attaching the menuBar to a menu model.

Parameters:

varStatus - the new varStatus value

getFamily

public java.lang.String getFamily()

Overrides:

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

getBeanType

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

Overrides:

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

Skip navigation links