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

Class UIDirectorySelectItems

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UISelectItems

org.nuxeo.ecm.platform.ui.web.component.UISelectItems

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

All Implemented Interfaces:

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

public class UIDirectorySelectItems
extends UISelectItems

Component that deals with a list of select items from a directory.

Author:

Anahide Tchertchian

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	UIDirectorySelectItems.DirPropertyKeys

Nested classes/interfaces inherited from class org.nuxeo.ecm.platform.ui.web.component.UISelectItems

UISelectItems.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UISelectItems

COMPONENT_FAMILY

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

Method Summary

Modifier and Type	Method and Description
protected DirectorySelectItem	createSelectItem(String label, Long ordering)
javax.faces.model.SelectItem[]	getAllValues()
String	getDirectoryName()
String	getFilter()
Long	getItemOrdering()
String	getKeySeparator()
Object	getValue()
boolean	isdbl10n()
boolean	isDisplayAll()
boolean	isDisplayObsoleteEntries()
boolean	isLocalize()
boolean	isNotDisplayDefaultOption()
protected String	retrieveLabelFromEntry(DocumentModel docEntry)
protected Long	retrieveOrderingFromEntry(DocumentModel docEntry)
protected String[]	retrieveSelectEntryId()
void	setAllValues(javax.faces.model.SelectItem[] allValues)
void	setdbl10n(boolean dbl10n)
void	setDirectoryName(String directoryName)
void	setDisplayAll(boolean displayAll)
void	setDisplayObsoleteEntries(boolean displayObsoleteEntries)
void	setFilter(String filter)
void	setItemOrdering(Long itemOrdering)
void	setKeySeparator(String keySeparator)
void	setLocalize(boolean localize)
void	setNotDisplayDefaultOption(boolean notDisplayDefaultOption)
protected String	translate(javax.faces.context.FacesContext context, Locale locale, String label)

Methods inherited from class org.nuxeo.ecm.platform.ui.web.component.UISelectItems

createSelectItem, getDisplayIdAndLabelSeparator, getItemLabel, getItemLabelPrefix, getItemLabelPrefixSeparator, getItemLabels, getItemLabelSuffix, getItemLabelSuffixSeparator, getItemValue, getOrdering, getVar, isCaseSensitive, isDisplayIdAndLabel, isItemDisabled, isItemEscaped, isItemRendered, isResolveItemLabelTwice, resetCachedModel, retrieveItemLabel, setCaseSensitive, setDisplayIdAndLabel, setDisplayIdAndLabelSeparator, setItemDisabled, setItemEscaped, setItemLabel, setItemLabelPrefix, setItemLabelPrefixSeparator, setItemLabels, setItemLabelSuffix, setItemLabelSuffixSeparator, setItemRendered, setItemValue, setOrdering, setResolveItemLabelTwice, setVar

Methods inherited from class javax.faces.component.UISelectItems

getFamily, setValue

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, 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, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, 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

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

Constructor Detail

UIDirectorySelectItems

public UIDirectorySelectItems()

Method Detail

getItemOrdering

public Long getItemOrdering()

setItemOrdering

public void setItemOrdering(Long itemOrdering)

getKeySeparator

public String getKeySeparator()

setKeySeparator

public void setKeySeparator(String keySeparator)

getDirectoryName

public String getDirectoryName()

setDirectoryName

public void setDirectoryName(String directoryName)

getAllValues

public javax.faces.model.SelectItem[] getAllValues()

setAllValues

public void setAllValues(javax.faces.model.SelectItem[] allValues)

isDisplayAll

public boolean isDisplayAll()

setDisplayAll

public void setDisplayAll(boolean displayAll)

isDisplayObsoleteEntries

public boolean isDisplayObsoleteEntries()

setDisplayObsoleteEntries

public void setDisplayObsoleteEntries(boolean displayObsoleteEntries)

getFilter

public String getFilter()

setFilter

public void setFilter(String filter)

isNotDisplayDefaultOption

public boolean isNotDisplayDefaultOption()

setNotDisplayDefaultOption

public void setNotDisplayDefaultOption(boolean notDisplayDefaultOption)

isLocalize

public boolean isLocalize()

Overrides:

isLocalize in class UISelectItems

setLocalize

public void setLocalize(boolean localize)

Overrides:

setLocalize in class UISelectItems

isdbl10n

public boolean isdbl10n()

Overrides:

isdbl10n in class UISelectItems

setdbl10n

public void setdbl10n(boolean dbl10n)

Overrides:

setdbl10n in class UISelectItems

getValue

public Object getValue()

Overrides:

getValue in class UISelectItems

createSelectItem

protected DirectorySelectItem createSelectItem(String label,
                                               Long ordering)

retrieveSelectEntryId

protected String[] retrieveSelectEntryId()

retrieveLabelFromEntry

protected String retrieveLabelFromEntry(DocumentModel docEntry)

retrieveOrderingFromEntry

protected Long retrieveOrderingFromEntry(DocumentModel docEntry)

translate

protected String translate(javax.faces.context.FacesContext context,
                           Locale locale,
                           String label)

Overrides:

translate in class UISelectItems