org.alfresco.web.ui.common.component

Class UIMenu

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent

org.alfresco.web.ui.common.component.UIMenu

All Implemented Interfaces:

StateHolder

public class UIMenu
extends org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent

Author:

Kevin Roast

Constructor Summary

Constructors

Constructor and Description
UIMenu()

Method Summary

Modifier and Type	Method and Description
void	encodeBegin(FacesContext context)
void	encodeEnd(FacesContext context)
String	getFamily()
String	getLabel()
static String	getNextMenuId(UIComponent component, FacesContext context) Return the next usable menu DIV id in a sequence
String	getTooltip()
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setLabel(String label)
void	setTooltip(String tooltip)

Methods inherited from class org.springframework.extensions.webscripts.ui.common.component.SelfRenderingComponent

outputAttribute

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, 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

Constructor Detail

UIMenu

public UIMenu()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

See Also:

UIComponent.getFamily()

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

See Also:

UIComponentBase.encodeBegin(javax.faces.context.FacesContext)

encodeEnd

public void encodeEnd(FacesContext context)
               throws IOException

Overrides:

encodeEnd in class UIComponentBase

Throws:

IOException

See Also:

UIComponentBase.encodeEnd(javax.faces.context.FacesContext)

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIComponentBase

See Also:

StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIComponentBase

See Also:

StateHolder.saveState(javax.faces.context.FacesContext)

getLabel

public String getLabel()

Returns:

Returns the label.

setLabel

public void setLabel(String label)

Parameters:

label - The label to set.

getTooltip

public String getTooltip()

Returns:

Returns the tooltip.

setTooltip

public void setTooltip(String tooltip)

Parameters:

tooltip - The tooltip to set.

getNextMenuId

public static String getNextMenuId(UIComponent component,
                                   FacesContext context)

Return the next usable menu DIV id in a sequence

Parameters:

context - FacesContext

Returns:

next menu ID