JavaScript API Reference for Oracle ADF Faces

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.apache.myjs.trinidad.component
Class AdfUIEditableValue

org.ecmascript.object.Object
   |
   +--org.apache.myjs.trinidad.component.AdfUIValue
         |
         +--org.apache.myjs.trinidad.component.AdfUIEditableValue

Direct Known Subclasses:

AdfUIInput, AdfUISelectBoolean, AdfUISelectInput, AdfUISelectMany, AdfUISelectOne

public class AdfUIEditableValue
extends AdfUIValue

The editableValue web element contains all the shared attributes supported by all Apache Trinidad components that support the JSF EditableValueHolder interface.

Field Summary

Fields inherited from org.ecmascript.object.Object

constructor, prototype

Constructor Summary

public

AdfUIEditableValue() The editableValue web element contains all the shared attributes supported by all Apache Trinidad components that support the JSF EditableValueHolder interface.

Method Summary

private Object	_addFacesMessage(Object message, Object label)
private Object	_addRequiredFacesMessage()
public Object	addValidator(Object validator)
protected Object	DeliverDerivedPropertyEvents(Object propName, Object oldValue, Object newValue)
public boolean	getImmediate() Get function for attribute for 'immediate'.
public boolean	getLocalValueSet() Get function for attribute for 'localValueSet'.
public boolean	getRequired() Get function for attribute for 'required'.
protected Object	GetRequiredKey()
public string	getRequiredMessageDetail() Get function for attribute for 'requiredMessageDetail'.
public Object	getSubmittedValue() Get function for attribute for 'submittedValue'.
public boolean	getValid() Get function for attribute for 'valid'.
public Object	getValidators()
public Object	getValue() Get function for attribute for 'value'.
protected static Object	InitSubclass() Component for inputting content Note:
protected Object	IsEmpty(Object value)
private Object	_isEmptyString(Object value) Returns TRUE if the value is an empty String.
public Object	isEventRoot()
public Object	resetValue() Convenience method to reset this component's value to an uninitialized state, by setting - the value to null, - the submittedValue to undefined, - valid to true, - clears any messages.
protected Object	SetPropertyImpl(Object propName, Object oldValue, Object newValue)
public Object	setValue(Object value) Set function for attribute 'Value'.
public Object	validate(Object submittedValue) Perform the following algorithm to validate the local value.
protected Object	ValidateValue(Object value)

Methods inherited from org.apache.myjs.trinidad.component.AdfUIValue

GetChanges, GetConvertedValue, getConverter, isConvertible

Field Detail

Constructor Detail

AdfUIEditableValue

public AdfUIEditableValue()

The editableValue web element contains all the shared attributes supported by all Apache Trinidad components that support the JSF EditableValueHolder interface.

Method Detail

_addFacesMessage

private Object _addFacesMessage(Object message,
Object label)

Parameters:

message
label

Return:

Object

_addRequiredFacesMessage

private Object _addRequiredFacesMessage()

Return:

Object

addValidator

public Object addValidator(Object validator)

Parameters:

validator

Return:

Object

DeliverDerivedPropertyEvents

protected Object DeliverDerivedPropertyEvents(Object propName,
Object oldValue,
Object newValue)

Parameters:

propName
oldValue
newValue

Return:

Object

getImmediate

public boolean getImmediate()

Get function for attribute for 'immediate'. This attribute is secured. You may get it, but you may not set it. Any changes to this attribute will not be transmitted to the server.

Return:

boolean - Immediate

getLocalValueSet

public boolean getLocalValueSet()

Get function for attribute for 'localValueSet'. This attribute is secured. You may get it, but you may not set it. Any changes to this attribute will not be transmitted to the server.

Return:

boolean - LocalValueSet

getRequired

public boolean getRequired()

Get function for attribute for 'required'. This attribute is secured. You may get it, but you may not set it. Any changes to this attribute will not be transmitted to the server.

Return:

boolean - Required

GetRequiredKey

protected Object GetRequiredKey()

Return:

Object

getRequiredMessageDetail

public string getRequiredMessageDetail()

Get function for attribute for 'requiredMessageDetail'. This attribute is secured. You may get it, but you may not set it. Any changes to this attribute will not be transmitted to the server.

Return:

string - RequiredMessageDetail

getSubmittedValue

public Object getSubmittedValue()

Get function for attribute for 'submittedValue'. This attribute is secured. You may get it, but you may not set it. Any changes to this attribute will not be transmitted to the server.

Return:

Object - SubmittedValue

getValid

public boolean getValid()

Get function for attribute for 'valid'. This attribute is secured. You may get it, but you may not set it. Any changes to this attribute will not be transmitted to the server.

Return:

boolean - Valid

getValidators

public Object getValidators()

Return:

Object

getValue

public Object getValue()

Get function for attribute for 'value'.

Return:

Object

Overrides:

AdfUIValue.getValue()

InitSubclass

protected static Object InitSubclass()

Component for inputting content Note: This is a "partial" class, the majority of this class is generated.

Return:

Object

IsEmpty

protected Object IsEmpty(Object value)

Parameters:

value

Return:

Object

_isEmptyString

private Object _isEmptyString(Object value)

Returns TRUE if the value is an empty String. This function does not call trim().

Parameters:

value

Return:

Object

isEventRoot

public Object isEventRoot()

Return:

Object

resetValue

public Object resetValue()

Convenience method to reset this component's value to an uninitialized state, by setting - the value to null, - the submittedValue to undefined, - valid to true, - clears any messages.

Return:

Object

SetPropertyImpl

protected Object SetPropertyImpl(Object propName,
Object oldValue,
Object newValue)

Parameters:

propName
oldValue
newValue

Return:

Object

Overrides:

AdfUIValue.SetPropertyImpl(Object, Object, Object)

setValue

public Object setValue(Object value)

Set function for attribute 'Value'.

Parameters:

value

Return:

Object

Overrides:

AdfUIValue.setValue(Object)

validate

public Object validate(Object submittedValue)

Perform the following algorithm to validate the local value.

• If a submittedValue not passed in, retrieve the submitted value with getSubmittedValue(). If this returns null, exit without further processing.
• Convert the submitted value into a "local value" of the appropriate data type
• Validate the local value
• If the valid property of this component is still true, retrieve the previous value of the component (with getValue()), store the new local value using setProperty("value", ). A call to setValue will queue a ValueChangeEvent if the value is new.

Parameters:

submittedValue

-

if not passed in this.getSubmittedValue will be called

Return:

Object

ValidateValue

protected Object ValidateValue(Object value)

Parameters:

value

Return:

Object

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD