oracle.adf.view.faces.component
Class UIXEditableValueComponentBase

java.lang.Object
  |
  +--javax.faces.component.UIComponent
        |
        +--oracle.adf.view.faces.component.UIXComponent
              |
              +--oracle.adf.view.faces.component.UIXComponentBase
                    |
                    +--oracle.adf.view.faces.component.UIXValueComponentBase
                          |
                          +--oracle.adf.view.faces.component.UIXValue
                                |
                                +--oracle.adf.view.faces.component.UIXEditableValueComponentBase

All Implemented Interfaces:

javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

Direct Known Subclasses:

UIXEditableValue

public abstract class UIXEditableValueComponentBase

extends UIXValue

implements javax.faces.component.EditableValueHolder

Base class for components that have a value.

Field Summary

static PropertyKey	LOCAL_VALUE_SET_KEY
static PropertyKey	SUBMITTED_VALUE_KEY
static FacesBean.Type	TYPE
static PropertyKey	VALID_KEY
static PropertyKey	VALIDATORS_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXValue

COMPONENT_FAMILY, COMPONENT_TYPE, CONVERTER_KEY, VALUE_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

UIXEditableValueComponentBase(java.lang.String localName)

Method Summary

void	addValidator(javax.faces.validator.Validator validator)
void	addValueChangeListener(javax.faces.event.ValueChangeListener listener) Add a new ValueChangeListener to the set of listeners interested in being notified when ValueChangeEvents occur.
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 boolean	compareValues(java.lang.Object previous, java.lang.Object value) Return true if the new value is different from the previous value.
protected java.lang.Object	getConvertedValue(javax.faces.context.FacesContext context, java.lang.Object submittedValue)
java.lang.Object	getSubmittedValue() Return the submittedValue value of this component.
javax.faces.validator.Validator[]	getValidators()
javax.faces.event.ValueChangeListener[]	getValueChangeListeners() Return the set of registered ValueChangeListeners for this component.
boolean	isLocalValueSet()
boolean	isValid()
void	processDecodes(javax.faces.context.FacesContext context) In addition to the standard processDecodes behavior inherited from UIXComponentBase, calls validate() if the the immediate property is true.
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
void	removeValidator(javax.faces.validator.Validator validator)
void	removeValueChangeListener(javax.faces.event.ValueChangeListener listener) Remove an existing ValueChangeListener (if any) from the set of listeners interested in being notified when ValueChangeEvents occur.
void	setLocalValueSet(boolean localValueSet)
void	setSubmittedValue(java.lang.Object submittedValue) Set the submittedValue value of this component.
void	setValid(boolean valid)
void	updateModel(javax.faces.context.FacesContext context)
void	validate(javax.faces.context.FacesContext context)
protected void	validateValue(javax.faces.context.FacesContext context, java.lang.Object newValue)

Methods inherited from class oracle.adf.view.faces.component.UIXValue

getBeanType, getConverter, getFamily, getValue, setConverter, setValue

Methods inherited from class oracle.adf.view.faces.component.UIXValueComponentBase

getLocalValue

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addFacesListener, createFacesBean, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttribute, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getIntProperty, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreState, saveState, setAttribute, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.faces.component.EditableValueHolder

getValidator, getValueChangeListener, isImmediate, isRequired, setImmediate, setRequired, setValidator, setValueChangeListener

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter, setValue

Field Detail

TYPE

public static final FacesBean.Type TYPE

VALID_KEY

public static final PropertyKey VALID_KEY

LOCAL_VALUE_SET_KEY

public static final PropertyKey LOCAL_VALUE_SET_KEY

SUBMITTED_VALUE_KEY

public static final PropertyKey SUBMITTED_VALUE_KEY

VALIDATORS_KEY

public static final PropertyKey VALIDATORS_KEY

Constructor Detail

UIXEditableValueComponentBase

public UIXEditableValueComponentBase(java.lang.String localName)

Method Detail

isValid

public boolean isValid()

Specified by:

isValid in interface javax.faces.component.EditableValueHolder

setValid

public void setValid(boolean valid)

Specified by:

setValid in interface javax.faces.component.EditableValueHolder

isLocalValueSet

public boolean isLocalValueSet()

Specified by:

isLocalValueSet in interface javax.faces.component.EditableValueHolder

setLocalValueSet

public void setLocalValueSet(boolean localValueSet)

Specified by:

setLocalValueSet in interface javax.faces.component.EditableValueHolder

getSubmittedValue

public java.lang.Object getSubmittedValue()

Return the submittedValue value of this component. This method should only be used by the decode() and validate() method of this component, or its corresponding Renderer.

Specified by:

getSubmittedValue in interface javax.faces.component.EditableValueHolder

setSubmittedValue

public void setSubmittedValue(java.lang.Object submittedValue)

Set the submittedValue value of this component. This method should only be used by the decode() and validate() method of this component, or its corresponding Renderer.

Specified by:

setSubmittedValue in interface javax.faces.component.EditableValueHolder

Parameters:

submittedValue - The new submitted value

addValueChangeListener

public void addValueChangeListener(javax.faces.event.ValueChangeListener listener)

Add a new ValueChangeListener to the set of listeners interested in being notified when ValueChangeEvents occur.

Specified by:

addValueChangeListener in interface javax.faces.component.EditableValueHolder

Parameters:

listener - The ValueChangeListener to be added

Throws:

java.lang.NullPointerException - if listener is null

getValueChangeListeners

public javax.faces.event.ValueChangeListener[] getValueChangeListeners()

Return the set of registered ValueChangeListeners for this component. If there are no registered listeners, a zero-length array is returned.

Specified by:

getValueChangeListeners in interface javax.faces.component.EditableValueHolder

removeValueChangeListener

public void removeValueChangeListener(javax.faces.event.ValueChangeListener listener)

Remove an existing ValueChangeListener (if any) from the set of listeners interested in being notified when ValueChangeEvents occur.

Specified by:

removeValueChangeListener in interface javax.faces.component.EditableValueHolder

Parameters:

listener - The ValueChangeListener to be removed

Throws:

java.lang.NullPointerException - if listener is null

addValidator

public void addValidator(javax.faces.validator.Validator validator)

Specified by:

addValidator in interface javax.faces.component.EditableValueHolder

getValidators

public javax.faces.validator.Validator[] getValidators()

Specified by:

getValidators in interface javax.faces.component.EditableValueHolder

removeValidator

public void removeValidator(javax.faces.validator.Validator validator)

Specified by:

removeValidator in interface javax.faces.component.EditableValueHolder

validate

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

broadcast

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).

Overrides:

broadcast in class UIXComponentBase

Parameters:

event - FacesEvent to be broadcast

Throws:

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

processDecodes

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

In addition to the standard processDecodes behavior inherited from UIXComponentBase, calls validate() if the the immediate property is true. Iif the component is invalid afterwards or a RuntimeException is thrown, calls FacesContext.renderResponse().

Overrides:

processDecodes in class UIXComponentBase

Throws:

java.lang.NullPointerException

processUpdates

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

Overrides:

processUpdates in class UIXComponentBase

processValidators

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

Overrides:

processValidators in class UIXComponentBase

updateModel

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

validateValue

protected void validateValue(javax.faces.context.FacesContext context,
                             java.lang.Object newValue)

getConvertedValue

protected java.lang.Object getConvertedValue(javax.faces.context.FacesContext context,
                                             java.lang.Object submittedValue)
                                      throws javax.faces.convert.ConverterException

javax.faces.convert.ConverterException

compareValues

protected boolean compareValues(java.lang.Object previous,
                                java.lang.Object value)

Return true if the new value is different from the previous value.

Parameters:

previous - old value of this component (if any)

value - new value of this component (if any)