org.apache.myfaces.custom.navmenu
Class AbstractUINavigationMenuItem

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UISelectItem
              org.apache.myfaces.custom.navmenu.AbstractUINavigationMenuItem

All Implemented Interfaces:

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

Direct Known Subclasses:

UINavigationMenuItem

@JSFComponent(name="t:navigationMenuItem",
              bodyContent="JSP",
              clazz="org.apache.myfaces.custom.navmenu.UINavigationMenuItem",
              tagClass="org.apache.myfaces.custom.navmenu.HtmlNavigationMenuItemTag")
public abstract class AbstractUINavigationMenuItem
extends javax.faces.component.UISelectItem
implements UserRoleAware, javax.faces.component.ActionSource

A menu item. Used by navigationMenu, jscookMenu. Unless otherwise specified, all attributes accept static values or EL expressions.

Since:

1.1.7

Version:

$Revision: 719425 $ $Date: 2008-11-20 18:41:15 -0500 (Thu, 20 Nov 2008) $

Author:

Thomas Spiegl (latest modification by $Author: lu4242 $)

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE

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 org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Constructor Summary

AbstractUINavigationMenuItem()

Method Summary

void	addActionListener(javax.faces.event.ActionListener listener)
void	broadcast(javax.faces.event.FacesEvent event)
void	deactivateAll()
void	deactivateChildren()
javax.faces.el.MethodBinding	getAction() Deprecated. Use getActionExpression() instead.
abstract javax.el.MethodExpression	getActionExpression() Specifies the action to take when this command is invoked.
abstract javax.faces.el.MethodBinding	getActionListener() A method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user.
javax.faces.event.ActionListener[]	getActionListeners()
java.lang.Boolean	getActiveDirectly()
abstract java.lang.String	getActiveOnViewIds()
java.lang.String	getActiveOnViewIdsDirectly()
abstract java.lang.String	getDisabledStyle() CSS-Style Attribute to render when disabled is true
abstract java.lang.String	getDisabledStyleClass() CSS-Style Class to use when disabled is true
abstract java.lang.String	getExternalLink()
java.lang.String	getFamily()
abstract java.lang.String	getIcon()
protected abstract java.lang.String	getLocalActiveOnViewIds()
abstract java.lang.String	getTarget()
abstract boolean	isActive()
abstract boolean	isDisabled() When set instead of a Hyperlink a span tag is rendered in the corresponding Component
abstract boolean	isImmediate()
abstract boolean	isOpen()
boolean	isRendered() A boolean value that indicates whether this component should be rendered.
abstract boolean	isSplit()
void	removeActionListener(javax.faces.event.ActionListener listener)
void	setAction(javax.faces.el.MethodBinding action) Deprecated. Use setActionExpression instead.
abstract void	setActionExpression(javax.el.MethodExpression actionExpression)
abstract void	setActionListener(javax.faces.el.MethodBinding actionListener)
abstract void	setActive(boolean active)
abstract void	setOpen(boolean open)
void	toggleActive(javax.faces.context.FacesContext context)

Methods inherited from class javax.faces.component.UISelectItem

getItemDescription, getItemLabel, getItemValue, getValue, isItemDisabled, isItemEscaped, isNoSelectionOption, setItemDescription, setItemDisabled, setItemEscaped, setItemLabel, setItemValue, setNoSelectionOption, setRendered, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, initialStateMarked, invokeOnComponent, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendererType, setTransient, setValueBinding, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.myfaces.component.UserRoleAware

getEnabledOnUserRole, getVisibleOnUserRole, setEnabledOnUserRole, setVisibleOnUserRole

Methods inherited from interface javax.faces.component.ActionSource

setImmediate

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

AbstractUINavigationMenuItem

public AbstractUINavigationMenuItem()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UISelectItem

getIcon

@JSFProperty
public abstract java.lang.String getIcon()

isSplit

@JSFProperty(defaultValue="false")
public abstract boolean isSplit()

isOpen

@JSFProperty(defaultValue="false",
             tagExcluded=true)
public abstract boolean isOpen()

setOpen

public abstract void setOpen(boolean open)

setActive

public abstract void setActive(boolean active)

