JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.agent.ie
Class AdfIEEditingAgent

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adfinternal.view.js.agent.AdfEditingAgent
               |
               +--oracle.adfinternal.view.js.agent.ie.AdfIEEditingAgent

public class AdfIEEditingAgent
extends AdfEditingAgent

AdfIEEditingAgent

public AdfIEEditingAgent()

IE AdfEditingAgent capabilities.

_executeHistoryMove

private Object _executeHistoryMove(AdfRichTextEditor component,
                                   HTMLFrameElement inlineFrame,
                                   HTMLElement doc,
                                   Array fromStack,
                                   Array toStack)

Executes a history move, e.g. undo to redo or redo to undo.

Parameters:

component	-	Component the rich text editor component
inlineFrame	-	The inline frame
doc	-	The editable document
fromStack	-	The stack to pop.
toStack	-	The stack to push.

Return:

Object

ExecuteRedo

protected Object ExecuteRedo(AdfRichTextEditor component,
                             HTMLFrameElement inlineFrame,
                             HTMLElement doc)

Default implementation for executing an redo command.

Parameters:

component	-	Component the rich text editor component
inlineFrame	-	The inline frame
doc	-	The editable document

Return:

Object

Overrides:

AdfEditingAgent.ExecuteRedo(AdfRichTextEditor, HTMLFrameElement, HTMLElement)

ExecuteUndo

protected Object ExecuteUndo(AdfRichTextEditor component,
                             HTMLFrameElement inlineFrame,
                             HTMLElement doc)

Default implementation for executing an undo command.

Parameters:

component	-	Component the rich text editor component
inlineFrame	-	The inline frame
doc	-	The editable document

Return:

Object

Overrides:

AdfEditingAgent.ExecuteUndo(AdfRichTextEditor, HTMLFrameElement, HTMLElement)

getColor

public Object getColor(Object value)

Parameters:

value

Return:

Object

Overrides:

AdfEditingAgent.getColor(Object)

getDefaultContent

public Object getDefaultContent()

Return:

Object

Overrides:

AdfEditingAgent.getDefaultContent()

_getDelta

private Object _getDelta(String oldValue,
                         String newValue,
                         Number scrollLeft,
                         Number scrollTop)

Computes the delta information between the given old and new values.

Parameters:

oldValue	-	The non-null old value
newValue	-	The non-null new value
scrollLeft	-	The left scroll position.
scrollTop	-	The top scroll position.

Return:

Object - the delta information

getInlineFrameContent

public String getInlineFrameContent(HTMLFrameElement inlineFrame,
                                    Object keepOriginal)

Gets the content of the inlineFrame.

Parameters:

inlineFrame	-	The inline frame
keepOriginal	-	indicates whether content should be returned as is without removing unnecessary content

Return:

String - The content of the inline frame.

Overrides:

AdfEditingAgent.getInlineFrameContent(HTMLFrameElement, Object)

getSelectionRange

public Object getSelectionRange(HTMLFrameElement inlineFrame)

Gets the current selection-object.

Parameters:

inlineFrame

-

The inline frame

Return:

Object

Overrides:

AdfEditingAgent.getSelectionRange(HTMLFrameElement)

_getWindowSelection

private Object _getWindowSelection(Object inlineFrame)

Gets the selection of the window.

Parameters:

inlineFrame

Return:

Object

handleTab

public Object handleTab(Object inlineFrame,
                        Object keyDownEvt)

Parameters:

inlineFrame
keyDownEvt

Return:

Object

Overrides:

AdfEditingAgent.handleTab(Object, Object)

insertHtmlAtSelection

public Object insertHtmlAtSelection(HTMLFrameElement inlineFrame,
                                    String htmlFragment)

Inserts an HTML fragment in place of the current selection or at the current cursor position.

Parameters:

inlineFrame	-	the inline frame
htmlFragment	-	the HTML fragment to insert

Return:

Object

Overrides:

AdfEditingAgent.insertHtmlAtSelection(HTMLFrameElement, String)

_isContentEditableRequired

private Object _isContentEditableRequired()

Return:

Object

isDesignMode

public Boolean isDesignMode(HTMLFrameElement inlineFrame)

Checks if the inlineFrame is in designMode.

Parameters:

inlineFrame

-

The inline frame

Return:

Boolean - Whether designMode is on.

Overrides:

AdfEditingAgent.isDesignMode(HTMLFrameElement)

isDesignModeReloadingFrame

public Object isDesignModeReloadingFrame()

Returns true if setting design mode to "on" will reload the IFRAME, false otherwise

Return:

Object

Overrides:

AdfEditingAgent.isDesignModeReloadingFrame()

IsNodeWrappingRange

protected Boolean IsNodeWrappingRange(Range range,
                                      Node node)

Implementation for checking if the supplied node is wrapping a range

Parameters:

range	-	The range object, usually corresponding to a seleciton
node	-	The node object that potentially wrapps the range

Return:

Boolean - Whether the supplied node wraps the supplied range

Overrides:

AdfEditingAgent.IsNodeWrappingRange(Range, Node)

QueryRedoEnabled

protected Boolean QueryRedoEnabled(AdfRichTextEditor component,
                                   HTMLFrameElement inlineFrame)

Default implementation for checking if the redo command is enabled for the current context.

Parameters:

component	-	Component the rich text editor component
inlineFrame	-	The inline frame

Return:

Boolean - Whether the command is enabled

Overrides:

AdfEditingAgent.QueryRedoEnabled(AdfRichTextEditor, HTMLFrameElement)

QueryUndoEnabled

protected Boolean QueryUndoEnabled(AdfRichTextEditor component,
                                   HTMLFrameElement inlineFrame)

Default implementation for checking if the undo command is enabled for the current context.

Parameters:

component	-	Component the rich text editor component
inlineFrame	-	The inline frame

Return:

Boolean - Whether the command is enabled

Overrides:

AdfEditingAgent.QueryUndoEnabled(AdfRichTextEditor, HTMLFrameElement)

_setInlineFrameBodyContentEditable

private Object _setInlineFrameBodyContentEditable(Object body)

Parameters:

body

Return:

Object

setInlineFrameContentEditable

public Boolean setInlineFrameContentEditable(HTMLFrameElement inlineFrame)

Makes an inline frame contentEditable.

Parameters:

inlineFrame

-

The inline frame

Return:

Boolean - Whether the action succeeded

Overrides:

AdfEditingAgent.setInlineFrameContentEditable(HTMLFrameElement)

setSelectionRange

public Object setSelectionRange(HTMLFrameElement inlineFrame,
                                DOMSelection range)

Sets the range of the selection

Parameters:

inlineFrame	-	The inlineFrame
range	-	The range

Return:

Object

Overrides:

AdfEditingAgent.setSelectionRange(HTMLFrameElement, DOMSelection)

updateValueHistory

public Object updateValueHistory(AdfRichTextEditor component,
                                 HTMLFrameElement inlineFrame,
                                 String newerValue)

Updates the undo/redo information for this editor.

Parameters:

component	-	Component the rich text editor component
inlineFrame	-	The inline frame
newerValue	-	The new value

Return:

Object

Overrides:

AdfEditingAgent.updateValueHistory(AdfRichTextEditor, HTMLFrameElement, String)