|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UICommand
org.alfresco.web.ui.common.component.UIBreadcrumb
public class UIBreadcrumb
| Nested Class Summary | |
|---|---|
static class |
UIBreadcrumb.BreadcrumbEvent
Class representing the clicking of a breadcrumb element. |
| Field Summary | |
|---|---|
static java.lang.String |
SEPARATOR
the separator for a breadcrumb path value |
| Fields inherited from class javax.faces.component.UICommand |
|---|
COMPONENT_FAMILY, COMPONENT_TYPE |
| Constructor Summary | |
|---|---|
UIBreadcrumb()
Default Constructor |
|
| Method Summary | |
|---|---|
void |
appendHandler(IBreadcrumbHandler handler)
Append a handler object to the current breadcrumb structure |
void |
broadcast(javax.faces.event.FacesEvent event)
|
java.lang.String |
getFamily()
|
java.lang.String |
getSeparator()
Get the separator string to output between each breadcrumb element |
boolean |
getShowRoot()
Get whether to show the root of the path |
java.lang.Object |
getValue()
Override getValue() to deal with converting a String path into a valid List of IBreadcrumbHandler |
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setSelectedPathIndex(int index)
Set the selected path index. |
void |
setSeparator(java.lang.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 |
|---|
public static final java.lang.String SEPARATOR
| Constructor Detail |
|---|
public UIBreadcrumb()
| Method Detail |
|---|
public java.lang.String getFamily()
getFamily in class javax.faces.component.UICommandUIComponent.getFamily()
public void restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
restoreState in interface javax.faces.component.StateHolderrestoreState in class javax.faces.component.UICommandStateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState in interface javax.faces.component.StateHoldersaveState in class javax.faces.component.UICommandStateHolder.saveState(javax.faces.context.FacesContext)
public void broadcast(javax.faces.event.FacesEvent event)
throws javax.faces.event.AbortProcessingException
broadcast in class javax.faces.component.UICommandjavax.faces.event.AbortProcessingExceptionUICommand.broadcast(javax.faces.event.FacesEvent)public void setSelectedPathIndex(int index)
public java.lang.Object getValue()
getValue in class javax.faces.component.UICommandpublic void appendHandler(IBreadcrumbHandler handler)
handler - The IBreadcrumbHandler to appendpublic java.lang.String getSeparator()
public void setSeparator(java.lang.String separator)
separator - the separator string to output between each breadcrumb elementpublic boolean getShowRoot()
public void setShowRoot(boolean showRoot)
showRoot - Whether to show the root of the path
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||