|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
public class UIEditableList
Editable table component.
Allows to add/remove elements from an UIEditableList
, inspired from
Trinidad UIXCollection component.
Field Summary | |
---|---|
static java.lang.String |
COMPONENT_FAMILY
|
static java.lang.String |
COMPONENT_TYPE
|
Fields inherited from class javax.faces.component.UIInput |
---|
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
UIEditableList()
|
Method Summary | |
---|---|
boolean |
addValue(java.lang.Object value)
Adds a value to the end of the editable model. |
void |
broadcast(javax.faces.event.FacesEvent event)
Delivers a wrapped event to the appropriate component. |
void |
encodeBegin(javax.faces.context.FacesContext context)
|
void |
encodeChildren(javax.faces.context.FacesContext context)
Repeatedly render the children as many times as needed. |
void |
encodeEnd(javax.faces.context.FacesContext context)
|
java.lang.String |
getContainerClientId(javax.faces.context.FacesContext context)
Override container client id resolution to handle recursion. |
java.lang.Object |
getDefaultValue()
|
java.lang.Boolean |
getDiff()
Gets boolean stating if diff must be used when saving the value submitted. |
EditableModel |
getEditableModel()
Gets the EditableModel to use with this component. |
java.lang.String |
getFamily()
|
java.lang.String |
getModel()
Gets model name exposed in request map. |
java.lang.Integer |
getNumber()
|
java.lang.Boolean |
getRemoveEmpty()
|
java.lang.String |
getRendererType()
|
boolean |
getRendersChildren()
|
int |
getRowCount()
Gets the total number of rows in this table. |
java.lang.Object |
getRowData()
Gets the data for the current row. |
int |
getRowIndex()
Gets the index of the current row. |
java.lang.Integer |
getRowKey()
Gets the rowKey of the current row. |
java.lang.Object |
getTemplate()
Gets template to be used when adding new values to the model. |
java.lang.Object |
getValue()
|
void |
insertValue(int index,
java.lang.Object value)
Inserts value at given index on the editable model. |
boolean |
invokeOnComponent(javax.faces.context.FacesContext context,
java.lang.String clientId,
javax.faces.component.ContextCallback callback)
|
boolean |
isRowAvailable()
Checks to see if the current row is available. |
boolean |
isRowModified()
Checks to see if the current row is modified. |
java.lang.Object |
moveValue(int fromIndex,
int toIndex)
Modifies value at given index on the editable model. |
void |
processDecodes(javax.faces.context.FacesContext context)
|
void |
processUpdates(javax.faces.context.FacesContext context)
|
void |
processValidators(javax.faces.context.FacesContext context)
|
void |
queueEvent(javax.faces.event.FacesEvent event)
Queues an event. |
void |
recordValueModified(int index,
java.lang.Object newValue)
Records a value modification. |
java.lang.Object |
removeValue(int index)
Removes value at given index on the editable model. |
void |
resetCachedModel()
Resets the cache model Can be useful when re-rendering a list with ajax and not wanting to keep cached values already submitted. |
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.FacesContext context)
|
void |
setDefaultValue(java.lang.Object defaultValue)
|
void |
setDiff(java.lang.Boolean diff)
Sets boolean stating if diff must be used when saving the value submitted. |
void |
setModel(java.lang.String model)
Sets model name exposed in request map. |
void |
setNumber(java.lang.Integer number)
|
void |
setRemoveEmpty(java.lang.Boolean removeEmpty)
|
void |
setRendererType(java.lang.String rendererType)
|
void |
setRowIndex(int rowIndex)
Makes a row current. |
void |
setRowKey(java.lang.Integer rowKey)
Makes a row current. |
void |
setTemplate(java.lang.Object template)
Sets template to be used when adding new values to the model. |
Methods inherited from class javax.faces.component.UIInput |
---|
addValidator, addValueChangeListener, decode, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, 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 |
---|
findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setTransient, setValueBinding |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getValueExpression, setValueExpression |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface javax.faces.component.ValueHolder |
---|
getConverter, getLocalValue, setConverter |
Field Detail |
---|
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String COMPONENT_FAMILY
Constructor Detail |
---|
public UIEditableList()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIInput
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIInput
public java.lang.Object getValue()
getValue
in interface javax.faces.component.ValueHolder
getValue
in class javax.faces.component.UIOutput
public java.lang.Object getDefaultValue()
public void setDefaultValue(java.lang.Object defaultValue)
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIInput
public void resetCachedModel()
Can be useful when re-rendering a list with ajax and not wanting to keep cached values already submitted.
public final EditableModel getEditableModel()
public final boolean isRowAvailable()
EditableModel.isRowAvailable()
public final boolean isRowModified()
EditableModel.isRowModified()
public final int getRowCount()
EditableModel.getRowCount()
public final int getRowIndex()
EditableModel.getRowIndex()
public final java.lang.Integer getRowKey()
EditableModel.getRowKey()
public final java.lang.Object getRowData()
EditableModel.getRowData()
public void setRowIndex(int rowIndex)
This method calls preRowDataChange()
and
postRowDataChange()
as appropriate.
rowIndex
- The rowIndex of the row that should be made current. Use
-1 to clear the current row.EditableModel.setRowIndex(int)
public void setRowKey(java.lang.Integer rowKey)
This method calls preRowDataChange()
and
postRowDataChange()
as appropriate.
rowKey
- The rowKey of the row that should be made current. Use
null to clear the current row.EditableModel.setRowKey(java.lang.Integer)
public final void recordValueModified(int index, java.lang.Object newValue)
EditableModel.recordValueModified(int, java.lang.Object)
public boolean addValue(java.lang.Object value)
value
- the value to add
public void insertValue(int index, java.lang.Object value)
java.lang.IllegalArgumentException
- if model does not handle this index.public java.lang.Object moveValue(int fromIndex, int toIndex)
java.lang.IllegalArgumentException
- if model does not handle one of given
indexes.public java.lang.Object removeValue(int index)
java.lang.IllegalArgumentException
- if model does not handle this index.public java.lang.String getModel()
public void setModel(java.lang.String model)
public java.lang.Object getTemplate()
public final void setTemplate(java.lang.Object template)
public java.lang.Boolean getDiff()
public void setDiff(java.lang.Boolean diff)
public java.lang.Integer getNumber()
public void setNumber(java.lang.Integer number)
public java.lang.Boolean getRemoveEmpty()
public void setRemoveEmpty(java.lang.Boolean removeEmpty)
public java.lang.String getContainerClientId(javax.faces.context.FacesContext context)
getContainerClientId
in class javax.faces.component.UIComponent
public java.lang.String getRendererType()
getRendererType
in class javax.faces.component.UIComponentBase
public void setRendererType(java.lang.String rendererType)
setRendererType
in class javax.faces.component.UIComponentBase
public final void encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
encodeBegin
in class javax.faces.component.UIComponentBase
java.io.IOException
public void encodeEnd(javax.faces.context.FacesContext context) throws java.io.IOException
encodeEnd
in class javax.faces.component.UIComponentBase
java.io.IOException
public boolean getRendersChildren()
getRendersChildren
in class javax.faces.component.UIComponentBase
public void encodeChildren(javax.faces.context.FacesContext context) throws java.io.IOException
encodeChildren
in class javax.faces.component.UIComponentBase
java.io.IOException
public void broadcast(javax.faces.event.FacesEvent event)
broadcast
in class javax.faces.component.UIComponentBase
event
- a FacesEvent
javax.faces.event.AbortProcessingException
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class javax.faces.component.UIComponentBase
event
- a FacesEventpublic void processDecodes(javax.faces.context.FacesContext context)
processDecodes
in class javax.faces.component.UIInput
public void processValidators(javax.faces.context.FacesContext context)
processValidators
in class javax.faces.component.UIInput
public void processUpdates(javax.faces.context.FacesContext context)
processUpdates
in class javax.faces.component.UIInput
public boolean invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback) throws javax.faces.FacesException
invokeOnComponent
in class javax.faces.component.UIComponentBase
javax.faces.FacesException
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |