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

Class DirectoryAwareComponent

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

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

Direct Known Subclasses:

DirectoryEntryOutputComponent

public abstract class DirectoryAwareComponent
extends javax.faces.component.UIInput

Directory-aware abstract component.

Author:

George Lefter, Anahide Tchertchian

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	caseSensitive
protected String	directoryName
protected VocabularyEntryList	directoryValues
protected String	display This field is used to specify what to display from the entry of a directory,the id, label or both of them.
protected Boolean	displayIdAndLabel
protected Boolean	displayObsoleteEntries
protected Boolean	displayValueOnly
protected String	displayValueOnlyStyle
protected String	displayValueOnlyStyleClass
protected String	filter
protected Boolean	localize
protected Boolean	notDisplayDefaultOption
protected String	onchange
protected String	onclick
protected String	onselect
protected Map<String,javax.faces.model.SelectItem>	options
protected String	ordering
protected String	size

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, COMPONENT_TYPE, 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
DirectoryAwareComponent()

Method Summary

Modifier and Type	Method and Description
Boolean	getBooleanProperty(String key, Boolean defaultValue)
protected Boolean	getBooleanValue(String name, boolean defaultValue)
Boolean	getCaseSensitive()
String	getDirectoryName()
VocabularyEntryList	getDirectoryValues()
String	getDisplay()
Boolean	getDisplayIdAndLabel()
Boolean	getDisplayObsoleteEntries()
Boolean	getDisplayValueOnly()
String	getDisplayValueOnlyStyle()
String	getDisplayValueOnlyStyleClass()
String	getFilter()
Boolean	getLocalize()
Boolean	getNotDisplayDefaultOption()
String	getOnchange()
String	getOnclick()
String	getOnselect()
Map<String,javax.faces.model.SelectItem>	getOptions()
String	getOrdering()
String	getSize()
String	getStringProperty(String key, String defaultValue)
protected String	getStringValue(String name, String defaultValue)
void	restoreState(javax.faces.context.FacesContext context, Object state)
Object	saveState(javax.faces.context.FacesContext context)
void	setCaseSensitive(Boolean caseSensitive)
void	setDirectoryName(String directoryName)
void	setDirectoryValues(VocabularyEntryList directoryValues)
void	setDisplay(String display)
void	setDisplayIdAndLabel(Boolean displayIdAndLabel)
void	setDisplayObsoleteEntries(Boolean displayObsoleteEntries)
void	setDisplayValueOnly(Boolean displayValueOnly)
void	setDisplayValueOnlyStyle(String displayValueOnlyStyle)
void	setDisplayValueOnlyStyleClass(String displayValueOnlyStyleClass)
void	setFilter(String filter)
void	setLocalize(Boolean localize)
void	setNotDisplayDefaultOption(Boolean notDisplayDefaultOption)
void	setOnchange(String onchange)
void	setOnclick(String onclick)
void	setOnselect(String onselect)
void	setOptions(Map<String,javax.faces.model.SelectItem> options)
void	setOrdering(String ordering)
void	setSize(String size)

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getFamily, 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, getDefaultEventName, getEventNames, 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.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

directoryName

protected String directoryName

options

protected Map<String,javax.faces.model.SelectItem> options

displayIdAndLabel

protected Boolean displayIdAndLabel

displayObsoleteEntries

protected Boolean displayObsoleteEntries

localize

protected Boolean localize

notDisplayDefaultOption

protected Boolean notDisplayDefaultOption

displayValueOnly

protected Boolean displayValueOnly

displayValueOnlyStyle

protected String displayValueOnlyStyle

displayValueOnlyStyleClass

protected String displayValueOnlyStyleClass

display

protected String display

This field is used to specify what to display from the entry of a directory,the id, label or both of them.

onchange

protected String onchange

onclick

protected String onclick

onselect

protected String onselect

filter

protected String filter

size

protected String size

ordering

protected String ordering

directoryValues

protected VocabularyEntryList directoryValues

caseSensitive

protected Boolean caseSensitive

Constructor Detail

DirectoryAwareComponent

public DirectoryAwareComponent()

Method Detail

getStringValue

protected String getStringValue(String name,
                                String defaultValue)

getBooleanValue

protected Boolean getBooleanValue(String name,
                                  boolean defaultValue)

getDirectoryName

public String getDirectoryName()

setDirectoryName

public void setDirectoryName(String directoryName)

getDisplayIdAndLabel

public Boolean getDisplayIdAndLabel()

setDisplayIdAndLabel

public void setDisplayIdAndLabel(Boolean displayIdAndLabel)

getLocalize

public Boolean getLocalize()

setLocalize

public void setLocalize(Boolean localize)

getCaseSensitive

public Boolean getCaseSensitive()

setCaseSensitive

public void setCaseSensitive(Boolean caseSensitive)

getOptions

public Map<String,javax.faces.model.SelectItem> getOptions()

setOptions

public void setOptions(Map<String,javax.faces.model.SelectItem> options)

getDisplayObsoleteEntries

public Boolean getDisplayObsoleteEntries()

setDisplayObsoleteEntries

public void setDisplayObsoleteEntries(Boolean displayObsoleteEntries)

getNotDisplayDefaultOption

public Boolean getNotDisplayDefaultOption()

setNotDisplayDefaultOption

public void setNotDisplayDefaultOption(Boolean notDisplayDefaultOption)

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)

getDisplay

public String getDisplay()

setDisplay

public void setDisplay(String display)

getOnchange

public String getOnchange()

setOnchange

public void setOnchange(String onchange)

getOnclick

public String getOnclick()

setOnclick

public void setOnclick(String onclick)

getOnselect

public String getOnselect()

setOnselect

public void setOnselect(String onselect)

getFilter

public String getFilter()

setFilter

public void setFilter(String filter)

getSize

public String getSize()

setSize

public void setSize(String size)

getOrdering

public String getOrdering()

setOrdering

public void setOrdering(String ordering)

getDirectoryValues

public VocabularyEntryList getDirectoryValues()

setDirectoryValues

public void setDirectoryValues(VocabularyEntryList directoryValues)

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

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

getBooleanProperty

public Boolean getBooleanProperty(String key,
                                  Boolean defaultValue)

getStringProperty

public String getStringProperty(String key,
                                String defaultValue)