isActive

@JSFProperty(defaultValue="false",
             tagExcluded=true)
public abstract boolean isActive()

isImmediate

@JSFProperty(defaultValue="true",
             tagExcluded=true)
public abstract boolean isImmediate()

Specified by:

isImmediate in interface javax.faces.component.ActionSource

getExternalLink

@JSFProperty(tagExcluded=true)
public abstract java.lang.String getExternalLink()

getActionExpression

@JSFProperty(stateHolder=true,
             literalOnly=true,
             returnSignature="java.lang.Object",
             jspName="action")
public abstract javax.el.MethodExpression getActionExpression()

Specifies the action to take when this command is invoked. If the value is an expression, it is expected to be a method binding EL expression that identifies an action method. An action method accepts no parameters and has a String return value, called the action outcome, that identifies the next view displayed. The phase that this event is fired in can be controlled via the immediate attribute. If the value is a string literal, it is treated as a navigation outcome for the current view. This is functionally equivalent to a reference to an action method that returns the string literal.

getAction

public javax.faces.el.MethodBinding getAction()

Deprecated. Use getActionExpression() instead.

Specified by:

getAction in interface javax.faces.component.ActionSource

setActionExpression

public abstract void setActionExpression(javax.el.MethodExpression actionExpression)

setAction

public void setAction(javax.faces.el.MethodBinding action)

Deprecated. Use setActionExpression instead.

Specified by:

setAction in interface javax.faces.component.ActionSource

setActionListener

public abstract void setActionListener(javax.faces.el.MethodBinding actionListener)

Specified by:

setActionListener in interface javax.faces.component.ActionSource

getActionListener

@JSFProperty(stateHolder=true,
             literalOnly=true,
             returnSignature="void",
             methodSignature="javax.faces.event.ActionEvent")
public abstract javax.faces.el.MethodBinding getActionListener()

A method binding EL expression that identifies an action listener method to be invoked if this component is activated by the user. An action listener method accepts a parameter of type javax.faces.event.ActionEvent and returns void. The phase that this event is fired in can be controlled via the immediate attribute.

Specified by:

getActionListener in interface javax.faces.component.ActionSource

addActionListener

public void addActionListener(javax.faces.event.ActionListener listener)

Specified by:

addActionListener in interface javax.faces.component.ActionSource

getActionListeners

public javax.faces.event.ActionListener[] getActionListeners()

Specified by:

getActionListeners in interface javax.faces.component.ActionSource

removeActionListener

public void removeActionListener(javax.faces.event.ActionListener listener)

Specified by:

removeActionListener in interface javax.faces.component.ActionSource

getTarget

@JSFProperty
public abstract java.lang.String getTarget()

isDisabled

@JSFProperty(defaultValue="false")
public abstract boolean isDisabled()

When set instead of a Hyperlink a span tag is rendered in the corresponding Component

getDisabledStyle

@JSFProperty
public abstract java.lang.String getDisabledStyle()

CSS-Style Attribute to render when disabled is true

broadcast

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

Overrides:

broadcast in class javax.faces.component.UIComponentBase

Throws:

javax.faces.event.AbortProcessingException

See Also:

UIComponent.broadcast(javax.faces.event.FacesEvent)

getDisabledStyleClass

@JSFProperty
public abstract java.lang.String getDisabledStyleClass()

CSS-Style Class to use when disabled is true

getActiveOnViewIds

@JSFProperty(localMethod=true,
             tagExcluded=true)
public abstract java.lang.String getActiveOnViewIds()

getLocalActiveOnViewIds

protected abstract java.lang.String getLocalActiveOnViewIds()

getActiveOnViewIdsDirectly

public java.lang.String getActiveOnViewIdsDirectly()

isRendered

@JSFProperty(tagExcluded=false)
public boolean isRendered()

A boolean value that indicates whether this component should be rendered. Default value: true.

Overrides:

isRendered in class javax.faces.component.UIComponentBase

toggleActive

public void toggleActive(javax.faces.context.FacesContext context)

deactivateAll

public void deactivateAll()

deactivateChildren

public void deactivateChildren()

getActiveDirectly

public java.lang.Boolean getActiveDirectly()