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

Class ChainSelect

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.ChainSelect

All Implemented Interfaces:

EventListener, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, ResettableComponent

public class ChainSelect
extends javax.faces.component.UIInput
implements ResettableComponent

DOCUMENT ME.

Refactor me and it's christmas.

Author:

George Lefter

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	DEFAULT_KEY_SEPARATOR
static String	DEFAULT_PARENT_KEY
protected String	defaultRootKey Value used to filter on parent key when searching for a hierarchical directory roots.
protected Boolean	resetCacheOnUpdate New attribute to handle bad behaviour on ajax re-render, forcing local cache refresh

Fields inherited from class javax.faces.component.UIInput

CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
ChainSelect()

Method Summary

Modifier and Type	Method and Description
void	addToSelectionKeyList(String key)
Selection	createSelection(List<String> columns)
Selection	createSelection(String[] columns)
void	decode(javax.faces.context.FacesContext context)
void	encodeBegin(javax.faces.context.FacesContext context)
void	encodeEnd(javax.faces.context.FacesContext context)
String[]	encodeValue(Selection[] selections)
static String	format(Object o)
static String	formatAr(String[] ar)
Boolean	getBooleanProperty(String name, boolean defaultValue)
ChainSelectListboxComponent	getComponent(int i)
ChainSelectListboxComponent	getComponent(javax.faces.component.UIComponent parent, int i)
Selection[]	getComponentValue()
String	getCssStyle()
String	getCssStyleClass()
String	getDefaultRootKey()
Boolean	getDisplayValueOnly()
String	getDisplayValueOnlyStyle()
String	getDisplayValueOnlyStyleClass()
String	getFamily()
String	getKeySeparator()
int	getLastSelectedComponentIndex()
Boolean	getLocalize()
boolean	getMultiParentSelect()
String	getOnchange()
Map<String,DirectorySelectItem>	getOptions(int index)
Object	getProperty(String name)
String	getRendererType()
Boolean	getResetCacheOnUpdate()
Selection	getSelection(int i)
List<String>	getSelectionKeyList()
Selection[]	getSelections()
Integer	getSize()
String	getStringProperty(String name, String defaultValue)
boolean	isAllowBranchSelection()
boolean	isAllowRootSelection()
boolean	isMultiSelect()
boolean	isQualifiedParentKeys()
void	processUpdates(javax.faces.context.FacesContext context) Override update method to reset cached value and ensure good re-render in ajax
void	rebuildOptions() If the user changes selection for position k, all options for n>k will be reset.
void	resetCachedModel() Reset the chain select cached model
void	restoreState(javax.faces.context.FacesContext context, Object state)
Object	saveState(javax.faces.context.FacesContext arg0)
void	setAllowBranchSelection(boolean allowBranchSelection)
void	setAllowRootSelection(boolean allowRootSelection)
void	setCompAtIndex(int index, ChainSelectListboxComponent comp)
void	setComponentValue(Selection[] componentValue)
void	setCssStyle(String cssStyle)
void	setCSsStyleClass(String cssStyleClass)
void	setDefaultRootKey(String defaultRootKey)
void	setDisplayValueOnly(Boolean displayValueOnly)
void	setDisplayValueOnlyStyle(String displayValueOnlyStyle)
void	setDisplayValueOnlyStyleClass(String displayValueOnlyStyleClass)
void	setKeySeparator(String keySeparator)
void	setLastSelectedComponentIndex(int index)
void	setLocalize(Boolean localize)
void	setMultiParentSelect(boolean multiParentSelect)
void	setMultiSelect(boolean multiSelect)
void	setOnchange(String onchange)
void	setOptions(int index, Map<String,DirectorySelectItem> opts)
void	setQualifiedParentKeys(boolean fullyQualifiedParentKey)
void	setResetCacheOnUpdate(Boolean resetCacheOnUpdate)
void	setSelections(Selection[] sels)
void	setSize(Integer size)
void	validateValue(javax.faces.context.FacesContext context, Object newValue)

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, 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, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

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

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

DEFAULT_KEY_SEPARATOR

public static final String DEFAULT_KEY_SEPARATOR

See Also:

Constant Field Values

DEFAULT_PARENT_KEY

public static final String DEFAULT_PARENT_KEY

defaultRootKey

protected String defaultRootKey

Value used to filter on parent key when searching for a hierarchical directory roots.

If not set, will use null.

resetCacheOnUpdate

protected Boolean resetCacheOnUpdate

New attribute to handle bad behaviour on ajax re-render, forcing local cache refresh

Since:

5.6

Constructor Detail

ChainSelect

public ChainSelect()

Method Detail

isAllowBranchSelection

public boolean isAllowBranchSelection()

setAllowBranchSelection

public void setAllowBranchSelection(boolean allowBranchSelection)

