org.alfresco.web.ui.common.component

Class UIBreadcrumb

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UICommand

org.alfresco.web.ui.common.component.UIBreadcrumb

All Implemented Interfaces:

ActionSource, StateHolder

public class UIBreadcrumb
extends UICommand

Author:

kevinr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UIBreadcrumb.BreadcrumbEvent Class representing the clicking of a breadcrumb element.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SEPARATOR the separator for a breadcrumb path value

Fields inherited from class javax.faces.component.UICommand

COMPONENT_FAMILY, COMPONENT_TYPE

Constructor Summary

Constructors

Constructor and Description
UIBreadcrumb() Default Constructor

Method Summary

Modifier and Type	Method and Description
void	appendHandler(IBreadcrumbHandler handler) Append a handler object to the current breadcrumb structure
void	broadcast(FacesEvent event)
String	getFamily()
String	getSeparator() Get the separator string to output between each breadcrumb element
boolean	getShowRoot() Get whether to show the root of the path
Object	getValue() Override getValue() to deal with converting a String path into a valid List of IBreadcrumbHandler
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setSelectedPathIndex(int index) Set the selected path index.
void	setSeparator(String separator) Set separator
void	setShowRoot(boolean showRoot) Set whether to show the root of the path

Methods inherited from class javax.faces.component.UICommand

addActionListener, getAction, getActionListener, getActionListeners, isImmediate, queueEvent, removeActionListener, setAction, setActionListener, setImmediate, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, 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

SEPARATOR

public static final String SEPARATOR

the separator for a breadcrumb path value

See Also:

Constant Field Values

Constructor Detail

UIBreadcrumb

public UIBreadcrumb()

Default Constructor

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class UICommand

See Also:

UIComponent.getFamily()

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UICommand

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 UICommand

See Also:

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

broadcast

public void broadcast(FacesEvent event)
               throws AbortProcessingException

Overrides:

broadcast in class UICommand

Throws:

AbortProcessingException

See Also:

UICommand.broadcast(javax.faces.event.FacesEvent)

setSelectedPathIndex

public void setSelectedPathIndex(int index)

Set the selected path index. This modifies the current path value.

getValue

public Object getValue()

Override getValue() to deal with converting a String path into a valid List of IBreadcrumbHandler

Overrides:

getValue in class UICommand

appendHandler

public void appendHandler(IBreadcrumbHandler handler)

Append a handler object to the current breadcrumb structure

Parameters:

handler - The IBreadcrumbHandler to append

getSeparator

public String getSeparator()

Get the separator string to output between each breadcrumb element

Returns:

separator string

setSeparator

public void setSeparator(String separator)

Set separator

Parameters:

separator - the separator string to output between each breadcrumb element

getShowRoot

public boolean getShowRoot()

Get whether to show the root of the path

Returns:

true to show the root of the path, false to hide it

setShowRoot

public void setShowRoot(boolean showRoot)

Set whether to show the root of the path

Parameters:

showRoot - Whether to show the root of the path