JavaScript API Reference for Oracle ADF Faces

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

oracle.adf.view.js.laf.inlineEditor
Class AdfRichInlineEditor

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.laf.inlineEditor.AdfRichInlineEditor

Direct Known Subclasses:

AdfRichPlainTextEditor

public abstract class AdfRichInlineEditor
extends AdfObject

Abstract superclass for all inline editors used by peers. The inline editors support reusing the same instance across edits on the same component.

The lifecyle of an inline editor is:

1. startEdit
2. 0..N calls to handleEvent. The editor commits the changes as they occur
3. stopEdit

Instances of this class are created by overrides of AdfRichUIPeer.GetInlineEditor. None of the functions in this class are called with bound peers. As a result, sunclasses should always retrieve their peer using the convenience function GetEditedPeer() on this class to ensure that their peer is bound.

See also:

AdfRichUIPeer.GetInlineEditor(Object)

GetEditedPeer()

Field Summary

private Object	_component
public static Object	FILTER_EDITABLE Constant for filter function indicating that the component is selectable and editable
public static Object	FILTER_SELECTABLE Constant for filter function indicating that the component is selectable but not editable
public static Object	FILTER_UNSELECTABLE Constant for filter function indicating that the component is neither selectable nor editable

Fields inherited from oracle.adf.view.js.base.AdfObject

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Method Summary

public AdfUIComponent	getEditedComponent() Returns the component currently being edited.
protected AdfRichUIPeer	GetEditedPeer() Convenience, Returning the bound peer for the component being edited.
public String	getEditedProperty() Returns the name of the property edited by this instance.
public Object	handleEvent(Event event) Called to deliver a DOM event to the inline editor.
protected Object	Init() Initializes the AdfRichInlineEditor
public Boolean	preEdit(AdfUIComponent component) Returns true if this inline editor is capable of editing the specified component.
protected Boolean	PreEdit() Called by preEdit to determine whether the component returned by getEditedComponent can be edited by this inlineEditor.
public Object	startEdit(AdfUIComponent component, Object event) Start editing the specified component at the location indicated by the optional DOM event.
public Object	stopEdit() Called to stop editing the current component.

Methods inherited from oracle.adf.view.js.base.AdfObject

adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString, toString

Field Detail

_component

private Object _component

FILTER_EDITABLE

public static Object FILTER_EDITABLE

Constant for filter function indicating that the component is selectable and editable

FILTER_SELECTABLE

public static Object FILTER_SELECTABLE

Constant for filter function indicating that the component is selectable but not editable

FILTER_UNSELECTABLE

public static Object FILTER_UNSELECTABLE

Constant for filter function indicating that the component is neither selectable nor editable

Method Detail

getEditedComponent

public AdfUIComponent getEditedComponent()

Returns the component currently being edited.

Return:

AdfUIComponent - null

GetEditedPeer

protected AdfRichUIPeer GetEditedPeer()

Convenience, Returning the bound peer for the component being edited.

Return:

AdfRichUIPeer - null

getEditedProperty

public String getEditedProperty()

Returns the name of the property edited by this instance. This will return null if the inline editor doesn't edit properties,

Return:

String - null

handleEvent

public Object handleEvent(Event event)

Called to deliver a DOM event to the inline editor.

Parameters:

event

-

DOM event to handle

Return:

Object

Init

protected Object Init()

Initializes the AdfRichInlineEditor

Return:

Object

Overrides:

AdfObject.Init()

preEdit

public Boolean preEdit(AdfUIComponent component)

Returns true if this inline editor is capable of editing the specified component. Subclassers should implement the abstract method CanEdit() to provide this implementation

Parameters:

component

-

to consider editing

Return:

Boolean - null true if this component can be inline edited

See also:

PreEdit()

PreEdit

protected Boolean PreEdit()

Called by preEdit to determine whether the component returned by getEditedComponent can be edited by this inlineEditor.

During this call, GetEditedPeer will return the component's peer properly bound.

Return:

Boolean - null true if this component can be inline edited

See also:

preEdit(AdfUIComponent)

getEditedComponent()

GetEditedPeer()

startEdit

public Object startEdit(AdfUIComponent component,
Object event)

Start editing the specified component at the location indicated by the optional DOM event. Overriders should call this method as the first thing that they do in their override

Parameters:

component	-	Component to start editing
event

Return:

Object

stopEdit

public Object stopEdit()

Called to stop editing the current component. Overriders should call this method as the last thing that they do in their override

Return:

Object

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