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

Class UIJavascriptList

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.component.list.UIEditableList

org.nuxeo.ecm.platform.ui.web.component.list.UIJavascriptList

All Implemented Interfaces:

EventListener, javax.faces.component.EditableValueHolder, javax.faces.component.NamingContainer, 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 UIJavascriptList
extends UIEditableList

Editable list component, relying on client side javascript code to handle adding/removing element from the target list.

Since:

7.2

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	UIJavascriptList.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
protected static String	IS_LIST_TEMPLATE_VAR
protected static String	ROW_INDEXES_PARAM
protected static String	TEMPLATE_INDEX_MARKER

Fields inherited from class org.nuxeo.ecm.platform.ui.web.component.list.UIEditableList

diff, model, number, parentList, parentListSet, removeEmpty, template

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
UIJavascriptList()

Method Summary

Modifier and Type	Method and Description
void	decode(javax.faces.context.FacesContext context)
protected void	encodeTemplate(javax.faces.context.FacesContext context) Renders an element using rowIndex -2 and client side marker TEMPLATE_INDEX_MARKER.
String	getContainerClientId(javax.faces.context.FacesContext context) Override container client id resolution to handle recursion.
String	getFamily()
int[]	getRowIndexes()
protected void	processFacetsAndChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId)
void	setRowIndexes(int[] rowIndexes)

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

addValue, broadcast, createEditableModel, encodeBegin, encodeChildren, encodeEnd, exposeRequestMapModelValue, flushCachedModel, getCurrencyKeyForInitialStampState, getDiff, getEditableModel, getInternalState, getModel, getNumber, getParentList, getProtectedModel, getRemoveEmpty, getRendererType, getRendersChildren, getRowCount, getRowData, getRowIndex, getRowKey, getStampState, getTemplate, getValue, initializeState, insertValue, invokeOnComponent, isRowAvailable, isRowModified, moveValue, postRowDataChange, preRowDataChange, processComponent, processDecodes, processUpdates, processValidators, queueEvent, recordValueModified, removeValue, resetCachedModel, restoreRequestMapModelValue, restoreState, saveRequestMapModelValue, saveState, setDiff, setModel, setNumber, setRemoveEmpty, setRendererType, setRowIndex, setRowKey, setTemplate, updateModel, valueChanged, visitTree

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, removeValidator, removeValueChangeListener, resetValue, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class javax.faces.component.UIComponent

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

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

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

TEMPLATE_INDEX_MARKER

protected static final String TEMPLATE_INDEX_MARKER

See Also:

Constant Field Values

ROW_INDEXES_PARAM

protected static final String ROW_INDEXES_PARAM

See Also:

Constant Field Values

IS_LIST_TEMPLATE_VAR

protected static final String IS_LIST_TEMPLATE_VAR

See Also:

Constant Field Values

Constructor Detail

UIJavascriptList

public UIJavascriptList()

Method Detail

setRowIndexes

public void setRowIndexes(int[] rowIndexes)

getRowIndexes

public int[] getRowIndexes()

getFamily

public String getFamily()

Overrides:

getFamily in class UIEditableList

getContainerClientId

public String getContainerClientId(javax.faces.context.FacesContext context)

Override container client id resolution to handle recursion.

Overrides:

getContainerClientId in class UIEditableList

encodeTemplate

protected void encodeTemplate(javax.faces.context.FacesContext context)
                       throws IOException

Renders an element using rowIndex -2 and client side marker TEMPLATE_INDEX_MARKER.

This element will be used on client side by js code to handle addition of a new element.

Overrides:

encodeTemplate in class UIEditableList

Throws:

IOException

decode

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

Overrides:

decode in class javax.faces.component.UIInput

processFacetsAndChildren

protected void processFacetsAndChildren(javax.faces.context.FacesContext context,
                                        javax.faces.event.PhaseId phaseId)

Overrides:

processFacetsAndChildren in class UIEditableList