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

Class ChainSelectListboxComponent

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

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, 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

public class ChainSelectListboxComponent
extends javax.faces.component.UIInput
implements javax.faces.component.behavior.ClientBehaviorHolder

Author:

George Lefter

Field Summary

Fields

Modifier and Type	Field and Description
boolean	ajaxUpdated
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

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
ChainSelectListboxComponent()

Method Summary

Modifier and Type	Method and Description
void	decode(javax.faces.context.FacesContext context) This method reads submitted data and rebuilds the current list of values based on selections in the parent components.
Boolean	getBooleanProperty(String name, Boolean defaultValue)
ChainSelect	getChain()
String	getCssStyle()
String	getCssStyleClass()
String	getDefaultEventName()
String	getDirectoryName()
VocabularyEntryList	getDirectoryValues()
String	getDisplay()
Boolean	getDisplayIdAndLabel()
String	getDisplayIdAndLabelSeparator()
Boolean	getDisplayObsoleteEntries()
String	getDisplayValueOnlySeparator()
Collection<String>	getEventNames()
String	getFamily()
Integer	getIndex()
Boolean	getLocalize()
String	getOnchange()
Map<String,DirectorySelectItem>	getOptions()
String	getOrdering()
Object	getProperty(String name)
String	getSize()
String	getStringProperty(String name, String defaultValue)
boolean	isAjaxUpdated()
boolean	isMultiSelect()
LinkedHashMap<String,DirectorySelectItem>	rebuildOptions() Reload listbox values based on previous selections in the chain.
void	restoreState(javax.faces.context.FacesContext context, Object state)
Object	saveState(javax.faces.context.FacesContext context)
void	setAjaxUpdated(boolean ajaxUpdated)
void	setCssStyle(String cssStyle)
void	setCssStyleClass(String cssStyleClass)
void	setDirectoryName(String newDirectory)
void	setDirectoryValues(VocabularyEntryList directoryValues)
void	setDisplay(String display)
void	setDisplayIdAndLabel(Boolean displayIdAndLabel)
void	setDisplayIdAndLabelSeparator(String displayIdAndLabelSeparator)
void	setDisplayObsoleteEntries(Boolean showObsolete)
void	setDisplayValueOnlySeparator(String displayValueOnlySeparator)
void	setIndex(Integer index)
void	setLocalize(Boolean localize)
void	setOnchange(String onchange)
void	setOrdering(String ordering)
void	setSize(String size)

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, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, 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.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

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

ajaxUpdated

public boolean ajaxUpdated

Constructor Detail

ChainSelectListboxComponent

public ChainSelectListboxComponent()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

isMultiSelect

public boolean isMultiSelect()

getDisplayIdAndLabelSeparator

public String getDisplayIdAndLabelSeparator()

setDisplayIdAndLabelSeparator

public void setDisplayIdAndLabelSeparator(String displayIdAndLabelSeparator)

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 context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIInput

getDirectoryName

public String getDirectoryName()

setDirectoryName

public void setDirectoryName(String newDirectory)

getDirectoryValues

public VocabularyEntryList getDirectoryValues()

setDirectoryValues

public void setDirectoryValues(VocabularyEntryList directoryValues)

getOptions

public Map<String,DirectorySelectItem> getOptions()

getDisplayIdAndLabel

public Boolean getDisplayIdAndLabel()

setDisplayIdAndLabel

public void setDisplayIdAndLabel(Boolean displayIdAndLabel)

getDisplayObsoleteEntries

public Boolean getDisplayObsoleteEntries()

setDisplayObsoleteEntries

public void setDisplayObsoleteEntries(Boolean showObsolete)

setOnchange

public void setOnchange(String onchange)

getOnchange

public String getOnchange()

getChain

public ChainSelect getChain()

getProperty

public Object getProperty(String name)

getStringProperty

public String getStringProperty(String name,
                                String defaultValue)

getBooleanProperty

public Boolean getBooleanProperty(String name,
                                  Boolean defaultValue)

getDisplayValueOnlySeparator

public String getDisplayValueOnlySeparator()

setDisplayValueOnlySeparator

public void setDisplayValueOnlySeparator(String displayValueOnlySeparator)

isAjaxUpdated

public boolean isAjaxUpdated()

setAjaxUpdated

public void setAjaxUpdated(boolean ajaxUpdated)

getIndex

public Integer getIndex()

Returns:

position of this component in the parent children list

setIndex

public void setIndex(Integer index)

getCssStyle

public String getCssStyle()

setCssStyle

public void setCssStyle(String cssStyle)

getCssStyleClass

public String getCssStyleClass()

setCssStyleClass

public void setCssStyleClass(String cssStyleClass)

getSize

public String getSize()

setSize

public void setSize(String size)

getLocalize

public Boolean getLocalize()

setLocalize

public void setLocalize(Boolean localize)

rebuildOptions

public LinkedHashMap<String,DirectorySelectItem> rebuildOptions()

Reload listbox values based on previous selections in the chain. (functionality moved from ChainSelect)

decode

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

This method reads submitted data and rebuilds the current list of values based on selections in the parent components.

Overrides:

decode in class javax.faces.component.UIInput

getOrdering

public String getOrdering()

setOrdering

public void setOrdering(String ordering)

getDisplay

public String getDisplay()

setDisplay

public void setDisplay(String display)

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase