public abstract class UIListShuttle extends UIOrderingBaseComponent
Modifier and Type | Class and Description |
---|---|
protected static class |
UIListShuttle.SubmittedValue |
static class |
UIListShuttle.ValueHolder |
UIOrderingBaseComponent.DataAdder, UIOrderingBaseComponent.ItemState, UIOrderingBaseComponent.UpdateModelCommand
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENT_FAMILY |
static java.lang.String |
COMPONENT_TYPE |
protected UIOrderingBaseComponent.UpdateModelCommand |
updateActiveItemCommand |
protected UIOrderingBaseComponent.UpdateModelCommand |
updateSourceSelectionCommand |
protected UIOrderingBaseComponent.UpdateModelCommand |
updateTargetSelectionCommand |
isColumn
Constructor and Description |
---|
UIListShuttle() |
Modifier and Type | Method and Description |
---|---|
void |
addValueChangeListener(javax.faces.event.ValueChangeListener listener) |
org.ajax4jsf.model.ExtendedDataModel |
createDataModel() |
java.lang.Object |
getActiveItem() |
abstract java.lang.String |
getControlsVerticalAlign() |
UIOrderingBaseComponent.ItemState |
getItemState() |
abstract java.lang.String |
getListClass() |
java.lang.Object |
getLocalValue() |
abstract java.lang.String |
getSourceCaptionLabel() |
java.util.Set |
getSourceSelection() |
java.lang.Object |
getSourceValue() |
java.lang.Object |
getSubmittedValue() |
abstract java.lang.String |
getTargetCaptionLabel() |
java.util.Set |
getTargetSelection() |
java.lang.Object |
getTargetValue() |
javax.faces.el.ValueBinding |
getValueBinding(java.lang.String name) |
abstract javax.faces.el.MethodBinding |
getValueChangeListener() |
javax.faces.event.ValueChangeListener[] |
getValueChangeListeners() |
javax.el.ValueExpression |
getValueExpression(java.lang.String name) |
abstract boolean |
isFastMoveControlsVisible() |
abstract boolean |
isFastOrderControlsVisible() |
abstract boolean |
isMoveControlsVisible() |
abstract boolean |
isOrderControlsVisible() |
abstract boolean |
isSourceRequired() |
abstract boolean |
isTargetRequired() |
protected void |
processDecodes(javax.faces.context.FacesContext faces,
java.lang.Object argument) |
void |
removeValueChangeListener(javax.faces.event.ValueChangeListener listener) |
protected void |
resetDataModel() |
protected void |
restoreIterationSubmittedState(java.lang.Object object) |
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object object) |
java.lang.Object |
saveState(javax.faces.context.FacesContext context) |
void |
setActiveItem(java.lang.Object activeItem) |
abstract void |
setControlsVerticalAlign(java.lang.String controlsVerticalAlign) |
abstract void |
setFastMoveControlsVisible(boolean visible) |
abstract void |
setFastOrderControlsVisible(boolean visible) |
abstract void |
setListClass(java.lang.String listClass) |
abstract void |
setMoveControlsVisible(boolean visible) |
abstract void |
setOrderControlsVisible(boolean visible) |
abstract void |
setSourceCaptionLabel(java.lang.String label) |
abstract void |
setSourceRequired(boolean sourceRequired) |
void |
setSourceSelection(java.util.Set collection) |
void |
setSourceValue(java.lang.Object sourceValue) |
void |
setSubmittedStrings(java.util.Map map,
java.util.Set sourceSelection,
java.util.Set targetSelection,
java.lang.Object activeItem) |
void |
setSubmittedValue(java.lang.Object object) |
abstract void |
setTargetCaptionLabel(java.lang.String label) |
abstract void |
setTargetRequired(boolean targetRequired) |
void |
setTargetSelection(java.util.Set collection) |
void |
setTargetValue(java.lang.Object targetValue) |
void |
setValue(java.lang.Object value) |
abstract void |
setValueChangeListener(javax.faces.el.MethodBinding valueChangeMethod) |
void |
updateModel(javax.faces.context.FacesContext context)
Perform the following algorithm to update the model data
associated with this
UIInput , if any, as appropriate. |
void |
validate(javax.faces.context.FacesContext context)
Perform the following algorithm to validate the local value of
this
UIInput . |
protected void |
validateValue(javax.faces.context.FacesContext context,
java.lang.Object value) |
addConversionErrorMessage, addValidator, columns, compareValues, createComponentState, createContainer, createDataModel, dataChildren, decode, executeValidate, fixedChildren, getConverterForValue, getRequiredMessage, getValidator, getValidators, isEmpty, isLocalValueSet, isSuitableValue, processDecodes, processUpdates, processValidators, removeValidator, requiredInvalidate, setLocalValueSet, setRequiredMessage, setValidator, updateModel
addAjaxKeyEvent, addRequestKey, beforeRenderResponse, broadcast, broadcastLocal, captureOrigValue, captureOrigValue, clearRequestKeysSet, containsRequestKey, encodeAjaxChild, encodeBegin, extractKeySegment, getAjaxKeys, getAllAjaxKeys, getBaseClientId, getChildrenRenderer, getChildState, getClientId, getComponentState, getEncodedIds, getExtendedDataModel, getRowCount, getRowData, getRowIndex, getRowKey, getRowKeyConverter, getRowKeyVar, getStateVar, getValue, invocableChildren, invokeOnComponent, isRowAvailable, iterate, keepSaved, processUpdates, processValidators, queueEvent, removeRequestKey, resetComponent, restoreChildState, restoreOrigValue, restoreOrigValue, saveChildState, setAjaxKeys, setComponentState, setExtendedDataModel, setId, setParent, setRowIndex, setRowKey, setRowKey, setRowKeyConverter, setRowKeyVar, setStateVar, setupVariable, walk
getDataModel, getFamily, getFirst, getFooter, getHeader, getRows, getVar, setDataModel, setFirst, setFooter, setHeader, setRows, setValueBinding, setValueExpression, setVar
addFacesListener, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setRendered, setRendererType, setTransient
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public static final java.lang.String COMPONENT_TYPE
public static final java.lang.String COMPONENT_FAMILY
protected final UIOrderingBaseComponent.UpdateModelCommand updateTargetSelectionCommand
protected final UIOrderingBaseComponent.UpdateModelCommand updateActiveItemCommand
protected final UIOrderingBaseComponent.UpdateModelCommand updateSourceSelectionCommand
protected void processDecodes(javax.faces.context.FacesContext faces, java.lang.Object argument)
processDecodes
in class org.ajax4jsf.component.UIDataAdaptor
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class UIOrderingBaseComponent
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object object)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class UIOrderingBaseComponent
public java.lang.Object getSourceValue()
public void setSourceValue(java.lang.Object sourceValue)
public java.lang.Object getTargetValue()
public void setTargetValue(java.lang.Object targetValue)
public void setSubmittedStrings(java.util.Map map, java.util.Set sourceSelection, java.util.Set targetSelection, java.lang.Object activeItem)
public java.lang.Object getSubmittedValue()
public void setSubmittedValue(java.lang.Object object)
protected void restoreIterationSubmittedState(java.lang.Object object)
public org.ajax4jsf.model.ExtendedDataModel createDataModel()
createDataModel
in class org.ajax4jsf.component.UIDataAdaptor
public void addValueChangeListener(javax.faces.event.ValueChangeListener listener)
public abstract javax.faces.el.MethodBinding getValueChangeListener()
public abstract void setValueChangeListener(javax.faces.el.MethodBinding valueChangeMethod)
public javax.faces.event.ValueChangeListener[] getValueChangeListeners()
public void removeValueChangeListener(javax.faces.event.ValueChangeListener listener)
public void updateModel(javax.faces.context.FacesContext context)
Perform the following algorithm to update the model data
associated with this UIInput
, if any, as appropriate.
valid
property of this component is
false
, take no further action.localValueSet
property of this component is
false
, take no further action.ValueBinding
for value
exists,
take no further action.setValue()
method of the ValueBinding
to update the value that the ValueBinding
points at.setValue()
method returns successfully:
UIInput
.localValueSet
property of this
UIInput
to false.setValue()
method call fails:
addMessage()
on the specified FacesContext
instance.valid
property of this UIInput
to false
.updateModel
in class UIOrderingBaseComponent
context
- FacesContext
for the request we are processingjava.lang.NullPointerException
- if context
is null
public void validate(javax.faces.context.FacesContext context)
Perform the following algorithm to validate the local value of
this UIInput
.
getSubmittedValue()
.
If this returns null, exit without further processing. (This
indicates that no value was submitted for this component.)#getConvertedValue
.validateValue(javax.faces.context.FacesContext, java.lang.Object)
.valid
property of this component is still
true
, retrieve the previous value of the component
(with getValue()
), store the new local value using
setValue()
, and reset the submitted value to
null. If the local value is different from
the previous value of this component, fire a
ValueChangeEvent
to be broadcast to all interested
listeners.Application components implementing UIInput
that wish to
perform validation with logic embedded in the component should perform
their own correctness checks, and then call the
super.validate()
method to perform the standard
processing described above.
validate
in class UIOrderingBaseComponent
context
- The FacesContext
for the current requestjava.lang.NullPointerException
- if context
is nullprotected void validateValue(javax.faces.context.FacesContext context, java.lang.Object value)
validateValue
in class UIOrderingBaseComponent
protected void resetDataModel()
resetDataModel
in class org.ajax4jsf.component.UIDataAdaptor
public UIOrderingBaseComponent.ItemState getItemState()
getItemState
in class UIOrderingBaseComponent
public abstract java.lang.String getControlsVerticalAlign()
public abstract void setControlsVerticalAlign(java.lang.String controlsVerticalAlign)
public abstract boolean isOrderControlsVisible()
isOrderControlsVisible
in class UIOrderingBaseComponent
public abstract void setOrderControlsVisible(boolean visible)
setOrderControlsVisible
in class UIOrderingBaseComponent
public abstract boolean isFastOrderControlsVisible()
isFastOrderControlsVisible
in class UIOrderingBaseComponent
public abstract void setFastOrderControlsVisible(boolean visible)
setFastOrderControlsVisible
in class UIOrderingBaseComponent
public abstract boolean isMoveControlsVisible()
public abstract void setMoveControlsVisible(boolean visible)
public abstract boolean isFastMoveControlsVisible()
public abstract void setFastMoveControlsVisible(boolean visible)
public abstract java.lang.String getListClass()
public abstract void setListClass(java.lang.String listClass)
public abstract boolean isSourceRequired()
public abstract void setSourceRequired(boolean sourceRequired)
public abstract boolean isTargetRequired()
public abstract void setTargetRequired(boolean targetRequired)
public java.util.Set getSourceSelection()
public void setSourceSelection(java.util.Set collection)
public java.util.Set getTargetSelection()
public void setTargetSelection(java.util.Set collection)
public java.lang.Object getActiveItem()
public void setActiveItem(java.lang.Object activeItem)
public abstract java.lang.String getSourceCaptionLabel()
public abstract void setSourceCaptionLabel(java.lang.String label)
public abstract java.lang.String getTargetCaptionLabel()
public abstract void setTargetCaptionLabel(java.lang.String label)
public javax.faces.el.ValueBinding getValueBinding(java.lang.String name)
getValueBinding
in class javax.faces.component.UIComponentBase
public javax.el.ValueExpression getValueExpression(java.lang.String name)
getValueExpression
in class javax.faces.component.UIComponent
public void setValue(java.lang.Object value)
setValue
in interface javax.faces.component.ValueHolder
setValue
in class org.ajax4jsf.component.UIDataAdaptor
public java.lang.Object getLocalValue()
Copyright © 2013. All Rights Reserved.