# JavaScript API Reference for Oracle ADF Faces

Overview | Package | Class | Tree | Deprecated | Index | Help
| Oracle® Fusion Middleware Javascript API Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81451-01
PREV NEXT | FRAMES NO FRAMES Warning: private items are visible |

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

# oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfDhtmlRichTextEditorBasePeer

## Warning:

- This is an unsupported, internal implementation class.
- Use an API class that might provide equivalent functionality instead.
- This class will change without notice.
- It is not recommended that you use anything in this class.

    org.ecmascript.object.Object
       |
       +--oracle.adf.view.js.base.AdfObject
             |
             +--oracle.adf.view.js.base.AdfUIPeer
                   |
                   +--oracle.adf.view.js.laf.rich.AdfRichUIPeer
                         |
                         +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlValuePeer
                               |
                               +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer
                                     |
                                     +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlRichTextEditorBasePeer

Direct Known Subclasses:
  AdfDhtmlRichTextCKEditorPeer, AdfDhtmlRichTextEditorPeer

    public class AdfDhtmlRichTextEditorBasePeer
    extends AdfDhtmlEditableValuePeer

Base Peer for the richTextEditor component.

## Field Summary
`private Object` | `_ignoreEvents`

### Fields inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer
`ComponentLabelChanged, ComponentShowRequiredChanged`

### Fields inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer
`addComponentPropertyChanges, addComponentPropertyGetters, BUSY_STYLECLASS, CreateSubId, DISABLED_STYLECLASS, DRAG_READY_STYLECLASS, DRAG_SOURCE_STYLECLASS, DROP_TARGET_STYLECLASS, FOCUS_TARGET_STYLECLASS, HOVER_TARGET_STYLECLASS, READONLY_STYLECLASS, SELECTED_STYLECLASS`

### Fields inherited from oracle.adf.view.js.base.AdfObject
`constructor, superclass`

### Fields inherited from org.ecmascript.object.Object
`prototype`

## Constructor Summary
`public` | `AdfDhtmlRichTextEditorBasePeer()` Base Peer for the richTextEditor component.

## Method Summary
`public Object` | `addBinding(String componentClientId, Object componentClient, String command, String commandParameter, String propertyName, String eventType)` Adds the binding for `command`.
`private Object` | `_addCommandBinding(Object componentId, Object bindComponent, String command, String commandParameter)` Binds the the command to the component.
`protected Object` | `AddStyleBinding(Object componentId, Object propertyName, Object styleKey, Object eventType)`
`private Object` | `_commandBindingActionListener(AdfActionEvent event)` Handles the events fired by the components that are bound to this component, and translates these into commands.
`protected Object` | `ComponentRemoved(AdfUIComponent component)` Handles the removal of a component.
`protected Object` | `DestroyEditor(Object component)`
`public Object` | `executeCommand(Object cmd, Object value)` public API for RTE commands we want to expose for custom toolbar buttons, etc.
`protected Object` | `GetComponentLabel(Object component, Object domElement)` The richTextEditor has label tags in it for the form controls in the toolbar, which we want to ignore when looking for the component label.
`private HTMLElement` | `_getContentField(Object component)` Gets the contentField (the iframe).
`public Object` | `getCurrentContent(Object component, Object keepOriginal)`
`protected Object` | `GetInlineEditor(Event event)` Override to return an inline editor that edits the component's label property
`private Object` | `_getReadOnlyContentField(Object component)`
`private Object` | `_getSourceCodeField(Object component)`
`protected Object` | `GetSubmittedValue(AdfUIComponent component, HTMLElement domElement)` Returns the submittedValue by getting the value of the input dom node.
`protected Object` | `HandleCodeEditingModeChange(Object component)` Subclasses should override this method to handle UI changes w.r.t.
`protected Object` | `HandleComponentAction(Object componentEvent)` Handles ActionEvents by children of this component.
`protected Object` | `HandleComponentClick(Object componentEvent)` Handles a click on the component.
`protected Object` | `HandleComponentFocus(Object componentEvent)`
`protected Object` | `HandleContextChanged()`
`protected Object` | `Init(Object component)` Initializes the instance.
`protected static Object` | `InitConstants()`
`protected Object` | `InitDomElement(AdfUIComponent component, HTMLElement domElement)` Initialize the associated domElement when the peer is created.
`protected static Object` | `InitSubclass()`
`public Boolean` | `isCodeEditingMode()`
`private Object` | `_isContainerStretched()`
`public Object` | `isEmpty(Object value)` Check whether the input text is empty Return whether the input text is empty so the client side can do the validation for required field.
`private Object` | `_isInPopup()`
`public Object` | `needsResizeNotify(Object component)` Tests whether the peer requires resize notification.
`private Object` | `_removeCommandBindings(AdfUIComponent component)` Removes all the bindings of components to a command.
`protected Object` | `RemoveContextChangeListeners(Object component)`
`protected Object` | `RemoveStyleBindings(Object component)`
`protected Object` | `ScrollIntoView(Object component, Object focus, String subTargetId)` Overrriden to provide RTE specific implementation.
`public Object` | `setCodeEditingMode(Boolean newCodeEditingMode)` Specifies the new source code editing mode.
`protected Object` | `SetContentFieldValue(Object component, Object newValue)`
`protected Object` | `SetDisplayValue(AdfUIComponent component, HTMLElement domElement, String newValue)` Set the display string.
`protected Object` | `ShowFormatHint()` Show converter hints in note window for this component.
`protected Object` | `StopDialogsFromBeingInactivatedDueToIframes()`
`private Object` | `_styleBindingActionListener(Object event)`
`protected Object` | `UpdateValue()`

### Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlEditableValuePeer
`autoSubmit, BindToComponent, ComponentChanged, __componentLabelChanged, ComponentSubmittedValueChanged, disableBrowserAutoComplete, Focus, GetComponentSubmittedValue, GetComponentValue, getContentNode, GetContentNode, GetContentNodeId, getContentNodeText, GetDisplayValue, GetLabelElement, GetLabelText, getLastSubmittedValue, getMarkDirtyFlag, GetNoteWindowAlignmentHint, GetNoteWindowAlignmentNode, GetValidatorHints, HandleComponentKeyUp, HideNoteWindow, IsInitialized, IsNoteWindowVisible, __isSpuriousDirtyValue, LazyInitialize, MessageNotify, MessageShow, NeedsSpuriousDirtyValueTracking, __resetSpuriousDirtyValue, __restoreDirtyDisplayValue, setLastSubmittedValue, setMarkDirtyFlag, ShouldShowHint, ShowNoteWindow, ShowNoteWindowMouseOver, StashOldValue, StopArrowKeyBubbling, Validate, ValidateAndStashNewValue, ValidateIfStashedOldValue, VetoShowNoteWindow, WasSubmitted`

### Methods inherited from oracle.adfinternal.view.js.laf.dhtml.rich.AdfDhtmlValuePeer
`ComponentValueChanged, GetBestMatchSubId, getConvertedObject, getConvertedValue, getFormatHint, GetFormattedDisplayValue, GetNullDefault, GetSubIdDomElement, setDisplayValue`

### Methods inherited from oracle.adf.view.js.laf.rich.AdfRichUIPeer
`addComponentEventHandlers, addComponentPropertyChanges, addComponentPropertyGetters, addDomEventHandlers, addEventHandlerToDomInstance, addSuppressedPPRAttributes, applyDragReadyState, ApplyDragReadyState, applyDragSourceState, ApplyDragSourceState, bind, cancelAllPopups, cancelPopup, ChildVisibilityChanged, clearDragReadyState, ClearDragReadyState, clearDragSourceState, ClearDragSourceState, ComponentInlineStyleChanged, ComponentPropertyChanged, componentRemoved, ComponentStyleClassChanged, ComponentVisibleChanged, ConvertClientIdToLocator, convertLocatorToClientId, createComponentEvent, CreateComponentEvent, CreateDraggableNode, createInnerPeerClassWithSubId, createPeerClass, createSubId, DefaultInitClass, descendantMessageChanged, DescendantMessageChanged, DispatchComponentEvent, DispatchUncanceledComponentEvent, domReplaceNotify, DomReplaceNotify, focus, getAbsoluteId, getAbsoluteLocator, getAccessibleName, GetAccessibleName, getAllPopups, getComponent, GetComponent, GetComponentId, getComponentParent, getComponentProperty, GetComponentVisible, getDescendantComponents, getDomContentElement, getDomContentElementForComponent, GetDomContentElementForNode, getDomDocument, getDomElement, getDomElementForComponent, getDomNode, GetDomNodeForCommentComponent, getDomNodeForComponent, getDomRootNodes, GetDomRootNodes, getDragOverFeedback, GetDragOverFeedback, getDragTransferable, GetDragTransferable, GetElementToReplaceWithSVG, getFallbackDomElement, GetFallbackDomElement, getFirstAncestorComponent, getInlineEditor, getInlineStyleProperty, getLocatorByDomElement, getPagePosition, getPopupWindow, getReadyState, GetReadyState, GetRichResourceURL, getSubIdDomElement, hideAllPopups, hidePopup, InitClass, initialize, isAbsoluteLocatorCacheable, isActive, isBusy, isComponentContainedByElement, isInActiveHeirarchy, isInlineSVGIcon, isPopupVisible, messageNotify, messageShow, needsChildVisibilityChanges, needsFocusTargetStyleClass, PopupClosed, processPushData, ProcessPushData, registerADSAccessibility, RegisterADSAccessibility, registerKeyStroke, replaceDomElement, ReplaceDomElement, resizeNotify, ResizeNotify, scrollIntoView, setBusy, SetBusy, setInlineStyleProperty, showContextMenu, showPopup, simulateMouse, SimulateMouseOnDescendant, TruncateClientId, TruncateClientIdOnceImpl, UnbindFromComponent, unregisterKeyStroke, UpdateMessageType, visitChildren`

### Methods inherited from oracle.adf.view.js.base.AdfUIPeer
`getDefaultDragRecognizer, getParentPeer, initiateDrag, isVisible`

### Methods inherited from oracle.adf.view.js.base.AdfObject
`adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, exportPrototypeSymbol, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toDebugString, toString`

## Field Detail

### _ignoreEvents

`private Object _ignoreEvents`

## Constructor Detail

### AdfDhtmlRichTextEditorBasePeer

`public AdfDhtmlRichTextEditorBasePeer()`
  Base Peer for the richTextEditor component.

## Method Detail

### addBinding

`public Object addBinding(String componentClientId,
Object componentClient,
String command,
String commandParameter,
String propertyName,
String eventType)`
  Adds the binding for `command`.
  Parameters:

    `componentClientId` | - | The component to bind to the richTextEditor
    `componentClient` |  |
    `command` | - | The command to use for the binding.
    `commandParameter` | - | Null or the optional parameter for the command. Default value = null
    `propertyName` | - | The propertyName to bind to (only needed for STYLE_ commands). Default value = null
    `eventType` | - | The type of event to bind to. This only works for STYLE_ commands. Default value = AdfActionEvent.ACTION_EVENT_TYPE

  Return:
    `Object`
  See also:
    "#_addStyleBinding"
    `_addCommandBinding(Object, Object, String, String)`

### _addCommandBinding

`private Object _addCommandBinding(Object componentId,
Object bindComponent,
String command,
String commandParameter)`
  Binds the the command to the component. If the command is not applicable on the current selection, the component will be disabled. This also adds a clientListener to thecomponent that applies the command to the current selection.
  Parameters:

    `componentId` |  |
    `bindComponent` |  |
    `command` | - | The command to bind to.
    `commandParameter` | - | Null or the optional parameter for the command. Default value = null

  Return:
    `Object`

### AddStyleBinding

`protected Object AddStyleBinding(Object componentId,
Object propertyName,
Object styleKey,
Object eventType)`
  Parameters:

    `componentId` |  |
    `propertyName` |  |
    `styleKey` |  |
    `eventType` |  |

  Return:
    `Object`

