org.nuxeo.ecm.platform.ui.web.directory
Class ChainSelectBase

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  org.nuxeo.ecm.platform.ui.web.directory.ChainSelectBase

All Implemented Interfaces:

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

Direct Known Subclasses:

ChainSelectMany, ChainSelectOne

public abstract class ChainSelectBase
extends javax.faces.component.UIInput
implements javax.faces.component.NamingContainer

Author:

George Lefter

Field Summary

static java.lang.String	VOCABULARY_SCHEMA
static java.lang.String	XVOCABULARY_SCHEMA Directory with a parent column.

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Method Summary

boolean	getAllowBranchSelection()
java.lang.String	getComponentId(int level)
java.lang.String	getDefaultRootKey()
int	getDepth()
java.lang.String[]	getDirectories()
java.lang.String	getDirectory(int level)
java.util.List<DirectoryEntry>	getDirectoryEntries(int level, java.lang.String[] selectedKeys) Computes the items that should be displayed for the nth listbox, depending on the options that have been selected in the previous ones.
java.lang.String	getDirectoryNames()
java.lang.String	getDisplay()
boolean	getDisplayValueOnly()
java.lang.String	getKeySeparator()
int	getListboxSize()
boolean	getQualifiedParentKeys()
java.lang.String	getReRender()
abstract java.lang.String[]	getSelection()
boolean	getShowObsolete()
java.lang.String	getStyle()
java.lang.String	getStyleClass()
boolean	getTranslate()
boolean	isRecursive()
java.util.List<DirectoryEntry>	resolveKeys(java.lang.String[] keys) Resolves a list of keys (a selection) to a list of coresponding directory items.
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setAllowBranchSelection(boolean allowBranchSelection)
void	setDefaultRootKey(java.lang.String defaultRootKey)
void	setDepth(int depth)
void	setDirectoryNames(java.lang.String directoryNames)
void	setDisplay(java.lang.String display)
void	setDisplayValueOnly(boolean displayValueOnly)
void	setKeySeparator(java.lang.String keySeparator)
void	setListboxSize(int listboxSize)
void	setReRender(java.lang.String reRender)
void	setShowObsolete(boolean showObsolete)
void	setStyle(java.lang.String style)
void	setStyleClass(java.lang.String styleClass)
void	setTranslate(boolean translate)

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, decode, getConverterMessage, getFamily, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId, getValueExpression, setValueExpression

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter

Field Detail

VOCABULARY_SCHEMA

public static final java.lang.String VOCABULARY_SCHEMA

See Also:

Constant Field Values

XVOCABULARY_SCHEMA

public static final java.lang.String XVOCABULARY_SCHEMA

Directory with a parent column.

See Also:

Constant Field Values

Method Detail

getDirectory

public java.lang.String getDirectory(int level)

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIInput

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIInput

getDirectories

public java.lang.String[] getDirectories()

isRecursive

public boolean isRecursive()

getDirectoryEntries

public java.util.List<DirectoryEntry> getDirectoryEntries(int level,
                                                          java.lang.String[] selectedKeys)

Computes the items that should be displayed for the nth listbox, depending on the options that have been selected in the previous ones.

Parameters:

level - the index of the listbox for which to compute the items

selectedKeys - the keys for the items selected on the previous levels

Returns:

a list of directory items

resolveKeys

public java.util.List<DirectoryEntry> resolveKeys(java.lang.String[] keys)

Resolves a list of keys (a selection) to a list of coresponding directory items. Example: [a, b, c] is resolved to [getNode(a), getNode(b), getNode(c)]

Parameters:

keys -

Returns:

getComponentId

public java.lang.String getComponentId(int level)

getKeySeparator

public java.lang.String getKeySeparator()

setKeySeparator

public void setKeySeparator(java.lang.String keySeparator)

getDefaultRootKey

public java.lang.String getDefaultRootKey()

setDefaultRootKey

public void setDefaultRootKey(java.lang.String defaultRootKey)

getDisplayValueOnly

public boolean getDisplayValueOnly()

setDisplayValueOnly

public void setDisplayValueOnly(boolean displayValueOnly)

getListboxSize

public int getListboxSize()

setListboxSize

public void setListboxSize(int listboxSize)

getDisplay

public java.lang.String getDisplay()

setDisplay

public void setDisplay(java.lang.String display)

getQualifiedParentKeys

public boolean getQualifiedParentKeys()

getDirectoryNames

public java.lang.String getDirectoryNames()

setDirectoryNames

public void setDirectoryNames(java.lang.String directoryNames)

getDepth

public int getDepth()

setDepth

public void setDepth(int depth)

getStyle

public java.lang.String getStyle()

setStyle

public void setStyle(java.lang.String style)

getStyleClass

public java.lang.String getStyleClass()

setStyleClass

public void setStyleClass(java.lang.String styleClass)

getTranslate

public boolean getTranslate()

setTranslate

public void setTranslate(boolean translate)

getShowObsolete

public boolean getShowObsolete()

setShowObsolete

public void setShowObsolete(boolean showObsolete)

getAllowBranchSelection

public boolean getAllowBranchSelection()

setAllowBranchSelection

public void setAllowBranchSelection(boolean allowBranchSelection)

getReRender

public java.lang.String getReRender()

setReRender

public void setReRender(java.lang.String reRender)

getSelection

public abstract java.lang.String[] getSelection()