org.apache.myfaces.custom.navigation

Class HtmlCommandNavigation

Implemented Interfaces:
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

static String
COMPONENT_FAMILY
static String
COMPONENT_TYPE

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

COMPONENT_TYPE

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

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Constructor Summary

HtmlCommandNavigation()

Method Summary

void
broadcast(FacesEvent event)
String
getFamily()
boolean
isActive()
boolean
isImmediate()
boolean
isOpen()
boolean
isRendered()
void
restoreState(FacesContext context, Object state)
Object
saveState(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, isRendered, restoreState, saveState, setEnabledOnUserRole, setTarget, setVisibleOnUserRole

Field Details

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

COMPONENT_TYPE

public static final String COMPONENT_TYPE

Constructor Details

HtmlCommandNavigation

public HtmlCommandNavigation()

Method Details

broadcast

public void broadcast(FacesEvent event)
            throws AbortProcessingException

getFamily

public String getFamily()

isActive

public boolean isActive()

isImmediate

public boolean isImmediate()

isOpen

public boolean isOpen()

isRendered

public boolean isRendered()
Overrides:
isRendered in interface HtmlCommandLink
Returns:
false, if this item is child of another HtmlCommandNavigation, which is closed

restoreState

public void restoreState(FacesContext context,
                         Object state)
Overrides:
restoreState in interface HtmlCommandLink

saveState

public Object saveState(FacesContext context)
Overrides:
saveState in interface HtmlCommandLink

setActive

public void setActive(boolean active)

setImmediate

public void setImmediate(boolean immediate)

setOpen

public void setOpen(boolean open)

toggleOpen

public void toggleOpen()