org.apache.myfaces.custom.navmenu.jscookmenu
Class HtmlCommandJSCookMenu

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UICommand
              org.apache.myfaces.custom.navmenu.jscookmenu.AbstractHtmlCommandJSCookMenu
                  org.apache.myfaces.custom.navmenu.jscookmenu.HtmlCommandJSCookMenu

All Implemented Interfaces:

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

public class HtmlCommandJSCookMenu
extends AbstractHtmlCommandJSCookMenu

Nested Class Summary

protected static class

HtmlCommandJSCookMenu.PropertyKeys

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_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

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

IMAGE_LIBRARY_ATTR, JAVASCRIPT_LIBRARY_ATTR, STYLE_LIBRARY_ATTR

Constructor Summary

HtmlCommandJSCookMenu()

Method Summary

java.lang.String	getEnabledOnUserRole() If user is in given role, this component will be rendered normally.
java.lang.String	getFamily()
java.lang.String	getImageLibrary()
java.lang.String	getImageLocation() An alternate location to find image resources.
java.lang.String	getJavascriptLibrary()
java.lang.String	getJavascriptLocation() An alternate location to find javascript resources.
java.lang.String	getLayout()
java.lang.String	getStyleLibrary()
java.lang.String	getStyleLocation() An alternate location to find stylesheet resources.
java.lang.String	getTheme()
java.lang.String	getVisibleOnUserRole() If user is in given role, this component will be rendered normally.
void	setEnabledOnUserRole(java.lang.String enabledOnUserRole)
void	setImageLibrary(java.lang.String imageLibrary)
void	setImageLocation(java.lang.String imageLocation)
void	setJavascriptLibrary(java.lang.String javascriptLibrary)
void	setJavascriptLocation(java.lang.String javascriptLocation)
void	setLayout(java.lang.String layout)
void	setStyleLibrary(java.lang.String styleLibrary)
void	setStyleLocation(java.lang.String styleLocation)
void	setTheme(java.lang.String theme)
void	setVisibleOnUserRole(java.lang.String visibleOnUserRole)

Methods inherited from class org.apache.myfaces.custom.navmenu.jscookmenu.AbstractHtmlCommandJSCookMenu

isRendered

Methods inherited from class javax.faces.component.UICommand

addActionListener, broadcast, getAction, getActionExpression, getActionListener, getActionListeners, getValue, isImmediate, queueEvent, removeActionListener, setAction, setActionExpression, setActionListener, setImmediate, 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, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, 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

Field Detail

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

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

HtmlCommandJSCookMenu

public HtmlCommandJSCookMenu()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UICommand

getLayout

public java.lang.String getLayout()

Specified by:

getLayout in class AbstractHtmlCommandJSCookMenu

setLayout

public void setLayout(java.lang.String layout)

getTheme

public java.lang.String getTheme()

Specified by:

getTheme in class AbstractHtmlCommandJSCookMenu

setTheme

public void setTheme(java.lang.String theme)

getEnabledOnUserRole

public java.lang.String getEnabledOnUserRole()

Description copied from interface: UserRoleAware

If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.

Returns:

setEnabledOnUserRole

public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)

getVisibleOnUserRole

public java.lang.String getVisibleOnUserRole()

Description copied from interface: UserRoleAware

If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.

Returns:

setVisibleOnUserRole

public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)

getJavascriptLocation

public java.lang.String getJavascriptLocation()

Description copied from interface: LocationAware

An alternate location to find javascript resources. If no values is specified, javascript will be loaded from the resources directory using AddResource and ExtensionsFilter.

setJavascriptLocation

public void setJavascriptLocation(java.lang.String javascriptLocation)

getImageLocation

public java.lang.String getImageLocation()

Description copied from interface: LocationAware

An alternate location to find image resources. If no values is specified, images will be loaded from the resources directory using AddResource and ExtensionsFilter.

setImageLocation

public void setImageLocation(java.lang.String imageLocation)

getStyleLocation

public java.lang.String getStyleLocation()

Description copied from interface: LocationAware

An alternate location to find stylesheet resources. If no values is specified, stylesheets will be loaded from the resources directory using AddResource and ExtensionsFilter.

setStyleLocation

public void setStyleLocation(java.lang.String styleLocation)

getJavascriptLibrary

public java.lang.String getJavascriptLibrary()

setJavascriptLibrary

public void setJavascriptLibrary(java.lang.String javascriptLibrary)

getImageLibrary

public java.lang.String getImageLibrary()

setImageLibrary

public void setImageLibrary(java.lang.String imageLibrary)

getStyleLibrary

public java.lang.String getStyleLibrary()

setStyleLibrary

public void setStyleLibrary(java.lang.String styleLibrary)