|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIData
org.ajax4jsf.component.UIDataAdaptor
org.richfaces.component.UIOrderingBaseComponent
org.richfaces.component.UIOrderingList
public abstract class UIOrderingList
Nested Class Summary | |
---|---|
protected static class |
UIOrderingList.SubmittedValue
|
static class |
UIOrderingList.ValueHolder
|
Nested classes/interfaces inherited from class org.richfaces.component.UIOrderingBaseComponent |
---|
UIOrderingBaseComponent.DataAdder, UIOrderingBaseComponent.ItemState, UIOrderingBaseComponent.UpdateModelCommand |
Nested classes/interfaces inherited from class org.ajax4jsf.component.UIDataAdaptor |
---|
org.ajax4jsf.component.UIDataAdaptor.ComponentVisitor, org.ajax4jsf.component.UIDataAdaptor.IndexedEvent |
Field Summary | |
---|---|
protected UIOrderingBaseComponent.UpdateModelCommand |
updateActiveItemCommand
|
protected UIOrderingBaseComponent.UpdateModelCommand |
updateSelectionCommand
|
protected UIOrderingBaseComponent.UpdateModelCommand |
updateValueCommand
|
Fields inherited from class org.richfaces.component.UIOrderingBaseComponent |
---|
isColumn |
Fields inherited from class org.ajax4jsf.component.UIDataAdaptor |
---|
COMPONENT_STATE_ATTRIBUTE, decodeVisitor, EMPTY_MODEL, updateVisitor, validateVisitor |
Fields inherited from class javax.faces.component.UIData |
---|
COMPONENT_FAMILY, COMPONENT_TYPE |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
UIOrderingList()
|
Method Summary | |
---|---|
void |
addValueChangeListener(javax.faces.event.ValueChangeListener listener)
|
void |
broadcast(javax.faces.event.FacesEvent event)
In addition to to the default UIComponent.broadcast(javax.faces.event.FacesEvent)
processing, pass the ValueChangeEvent being broadcast to the
method referenced by valueChangeListener (if any). |
protected org.ajax4jsf.model.ExtendedDataModel |
createDataModel()
|
java.lang.Object |
getActiveItem()
|
abstract java.lang.String |
getControlsType()
|
abstract javax.faces.convert.Converter |
getConverter()
|
UIOrderingBaseComponent.ItemState |
getItemState()
|
java.lang.Object |
getLocalValue()
|
java.util.Collection |
getSelection()
|
java.lang.Object |
getSubmittedValue()
|
java.lang.Object |
getValue()
|
abstract javax.faces.el.MethodBinding |
getValueChangeListener()
|
javax.faces.event.ValueChangeListener[] |
getValueChangeListeners()
|
abstract boolean |
isImmediate()
|
abstract boolean |
isRequired()
|
abstract boolean |
isValid()
|
void |
processDecodes(javax.faces.context.FacesContext context)
Specialized decode behavior on top of that provided by the superclass. |
protected void |
processDecodes(javax.faces.context.FacesContext faces,
java.lang.Object argument)
|
void |
processUpdates(javax.faces.context.FacesContext context)
In addition to the standard processUpdates behavior
inherited from UIComponentBase , calls
updateModel() . |
void |
processValidators(javax.faces.context.FacesContext context)
In addition to the standard processValidators behavior
inherited from UIComponentBase , calls validate()
if the immediate property is false (which is the
default); if the component is invalid afterwards, calls
FacesContext.renderResponse() . |
void |
removeValueChangeListener(javax.faces.event.ValueChangeListener listener)
|
protected void |
resetDataModel()
|
protected void |
restoreIterationState(java.lang.Object object)
|
void |
restoreState(javax.faces.context.FacesContext faces,
java.lang.Object object)
|
protected java.lang.Object |
saveIterationState()
|
java.lang.Object |
saveState(javax.faces.context.FacesContext faces)
|
void |
setActiveItem(java.lang.Object activeItem)
|
abstract void |
setControlsType(java.lang.String type)
|
abstract void |
setConverter(javax.faces.convert.Converter converter)
|
abstract void |
setImmediate(boolean immediate)
|
abstract void |
setRequired(boolean required)
|
void |
setSelection(java.util.Collection collection)
|
void |
setSubmittedString(java.util.Map submittedString,
java.util.Set selection,
java.lang.Object activeItem)
|
void |
setSubmittedValue(java.lang.Object object)
|
abstract void |
setValid(boolean valid)
|
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 dataMap 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 newValue)
Set the "valid" property according to the below algorithm. |
Methods inherited from class org.ajax4jsf.component.UIDataAdaptor |
---|
addRequestKey, broadcastLocal, captureOrigValue, captureOrigValue, clearRequestKeysSet, containsRequestKey, encodeAjaxChild, encodeBegin, getAjaxKeys, getAllAjaxKeys, getBaseClientId, getChildrenRenderer, getChildState, getClientId, getComponentState, getEncodedIds, getExtendedDataModel, getRowCount, getRowData, getRowIndex, getRowKey, getRowKeyVar, getStateVar, isRowAvailable, iterate, processUpdates, processValidators, queueEvent, removeRequestKey, resetComponent, restoreChildState, restoreOrigValue, restoreOrigValue, saveChildState, setAjaxKeys, setComponentState, setExtendedDataModel, setId, setParent, setRowIndex, setRowKey, setRowKey, setRowKeyVar, setStateVar, setupVariable, walk |
Methods inherited from class javax.faces.component.UIData |
---|
getFamily, getFirst, getFooter, getHeader, getRows, getVar, setFirst, setFooter, setHeader, setRows, setValueBinding, setVar |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
addFacesListener, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setRendered, setRendererType, setTransient |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final UIOrderingBaseComponent.UpdateModelCommand updateActiveItemCommand
protected final UIOrderingBaseComponent.UpdateModelCommand updateSelectionCommand
protected final UIOrderingBaseComponent.UpdateModelCommand updateValueCommand
Constructor Detail |
---|
public UIOrderingList()
Method Detail |
---|
protected void processDecodes(javax.faces.context.FacesContext faces, java.lang.Object argument)
processDecodes
in class org.ajax4jsf.component.UIDataAdaptor
protected 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 javax.faces.event.ValueChangeListener[] getValueChangeListeners()
public abstract boolean isImmediate()
public abstract boolean isRequired()
public abstract boolean isValid()
public void removeValueChangeListener(javax.faces.event.ValueChangeListener listener)
public void setSubmittedString(java.util.Map submittedString, java.util.Set selection, java.lang.Object activeItem)
public java.lang.Object getSubmittedValue()
public void setSubmittedValue(java.lang.Object object)
protected java.lang.Object saveIterationState()
protected void restoreIterationState(java.lang.Object object)
public abstract void setImmediate(boolean immediate)
public abstract void setRequired(boolean required)
public abstract void setValid(boolean valid)
public abstract void setValueChangeListener(javax.faces.el.MethodBinding valueChangeMethod)
public abstract javax.faces.convert.Converter getConverter()
public abstract void setConverter(javax.faces.convert.Converter converter)
public void processDecodes(javax.faces.context.FacesContext context)
Specialized decode behavior on top of that provided by the
superclass. In addition to the standard
processDecodes
behavior inherited from UIComponentBase
, calls validate()
if the the
immediate
property is true; if the component is
invalid afterwards or a RuntimeException
is thrown,
calls FacesContext.renderResponse()
.
processDecodes
in class UIOrderingBaseComponent
public void processValidators(javax.faces.context.FacesContext context)
In addition to the standard processValidators
behavior
inherited from UIComponentBase
, calls validate()
if the immediate
property is false (which is the
default); if the component is invalid afterwards, calls
FacesContext.renderResponse()
.
If a RuntimeException
is thrown during
validation processing, calls FacesContext.renderResponse()
and re-throw the exception.
processValidators
in class UIOrderingBaseComponent
public void processUpdates(javax.faces.context.FacesContext context)
In addition to the standard processUpdates
behavior
inherited from UIComponentBase
, calls
updateModel()
.
If the component is invalid afterwards, calls
FacesContext.renderResponse()
.
If a RuntimeException
is thrown during
update processing, calls FacesContext.renderResponse()
and re-throw the exception.
processUpdates
in class UIOrderingBaseComponent
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
In addition to to the default UIComponent.broadcast(javax.faces.event.FacesEvent)
processing, pass the ValueChangeEvent
being broadcast to the
method referenced by valueChangeListener
(if any).
broadcast
in class org.ajax4jsf.component.UIDataAdaptor
event
- FacesEvent
to be broadcast
javax.faces.event.AbortProcessingException
- Signal the JavaServer Faces
implementation that no further processing on the current event
should be performed
java.lang.IllegalArgumentException
- if the implementation class
of this FacesEvent
is not supported by this component
java.lang.NullPointerException
- if event
is
null
public void updateModel(javax.faces.context.FacesContext context)
Perform the following algorithm to update the model dataMap
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 processing
java.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 request
java.lang.NullPointerException
- if context
is nullprotected void resetDataModel()
resetDataModel
in class org.ajax4jsf.component.UIDataAdaptor
protected void validateValue(javax.faces.context.FacesContext context, java.lang.Object newValue)
Set the "valid" property according to the below algorithm.
valid
property on this component is still
true
, and the required
property is also
true, ensure that the local value is not empty (where "empty" is
defined as null
or a zero-length String. If the local
value is empty:
addMessage()
method on the FacesContext
instance for the current request.valid
property on this component to
false
.valid
property on this component is still
true
, and the local value is not empty, call the
validate()
method of each Validator
registered for this UIInput
, followed by the method
pointed at by the validatorBinding
property (if any).
If any of these validators or the method throws a
ValidatorException
, catch the exception, add
its message (if any) to the FacesContext
, and set
the valid
property of this component to false.
public UIOrderingBaseComponent.ItemState getItemState()
getItemState
in class UIOrderingBaseComponent
public abstract java.lang.String getControlsType()
public abstract void setControlsType(java.lang.String type)
public java.util.Collection getSelection()
public void setSelection(java.util.Collection collection)
public java.lang.Object getActiveItem()
public void setActiveItem(java.lang.Object activeItem)
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()
public java.lang.Object getValue()
getValue
in interface javax.faces.component.ValueHolder
getValue
in class org.ajax4jsf.component.UIDataAdaptor
public java.lang.Object saveState(javax.faces.context.FacesContext faces)
saveState
in interface javax.faces.component.StateHolder
saveState
in class UIOrderingBaseComponent
public void restoreState(javax.faces.context.FacesContext faces, java.lang.Object object)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class UIOrderingBaseComponent
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |