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:

javax.faces.component.ActionSource, javax.faces.component.StateHolder, UserRoleAware

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 String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

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()
abstract javax.faces.el.MethodBinding	getAction() 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()
Boolean	getActiveDirectly()
abstract String	getActiveOnViewIds()
String	getActiveOnViewIdsDirectly()
abstract String	getDisabledStyle() CSS-Style Attribute to render when disabled is true
abstract String	getDisabledStyleClass() CSS-Style Class to use when disabled is true
abstract String	getExternalLink()
String	getFamily()
abstract String	getIcon()
protected abstract String	getLocalActiveOnViewIds()
abstract 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	restoreState(javax.faces.context.FacesContext facesContext, Object state)
Object	saveState(javax.faces.context.FacesContext facesContext)
abstract void	setAction(javax.faces.el.MethodBinding action)
abstract void	setActionListener(javax.faces.el.MethodBinding actionListener)
abstract void	setActive(boolean active)
abstract void	setOpen(boolean open)
void	setRendered(boolean rendered)
void	toggleActive(javax.faces.context.FacesContext context)

Methods inherited from class javax.faces.component.UISelectItem

getItemDescription, getItemLabel, getItemValue, getValue, isItemDisabled, setItemDescription, setItemDisabled, setItemLabel, setItemValue, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendererType, setTransient, setValueBinding

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 String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

AbstractUINavigationMenuItem

public AbstractUINavigationMenuItem()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UISelectItem

getIcon

public abstract String getIcon()

isSplit

public abstract boolean isSplit()

isOpen

public abstract boolean isOpen()

setOpen

public abstract void setOpen(boolean open)

setActive

public abstract void setActive(boolean active)

isActive

public abstract boolean isActive()

isImmediate

public abstract boolean isImmediate()

Specified by:

isImmediate in interface javax.faces.component.ActionSource

getExternalLink

public abstract String getExternalLink()

setAction

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

Specified by:

setAction in interface javax.faces.component.ActionSource

getAction

public abstract javax.faces.el.MethodBinding getAction()

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.

Specified by:

getAction 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

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

public abstract String getTarget()

isDisabled

public abstract boolean isDisabled()

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

getDisabledStyle

public abstract 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

public abstract String getDisabledStyleClass()

CSS-Style Class to use when disabled is true

getActiveOnViewIds

public abstract String getActiveOnViewIds()

getLocalActiveOnViewIds

protected abstract String getLocalActiveOnViewIds()

getActiveOnViewIdsDirectly

public String getActiveOnViewIdsDirectly()

isRendered

public boolean isRendered()

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

Overrides:

isRendered in class javax.faces.component.UISelectItem

setRendered

public void setRendered(boolean rendered)

Overrides:

setRendered in class javax.faces.component.UISelectItem

saveState

public Object saveState(javax.faces.context.FacesContext facesContext)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UISelectItem

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UISelectItem

toggleActive

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

deactivateAll

public void deactivateAll()

deactivateChildren

public void deactivateChildren()

getActiveDirectly

public Boolean getActiveDirectly()