org.apache.myfaces.custom.navigation

Class HtmlCommandNavigation

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UICommand

javax.faces.component.html.HtmlCommandLink

org.apache.myfaces.component.html.ext.HtmlCommandLink

org.apache.myfaces.custom.navigation.HtmlCommandNavigation

All Implemented Interfaces:

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

public class HtmlCommandNavigation
extends HtmlCommandLink

Command, that represents a navigation item.

Version:

$Revision: 167507 $ $Date: 2005-01-09 22:56:33 +0100 (Sun, 09 Jan 2005) $

Author:

Manfred Geiler (latest modification by $Author: tomsp $)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE

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

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Constructor Summary

Constructors

Constructor and Description
HtmlCommandNavigation()

Method Summary

Methods

Modifier and Type	Method and Description
void	broadcast(javax.faces.event.FacesEvent event)
java.lang.String	getFamily()
boolean	isActive()
boolean	isImmediate()
boolean	isOpen()
boolean	isRendered()
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setActive(boolean active)
void	setImmediate(boolean immediate)
void	setOpen(boolean open)
void	toggleOpen()

Methods inherited from class org.apache.myfaces.component.html.ext.HtmlCommandLink

getClientId, getEnabledOnUserRole, getTarget, getVisibleOnUserRole, setEnabledOnUserRole, setTarget, setVisibleOnUserRole

Methods inherited from class javax.faces.component.html.HtmlCommandLink

getAccesskey, getCharset, getCoords, getDir, getHreflang, getLang, getOnblur, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRel, getRev, getShape, getStyle, getStyleClass, getTabindex, getTitle, getType, setAccesskey, setCharset, setCoords, setDir, setHreflang, setLang, setOnblur, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRel, setRev, setShape, setStyle, setStyleClass, setTabindex, setTitle, setType

Methods inherited from class javax.faces.component.UICommand

addActionListener, getAction, getActionListener, getActionListeners, getValue, queueEvent, removeActionListener, setAction, setActionListener, setValue

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class java.lang.Object

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

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

HtmlCommandNavigation

public HtmlCommandNavigation()

Method Detail

isImmediate

public boolean isImmediate()

Specified by:

isImmediate in interface javax.faces.component.ActionSource

Overrides:

isImmediate in class javax.faces.component.UICommand

setImmediate

public void setImmediate(boolean immediate)

Specified by:

setImmediate in interface javax.faces.component.ActionSource

Overrides:

setImmediate in class javax.faces.component.UICommand

isOpen

public boolean isOpen()

setOpen

public void setOpen(boolean open)

isActive

public boolean isActive()

setActive

public void setActive(boolean active)

isRendered

public boolean isRendered()

Overrides:

isRendered in class HtmlCommandLink

Returns:

false, if this item is child of another HtmlCommandNavigation, which is closed

toggleOpen

public void toggleOpen()

broadcast

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

Overrides:

broadcast in class javax.faces.component.UICommand

Throws:

javax.faces.event.AbortProcessingException

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class HtmlCommandLink

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class HtmlCommandLink

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UICommand