### _commandBindingActionListener

`private Object _commandBindingActionListener(AdfActionEvent event)`
  Handles the events fired by the components that are bound to this component, and translates these into commands.
  Parameters:

    `event` | - | The ActionEvent.

  Return:
    `Object`

### ComponentRemoved

`protected Object ComponentRemoved(AdfUIComponent component)`
  Handles the removal of a component.
  Parameters:

    `component` | - | The component

  Return:
    `Object`
  Overrides:
    `AdfUIPeer.componentRemoved(AdfUIComponent)`

### DestroyEditor

`protected Object DestroyEditor(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### executeCommand

`public Object executeCommand(Object cmd,
Object value)`
  public API for RTE commands we want to expose for custom toolbar buttons, etc.
  Parameters:

    `cmd` |  |
    `value` |  |

  Return:
    `Object`

### GetComponentLabel

`protected Object GetComponentLabel(Object component,
Object domElement)`
  The richTextEditor has label tags in it for the form controls in the toolbar, which we want to ignore when looking for the component label. Therefore we only want to look for ones that use the subid "content" or "src".
  Parameters:

    `component` |  |
    `domElement` |  |

  Return:
    `Object`
  Overrides:
    `AdfDhtmlEditableValuePeer.GetComponentLabel(Object, Object)`

### _getContentField

`private HTMLElement _getContentField(Object component)`
  Gets the contentField (the iframe).
  Parameters:

    `component` |  |

  Return:
    `HTMLElement` - the contentField

### getCurrentContent

`public Object getCurrentContent(Object component,
Object keepOriginal)`
  Parameters:

    `component` |  |
    `keepOriginal` |  |

  Return:
    `Object`

### GetInlineEditor

`protected Object GetInlineEditor(Event event)`
  Override to return an inline editor that edits the component's label property
  Parameters:

    `event` | - | DOM Event that triggered the inline edit

  Return:
    `Object`
  Overrides:
    `AdfRichUIPeer.getInlineEditor(AdfUIComponent, Object)`

### _getReadOnlyContentField

`private Object _getReadOnlyContentField(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### _getSourceCodeField

`private Object _getSourceCodeField(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### GetSubmittedValue

`protected Object GetSubmittedValue(AdfUIComponent component,
HTMLElement domElement)`
  Returns the submittedValue by getting the value of the input dom node.
  Parameters:

    `component` | - | Component that this peer will be associated with
    `domElement` | - | Root DOM element of this peer

  Return:
    `Object` - submittedValue
  Overrides:
    `AdfDhtmlEditableValuePeer.GetSubmittedValue(Object, Object)`

### HandleCodeEditingModeChange

`protected Object HandleCodeEditingModeChange(Object component)`
  Subclasses should override this method to handle UI changes w.r.t. edit mode toggle.
  Parameters:

    `component` |  |

  Return:
    `Object`

### HandleComponentAction

`protected Object HandleComponentAction(Object componentEvent)`
  Handles ActionEvents by children of this component.
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`

### HandleComponentClick

`protected Object HandleComponentClick(Object componentEvent)`
  Handles a click on the component.
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`
  Overrides:
    `AdfDhtmlEditableValuePeer.HandleComponentClick(Object)`

### HandleComponentFocus

`protected Object HandleComponentFocus(Object componentEvent)`
  Parameters:

    `componentEvent` |  |

  Return:
    `Object`
  Overrides:
    `AdfDhtmlEditableValuePeer.HandleComponentFocus(Object)`

### HandleContextChanged

`protected Object HandleContextChanged()`
  Return:
    `Object`

### Init

`protected Object Init(Object component)`
  Initializes the instance. Subclasses of AdfObject must call their superclass' Init
  Parameters:

    `component` |  |

  Return:
    `Object`
  Overrides:
    `AdfObject.Init()`

### InitConstants

`protected static Object InitConstants()`
  Return:
    `Object`

### InitDomElement

`protected Object InitDomElement(AdfUIComponent component,
HTMLElement domElement)`
  Initialize the associated domElement when the peer is created. Stateless peers are not bound at the time that this method is called.
  Parameters:

    `component` | - | Component that this peer will be associated with
    `domElement` | - | Root DOM element of this peer

  Return:
    `Object`
  Overrides:
    `AdfRichUIPeer.InitDomElement(AdfUIComponent, Object)`

### InitSubclass

`protected static Object InitSubclass()`
  Return:
    `Object`
  Overrides:
    `AdfDhtmlValuePeer.InitSubclass()`

### isCodeEditingMode

`public Boolean isCodeEditingMode()`
  Return:
    `Boolean` - True if the component is in source editing mode, else false for WYSIWYG mode

### _isContainerStretched

`private Object _isContainerStretched()`
  Return:
    `Object`

### isEmpty

`public Object isEmpty(Object value)`
  Check whether the input text is empty Return whether the input text is empty so the client side can do the validation for required field.
  Parameters:

    `value` |  |

  Return:
    `Object`
  Overrides:
    `AdfDhtmlValuePeer.isEmpty(Object)`

### _isInPopup

`private Object _isInPopup()`
  Return:
    `Object`

### needsResizeNotify

`public Object needsResizeNotify(Object component)`
  Tests whether the peer requires resize notification. Peers which perform geometry management should override this to return true. When true, resizeNotify() will be called when browser window is resized.
  Parameters:

    `component` |  |

  Return:
    `Object`
  Overrides:
    `AdfUIPeer.needsResizeNotify(Object)`

### _removeCommandBindings

`private Object _removeCommandBindings(AdfUIComponent component)`
  Removes all the bindings of components to a command.
  Parameters:

    `component` | - | The component

  Return:
    `Object`
  See also:
    `_addCommandBinding(Object, Object, String, String)`

### RemoveContextChangeListeners

`protected Object RemoveContextChangeListeners(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### RemoveStyleBindings

`protected Object RemoveStyleBindings(Object component)`
  Parameters:

    `component` |  |

  Return:
    `Object`

### ScrollIntoView

`protected Object ScrollIntoView(Object component,
Object focus,
String subTargetId)`
  Overrriden to provide RTE specific implementation.
  Parameters:

    `component` |  |
    `focus` |  |
    `subTargetId` | - | optional component dependent DOM sub-id that needs to be scrolled/focused into view Default value = null

  Return:
    `Object`
  Overrides:
    `AdfRichUIPeer.scrollIntoView(Object, Object, String)`

### setCodeEditingMode

`public Object setCodeEditingMode(Boolean newCodeEditingMode)`
  Specifies the new source code editing mode.
  Parameters:

    `newCodeEditingMode` | - | true for code mode, and false for rich text

  Return:
    `Object`

### SetContentFieldValue

`protected Object SetContentFieldValue(Object component,
Object newValue)`
  Parameters:

    `component` |  |
    `newValue` |  |

  Return:
    `Object`

### SetDisplayValue

`protected Object SetDisplayValue(AdfUIComponent component,
HTMLElement domElement,
String newValue)`
  Set the display string.
  Parameters:

    `component` | - | The component
    `domElement` | - | The domElement
    `newValue` | - | The new value

  Return:
    `Object`
  Overrides:
    `AdfDhtmlValuePeer.setDisplayValue(Object, Object)`

### ShowFormatHint

`protected Object ShowFormatHint()`
  Show converter hints in note window for this component.
  Return:
    `Object`

### StopDialogsFromBeingInactivatedDueToIframes

`protected Object StopDialogsFromBeingInactivatedDueToIframes()`
  Return:
    `Object`

### _styleBindingActionListener

`private Object _styleBindingActionListener(Object event)`
  Parameters:

    `event` |  |

  Return:
    `Object`

### UpdateValue

`protected Object UpdateValue()`
  Return:
    `Object`

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

Overview | Package | Class | Tree | Deprecated | Index | Help
| Oracle® Fusion Middleware Javascript API Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81451-01
PREV NEXT | FRAMES NO FRAMES Warning: private items are visible |

Copyright (c) 1998, 2018, Oracle and/or its affiliates. All rights reserved.