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

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UICommand
              extended by org.apache.myfaces.custom.navmenu.jscookmenu.AbstractHtmlCommandJSCookMenu
                  extended by org.apache.myfaces.custom.navmenu.jscookmenu.HtmlCommandJSCookMenu
All Implemented Interfaces:
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 String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static 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
 String getEnabledOnUserRole()
          If user is in given role, this component will be rendered normally.
 String getFamily()
           
 String getImageLibrary()
           
 String getImageLocation()
          An alternate location to find image resources.
 String getJavascriptLibrary()
           
 String getJavascriptLocation()
          An alternate location to find javascript resources.
 String getLayout()
           
 String getStyleLibrary()
           
 String getStyleLocation()
          An alternate location to find stylesheet resources.
 String getTheme()
           
 String getVisibleOnUserRole()
          If user is in given role, this component will be rendered normally.
 void setEnabledOnUserRole(String enabledOnUserRole)
           
 void setImageLibrary(String imageLibrary)
           
 void setImageLocation(String imageLocation)
           
 void setJavascriptLibrary(String javascriptLibrary)
           
 void setJavascriptLocation(String javascriptLocation)
           
 void setLayout(String layout)
           
 void setStyleLibrary(String styleLibrary)
           
 void setStyleLocation(String styleLocation)
           
 void setTheme(String theme)
           
 void setVisibleOnUserRole(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, encodeAll, 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
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 String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

DEFAULT_RENDERER_TYPE

public static final String DEFAULT_RENDERER_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlCommandJSCookMenu

public HtmlCommandJSCookMenu()
Method Detail

getFamily

public String getFamily()
Overrides:
getFamily in class javax.faces.component.UICommand

getLayout

public String getLayout()
Specified by:
getLayout in class AbstractHtmlCommandJSCookMenu

setLayout

public void setLayout(String layout)

getTheme

public String getTheme()
Specified by:
getTheme in class AbstractHtmlCommandJSCookMenu

setTheme

public void setTheme(String theme)

getEnabledOnUserRole

public 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(String enabledOnUserRole)

getVisibleOnUserRole

public 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(String visibleOnUserRole)

getJavascriptLocation

public 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(String javascriptLocation)

getImageLocation

public 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(String imageLocation)

getStyleLocation

public 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(String styleLocation)

getJavascriptLibrary

public String getJavascriptLibrary()

setJavascriptLibrary

public void setJavascriptLibrary(String javascriptLibrary)

getImageLibrary

public String getImageLibrary()

setImageLibrary

public void setImageLibrary(String imageLibrary)

getStyleLibrary

public String getStyleLibrary()

setStyleLibrary

public void setStyleLibrary(String styleLibrary)


Copyright © 2012 The Apache Software Foundation. All Rights Reserved.