org.alfresco.web.ui.repo.component

Class UICategorySelector

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

org.alfresco.web.ui.repo.component.AbstractItemSelector

org.alfresco.web.ui.repo.component.UICategorySelector

All Implemented Interfaces:

javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

Direct Known Subclasses:

UITagSelector

public class UICategorySelector
extends AbstractItemSelector

Component to allow the selection of a category

Author:

gavinc

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.web.ui.repo.component.AbstractItemSelector

AbstractItemSelector.ItemSelectorEvent

Field Summary

Fields inherited from class org.alfresco.web.ui.repo.component.AbstractItemSelector

avmStore, disabled, initialSelectionId, label, mode, MODE_BEFORE_SELECTION, MODE_CANCEL_SELECTION, MODE_CONFIRM_SELECTION, MODE_DRILLDOWN_SELECTION, MODE_INITIAL_SELECTION, navigationId, OPTION, spacing

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Constructor Summary

Constructors

Constructor and Description
UICategorySelector()

Method Summary

Modifier and Type	Method and Description
Collection<org.alfresco.service.cmr.repository.NodeRef>	getChildrenForNode(javax.faces.context.FacesContext context) Returns a collection of child associations for the current navigation node
String	getDefaultLabel() Retrieves the default label to show if none has been defined and nothing has been selected
String	getFamily()
String	getItemIcon(javax.faces.context.FacesContext context, org.alfresco.service.cmr.repository.NodeRef ref)
String	getParentNodeId(javax.faces.context.FacesContext context) Retrieves the id of the parent node of the current navigation node
Collection<org.alfresco.service.cmr.repository.NodeRef>	getRootChildren(javax.faces.context.FacesContext context) Returns a collection of child associations of the root

Methods inherited from class org.alfresco.web.ui.repo.component.AbstractItemSelector

broadcast, decode, encodeBegin, encodeFieldValues, getDictionaryService, getFastNodeService, getHiddenFieldName, getInitialSelection, getLabel, getNodeService, getSpacing, isDisabled, renderNodeLink, restoreState, saveState, setDisabled, setInitialSelection, setLabel, setSpacing

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, compareValues, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Constructor Detail

UICategorySelector

public UICategorySelector()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class AbstractItemSelector

See Also:

UIComponent.getFamily()

getDefaultLabel

public String getDefaultLabel()

Description copied from class: AbstractItemSelector

Retrieves the default label to show if none has been defined and nothing has been selected

Specified by:

getDefaultLabel in class AbstractItemSelector

Returns:

Default label

See Also:

AbstractItemSelector.getDefaultLabel()

getParentNodeId

public String getParentNodeId(javax.faces.context.FacesContext context)

Description copied from class: AbstractItemSelector

Retrieves the id of the parent node of the current navigation node

Specified by:

getParentNodeId in class AbstractItemSelector

Parameters:

context - The Faces context

Returns:

Id of the parent node or null if the parent is the root

getChildrenForNode

public Collection<org.alfresco.service.cmr.repository.NodeRef> getChildrenForNode(javax.faces.context.FacesContext context)

Description copied from class: AbstractItemSelector

Returns a collection of child associations for the current navigation node

Specified by:

getChildrenForNode in class AbstractItemSelector

Parameters:

context - The Faces context

Returns:

The children

getRootChildren

public Collection<org.alfresco.service.cmr.repository.NodeRef> getRootChildren(javax.faces.context.FacesContext context)

Description copied from class: AbstractItemSelector

Returns a collection of child associations of the root

Specified by:

getRootChildren in class AbstractItemSelector

Parameters:

context - The Faces context

Returns:

The root options

getItemIcon

public String getItemIcon(javax.faces.context.FacesContext context,
                          org.alfresco.service.cmr.repository.NodeRef ref)

Specified by:

getItemIcon in class AbstractItemSelector

ref - NodeRef to the item to get the icon for

Returns:

The icon image to display next to the item links, or null for no icon