isAllowRootSelection

public boolean isAllowRootSelection()

setAllowRootSelection

public void setAllowRootSelection(boolean allowRootSelection)

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

getRendererType

public String getRendererType()

Overrides:

getRendererType in class javax.faces.component.UIComponentBase

restoreState

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

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIInput

saveState

public Object saveState(javax.faces.context.FacesContext arg0)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIInput

getSelectionKeyList

public List<String> getSelectionKeyList()

addToSelectionKeyList

public void addToSelectionKeyList(String key)

decode

public void decode(javax.faces.context.FacesContext context)

Overrides:

decode in class javax.faces.component.UIInput

format

public static String format(Object o)

formatAr

public static String formatAr(String[] ar)

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class javax.faces.component.UIComponentBase

Throws:

IOException

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext context)
               throws IOException

Overrides:

encodeEnd in class javax.faces.component.UIComponentBase

Throws:

IOException

getProperty

public Object getProperty(String name)

getStringProperty

public String getStringProperty(String name,
                                String defaultValue)

getBooleanProperty

public Boolean getBooleanProperty(String name,
                                  boolean defaultValue)

getLocalize

public Boolean getLocalize()

setLocalize

public void setLocalize(Boolean localize)

getCssStyle

public String getCssStyle()

setCssStyle

public void setCssStyle(String cssStyle)

getCssStyleClass

public String getCssStyleClass()

setCSsStyleClass

public void setCSsStyleClass(String cssStyleClass)

getOnchange

public String getOnchange()

setOnchange

public void setOnchange(String onchange)

getSelection

public Selection getSelection(int i)

setSelections

public void setSelections(Selection[] sels)

getSize

public Integer getSize()

setSize

public void setSize(Integer size)

getOptions

public Map<String,DirectorySelectItem> getOptions(int index)

setOptions

public void setOptions(int index,
                       Map<String,DirectorySelectItem> opts)

rebuildOptions

public void rebuildOptions()

If the user changes selection for position k, all options for n>k will be reset. We only have to rebuild options for position k+1.

getComponent

public ChainSelectListboxComponent getComponent(javax.faces.component.UIComponent parent,
                                                int i)

getComponent

public ChainSelectListboxComponent getComponent(int i)

isMultiSelect

public boolean isMultiSelect()

setMultiSelect

public void setMultiSelect(boolean multiSelect)

getSelections

public Selection[] getSelections()

isQualifiedParentKeys

public boolean isQualifiedParentKeys()

setQualifiedParentKeys

public void setQualifiedParentKeys(boolean fullyQualifiedParentKey)

getDisplayValueOnly

public Boolean getDisplayValueOnly()

setDisplayValueOnly

public void setDisplayValueOnly(Boolean displayValueOnly)

getDisplayValueOnlyStyle

public String getDisplayValueOnlyStyle()

setDisplayValueOnlyStyle

public void setDisplayValueOnlyStyle(String displayValueOnlyStyle)

getDisplayValueOnlyStyleClass

public String getDisplayValueOnlyStyleClass()

setDisplayValueOnlyStyleClass

public void setDisplayValueOnlyStyleClass(String displayValueOnlyStyleClass)

getMultiParentSelect

public boolean getMultiParentSelect()

setMultiParentSelect

public void setMultiParentSelect(boolean multiParentSelect)

encodeValue

public String[] encodeValue(Selection[] selections)

createSelection

public Selection createSelection(List<String> columns)

createSelection

public Selection createSelection(String[] columns)

getComponentValue

public Selection[] getComponentValue()

setComponentValue

public void setComponentValue(Selection[] componentValue)

getLastSelectedComponentIndex

public int getLastSelectedComponentIndex()

setLastSelectedComponentIndex

public void setLastSelectedComponentIndex(int index)

setCompAtIndex

public void setCompAtIndex(int index,
                           ChainSelectListboxComponent comp)

getKeySeparator

public String getKeySeparator()

setKeySeparator

public void setKeySeparator(String keySeparator)

getDefaultRootKey

public String getDefaultRootKey()

setDefaultRootKey

public void setDefaultRootKey(String defaultRootKey)

validateValue

public void validateValue(javax.faces.context.FacesContext context,
                          Object newValue)

Overrides:

validateValue in class javax.faces.component.UIInput

getResetCacheOnUpdate

public Boolean getResetCacheOnUpdate()

Since:

5.6

setResetCacheOnUpdate

public void setResetCacheOnUpdate(Boolean resetCacheOnUpdate)

Since:

5.6

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Override update method to reset cached value and ensure good re-render in ajax

Overrides:

processUpdates in class javax.faces.component.UIInput

Since:

5.6

resetCachedModel

public void resetCachedModel()

Reset the chain select cached model

Specified by:

resetCachedModel in interface ResettableComponent

Since:

5.7