org.alfresco.web.ui.repo.component

Class AbstractItemSelector

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

All Implemented Interfaces:

EditableValueHolder, StateHolder, ValueHolder

Direct Known Subclasses:

UICategorySelector, UISpaceSelector

public abstract class AbstractItemSelector
extends UIInput

Abstract component to allow the selection of a hierarchical item

Author:

gavinc

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractItemSelector.ItemSelectorEvent Class representing the clicking of a breadcrumb element.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	avmStore current AVM store being browsed
protected Boolean	disabled Flag to show whether the component is disabled
protected String	initialSelectionId id of the initially selected item, if value is not set
protected String	label label to be displayed before a space is selected
protected int	mode what mode the component is in
protected static int	MODE_BEFORE_SELECTION
protected static int	MODE_CANCEL_SELECTION
protected static int	MODE_CONFIRM_SELECTION
protected static int	MODE_DRILLDOWN_SELECTION
protected static int	MODE_INITIAL_SELECTION
protected String	navigationId currently browsing node id
protected static String	OPTION
protected Integer	spacing cellspacing between options

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Constructor Summary

Constructors

Constructor and Description
AbstractItemSelector() Default constructor

Method Summary

Modifier and Type	Method and Description
void	broadcast(FacesEvent event)
void	decode(FacesContext context)
void	encodeBegin(FacesContext context)
protected String	encodeFieldValues(int mode, String id)
abstract Collection<org.alfresco.service.cmr.repository.NodeRef>	getChildrenForNode(FacesContext context) Returns a collection of child associations for the current navigation node
abstract String	getDefaultLabel() Retrieves the default label to show if none has been defined and nothing has been selected
protected static org.alfresco.service.cmr.dictionary.DictionaryService	getDictionaryService(FacesContext context) Use Spring JSF integration to return the Dictionary Service bean instance
abstract String	getFamily()
protected static org.alfresco.service.cmr.repository.NodeService	getFastNodeService(FacesContext context) Use Spring JSF integration to return the node Service bean instance
protected String	getHiddenFieldName() We use a unique hidden field name based on our client Id.
String	getInitialSelection()
abstract String	getItemIcon(FacesContext context, org.alfresco.service.cmr.repository.NodeRef ref)
String	getLabel()
protected static org.alfresco.service.cmr.repository.NodeService	getNodeService(FacesContext context) Use Spring JSF integration to return the Node Service bean instance
abstract String	getParentNodeId(FacesContext context) Retrieves the id of the parent node of the current navigation node
abstract Collection<org.alfresco.service.cmr.repository.NodeRef>	getRootChildren(FacesContext context) Returns a collection of child associations of the root
Integer	getSpacing()
boolean	isDisabled() Determines whether the component should be rendered in a disabled state
protected String	renderNodeLink(FacesContext context, String id, String name, String prefix, StringBuilder buf) Render a node descendant as a clickable link
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setDisabled(boolean disabled) Determines whether the component should be rendered in a disabled state
void	setInitialSelection(String initialSelection)
void	setLabel(String label)
void	setSpacing(Integer spacing)

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

Field Detail

OPTION

protected static final String OPTION

See Also:

Constant Field Values

MODE_BEFORE_SELECTION

protected static final int MODE_BEFORE_SELECTION

See Also:

Constant Field Values

MODE_INITIAL_SELECTION

protected static final int MODE_INITIAL_SELECTION

See Also:

Constant Field Values

MODE_DRILLDOWN_SELECTION

protected static final int MODE_DRILLDOWN_SELECTION

See Also:

Constant Field Values

MODE_CONFIRM_SELECTION

protected static final int MODE_CONFIRM_SELECTION

See Also:

Constant Field Values

MODE_CANCEL_SELECTION

protected static final int MODE_CANCEL_SELECTION

See Also:

Constant Field Values

label

protected String label

label to be displayed before a space is selected

spacing

protected Integer spacing

cellspacing between options

mode

protected int mode

what mode the component is in

navigationId

protected String navigationId

currently browsing node id

avmStore

protected String avmStore

current AVM store being browsed

initialSelectionId

protected String initialSelectionId

id of the initially selected item, if value is not set

disabled

protected Boolean disabled

Flag to show whether the component is disabled

Constructor Detail

AbstractItemSelector

public AbstractItemSelector()

Default constructor

Method Detail

getFamily

public abstract String getFamily()

Overrides:

getFamily in class UIInput

See Also:

UIComponent.getFamily()

getDefaultLabel

public abstract String getDefaultLabel()

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

Returns:

Default label

getParentNodeId

public abstract String getParentNodeId(FacesContext context)

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

Parameters:

context - The Faces context

Returns:

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

getChildrenForNode

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

Returns a collection of child associations for the current navigation node

Parameters:

context - The Faces context

Returns:

The children

getRootChildren

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

Returns a collection of child associations of the root

Parameters:

context - The Faces context

Returns:

The root options

getItemIcon

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

Parameters:

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

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIInput

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 UIInput

See Also:

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

decode

public void decode(FacesContext context)

Overrides:

decode in class UIInput

See Also:

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

broadcast

public void broadcast(FacesEvent event)
               throws AbortProcessingException

Overrides:

broadcast in class UIInput

Throws:

AbortProcessingException

See Also:

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

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

See Also:

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

getLabel

public String getLabel()

Returns:

Returns the label.

setLabel

public void setLabel(String label)

Parameters:

label - The label to set.

getSpacing

public Integer getSpacing()

Returns:

Returns the cell spacing value between space options. Default is 2.

setSpacing

public void setSpacing(Integer spacing)

Parameters:

spacing - The spacing to set.

getInitialSelection

public String getInitialSelection()

Returns:

Returns the initial selecttion.

setInitialSelection

public void setInitialSelection(String initialSelection)

Parameters:

initialSelection - The initial selection to set.

isDisabled

public boolean isDisabled()

Determines whether the component should be rendered in a disabled state

Returns:

Returns whether the component is disabled

setDisabled

public void setDisabled(boolean disabled)

Determines whether the component should be rendered in a disabled state

Parameters:

disabled - true to disable the component

getHiddenFieldName

protected String getHiddenFieldName()

We use a unique hidden field name based on our client Id. This is on the assumption that there won't be many selectors on screen at once! Also means we have less values to decode on submit.

Returns:

hidden field name

encodeFieldValues

protected String encodeFieldValues(int mode,
                                   String id)

renderNodeLink

protected String renderNodeLink(FacesContext context,
                                String id,
                                String name,
                                String prefix,
                                StringBuilder buf)

Render a node descendant as a clickable link

Parameters:

context - FacesContext

id - The id

name - The name

prefix - The prefix

buf - String buffer

Returns:

HTML for a descendant link

getNodeService

protected static org.alfresco.service.cmr.repository.NodeService getNodeService(FacesContext context)

Use Spring JSF integration to return the Node Service bean instance

Parameters:

context - FacesContext

Returns:

Node Service bean instance or throws exception if not found

getFastNodeService

protected static org.alfresco.service.cmr.repository.NodeService getFastNodeService(FacesContext context)

Use Spring JSF integration to return the node Service bean instance

Parameters:

context - FacesContext

Returns:

Node Service bean instance or throws exception if not found

getDictionaryService

protected static org.alfresco.service.cmr.dictionary.DictionaryService getDictionaryService(FacesContext context)

Use Spring JSF integration to return the Dictionary Service bean instance

Parameters:

context - FacesContext

Returns:

Dictionary Service bean instance or throws exception if not found