RichEditor

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
def a11yHelp(): Unit

Displays accessibility instructions.
def about(): Unit

Displays CKEDITOR's About dialog.
def accessNextSpace(): Unit
def accessPreviousSpace(): Unit
def afterInit(f: JavaScriptContent, onlyRealtime: Boolean = false): Unit

Invokes the supplied JavaScript after this editor has completed initialization.
Invokes the supplied JavaScript after this editor has completed initialization.
f
the content to execute
onlyRealtime
true if this should only be executed after page rendering is complete
def anchor(): Unit

Displays the anchor editor dialog (creates a named anchor on the page that can be linked to).
final def asInstanceOf[T0]: T0

Definition Classes
Any
val autoInit: Boolean

Definition Classes
RichEditor → WrappedComponent
def bidiltr(): Unit

Specifies the content within the selected range should represent language left-to-right.
def bidirtl(): Unit

Specifies the content within the selected range should represent language right-to-left.
def blockquote(): Unit

Toggle blockquote status.
def blur(): Unit
def blurBack(): Unit
def bold(): Unit

Toggles bold state on the selected content.
def bulletedList(): Unit

Toggles the selected content within a bulleted list.
def bulletedListStyle(): Unit

Displays a dialog for styling the current bulleted list (will not create one).
def button(): Unit

Displays the create/edit button dialog.
def cellDelete(): Unit
def cellHorizontalSplit(): Unit
def cellInsertAfter(): Unit
def cellInsertBefore(): Unit
def cellMerge(): Unit
def cellMergeDown(): Unit
def cellMergeRight(): Unit
def cellProperties(): Unit
def cellVerticalSplit(): Unit
def checkSpell(): Unit
def checkbox(): Unit

Displays the create/edit checkbox dialog.
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def colorDialog(): Unit

Displays the color dialog.
Displays the color dialog.
TODO: figure out how to leverage the resulting color.
def columnDelete(): Unit
def columnInsertAfter(): Unit
def columnInsertBefore(): Unit
def contextMenu(): Unit

Toggles the visibility of the context menu.
def copy(): Unit

Copies the selected range and stores in the clipboard.
Copies the selected range and stores in the clipboard. This requires browser security permissions set to allow access to the clipboard from JavaScript.
def createDiv(): Unit

Displays the create div dialog.
Displays the create div dialog.
TODO: figure out if this actually inserts the div?
def cut(): Unit

Cuts the selected range and stores in the clipboard.
Cuts the selected range and stores in the clipboard. This requires browser security permissions set to allow access to the clipboard from JavaScript.
def delete(): Unit

Deletes the current selection
def editDiv(): Unit

TODO: figure out how this works
def elementsPathFocus(): Unit
def enableClipboard(): Unit

Configures the Clipboard module to integrate with this editor.
def enter(): Unit

Mimics pressing the enter key on the keyboard in the editor.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def execApplyStyle(style: RichEditorStyle): Unit
def execCommand(command: String, value: Any = null): Unit
def execRemoveStyle(style: RichEditorStyle): Unit
def execToggleStyle(style: RichEditorStyle): Unit
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def find(): Unit

Displays the find dialog to search the editor for specific content.
def flash(): Unit
def fontSize(size: FontSize): Unit

Applies the specified font size to the selected content.
Applies the specified font size to the selected content.
size
represents the size to apply to the selection.
def form(): Unit

Display form editor popup for the current selection.
Display form editor popup for the current selection. If a form doesn't already exist a new one will be created.
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def hiddenField(): Unit

Displays the create/edit hidden field dialog.
def horizontalRule(): Unit

Inserts a horizontal rule at the selected area.
lazy val html: JavaScriptProperty[String]

Reflects the HTML content of the editor.
Reflects the HTML content of the editor.
Defaults to the innerHTML value of wrapped.
def iframe(): Unit

Displays the create/edit iframe dialog.
def image(): Unit

Displays the create/edit image dialog.
def imageButton(): Unit

Displays the create/edit image button dialog.
def indent(): Unit

Increases the indentation of the selection.
def init(): Unit

Definition Classes
WrappedComponent
def initializeComponent(values: Map[String, Any]): Unit

Attributes
protected
Definition Classes
RichEditor → WrappedComponent
def initialized: Boolean

Definition Classes
WrappedComponent
lazy val inline: Property[Boolean]

Whether this editor should be inlined (use contenteditable) or the standard ckeditor.
Whether this editor should be inlined (use contenteditable) or the standard ckeditor. If using the standard ckeditor an iframe will be used for the content and the toolbar will appear above the editor. When inlined the content will be edited directly and the toolbar will float when editing.
This property will not do anything after the editor has been instantiated.
Defaults to true.
def insert(content: String, mode: InsertMode): Unit

Inserts the supplied content at the current selection.
Inserts the supplied content at the current selection. The selected text will be replaced with this content.
content
the HTML content to insert.
mode
the insertion mode to use.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def italic(): Unit

Toggles italic state on the selected content.
def justifyBlock(): Unit

Sets the justification to block forthe selection.
def justifyCenter(): Unit

Sets the justification to center for the selection.
def justifyLeft(): Unit

Sets the justification to left for the selection.
def justifyRight(): Unit

Sets the justification to right for the selection.
def link(): Unit

Displays the link editor dialog.
def maximize(): Unit

Toggles the maximized state of the editor.
def modify(key: String, value: Any): Unit

Attributes
protected
Definition Classes
RichEditor → WrappedComponent
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def newPage(): Unit

Clears the editor of all content and resets.
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def numberedList(): Unit

Toggles the selected content within a numbered list.
def numberedListStyle(): Unit

Displays a dialog for styling the current numbered list (will not create one).
def onBold(action: JSFunction1[Boolean, Unit]): Unit

Invokes the supplied action when the state of bold in the selection changes.
Invokes the supplied action when the state of bold in the selection changes.
action
the action to invoke taking a Boolean of the current status.
def onFontSize(action: JSFunction1[String, Unit]): Unit

Invokes the supplied action when the value of the font-size changes in the selectoin.
Invokes the supplied action when the value of the font-size changes in the selectoin.
action
the action function that is called when font-size changes with the size as a String or null.
def onItalic(action: JSFunction1[Boolean, Unit]): Unit

Invokes the supplied action when the state of italic in the selection changes.
Invokes the supplied action when the state of italic in the selection changes.
action
the action to invoke taking a Boolean of the current status.
def onStrike(action: JSFunction1[Boolean, Unit]): Unit

Invokes the supplied action when the state of strike-through in the selection changes.
Invokes the supplied action when the state of strike-through in the selection changes.
action
the action to invoke taking a Boolean of the current status.
def onStyleChange(action: JSFunction1[Boolean, Unit], style: RichEditorStyle): Unit

Invokes the supplied action when the state of the supplied style changes on the current selection.
Invokes the supplied action when the state of the supplied style changes on the current selection.
For example, passing "b" as the element invokes action when the selection status of being wrapped in a bold tag changes.
action
the JavaScript action to take when the state changes
style
the style to listen to
def onStyleValueChange(action: JSFunction1[String, Unit], cssStyle: Style[_]): Unit

Invokes the supplied action when the state of the supplied css style changes on the current selection.
Invokes the supplied action when the state of the supplied css style changes on the current selection.
action
the JavaScript action to take when the state changes
cssStyle
the Style to listen to
def onSubscript(action: JSFunction1[Boolean, Unit]): Unit

Invokes the supplied action when the state of subscript in the selection changes.
Invokes the supplied action when the state of subscript in the selection changes.
action
the action to invoke taking a Boolean of the current status.
def onSuperscript(action: JSFunction1[Boolean, Unit]): Unit

Invokes the supplied action when the state of superscript in the selection changes.
Invokes the supplied action when the state of superscript in the selection changes.
action
the action to invoke taking a Boolean of the current status.
def onUnderline(action: JSFunction1[Boolean, Unit]): Unit

Invokes the supplied action when the state of underline in the selection changes.
Invokes the supplied action when the state of underline in the selection changes.
action
the action to invoke taking a Boolean of the current status.
def option(key: String, value: Any): Unit

Definition Classes
WrappedComponent
def outdent(): Unit

Decreases the indentation of the selection.
def pageBreak(): Unit

Inserts a page break.
def pastFromWord(): Unit

Displays the paste from Word dialog.
def paste(): Unit

Pastes the selected range from the clipboard.
Pastes the selected range from the clipboard. This requires browser security permissions set to allow access to the clipboard from JavaScript.
def pasteText(): Unit

Displays the paste as plain text dialog.
def preview(): Unit

Previews the content.
def print(): Unit

Displays the print dialog.
def property[T](name: String, default: T, includeDefault: Boolean, toJS: (T) ⇒ JavaScriptContent)(implicit manifest: Manifest[T]): JavaScriptProperty[T]

Attributes
protected
Definition Classes
WrappedComponent
def radio(): Unit

Displays the create/edit radio dialog.
lazy val readOnly: JavaScriptProperty[Boolean]

Whether this editor is read-only.
Whether this editor is read-only.
Defaults to false.
def redo(): Unit
def removeAnchor(): Unit

Removes the anchor from the selection.
def removeDiv(): Unit

TODO: figure out how this works
def removeFormat(): Unit

Removes formatting from the selected content.
def replace(): Unit

Displays the replace dialog to search the editor for specific content and replace it.
def rowDelete(): Unit
def rowInsertAfter(): Unit
def rowInsertBefore(): Unit
def save(): Unit
def scaytCheck(): Unit

Enables spell checking addon.
def select(): Unit

Displays the create/edit select dialog.
def selectAll(): Unit
def selectNextCell(): Unit
def selectPreviousCell(): Unit
def shiftEnter(): Unit

Mimics pressing the enter key on the keyboard in the editor while holding down the shift key.
lazy val showAboutButton: JavaScriptProperty[Boolean]
def showBlocks(): Unit

Toggles showing of container blocks.
def showBorders(): Unit

Toggles showing of borders on all elements.
lazy val showButtonButton: JavaScriptProperty[Boolean]
lazy val showCheckBoxButton: JavaScriptProperty[Boolean]
lazy val showCopyButton: JavaScriptProperty[Boolean]
lazy val showCutButton: JavaScriptProperty[Boolean]
lazy val showFindButton: JavaScriptProperty[Boolean]
lazy val showFormButton: JavaScriptProperty[Boolean]
def showFormButtons(visible: Boolean): Unit
lazy val showHiddenFieldButton: JavaScriptProperty[Boolean]
lazy val showImageButtonButton: JavaScriptProperty[Boolean]
lazy val showNewPageButton: JavaScriptProperty[Boolean]
lazy val showPasteButton: JavaScriptProperty[Boolean]
lazy val showPasteFromWordButton: JavaScriptProperty[Boolean]
lazy val showPasteTextButton: JavaScriptProperty[Boolean]
lazy val showPath: JavaScriptProperty[Boolean]

Defines whether the path navigation in the bottom bar should be displayed.
Defines whether the path navigation in the bottom bar should be displayed. This is only applicable when not inline.
Defaults to true.
lazy val showPreviewButton: JavaScriptProperty[Boolean]
lazy val showPrintButton: JavaScriptProperty[Boolean]
lazy val showRadioButton: JavaScriptProperty[Boolean]
lazy val showRedoButton: JavaScriptProperty[Boolean]
lazy val showReplaceButton: JavaScriptProperty[Boolean]
lazy val showResizer: JavaScriptProperty[Boolean]

Defines whether the resizer in the bottom bar should be displayed.
Defines whether the resizer in the bottom bar should be displayed. This is only applicable when not inline.
Defaults to true.
lazy val showSaveButton: JavaScriptProperty[Boolean]
lazy val showSelectAllButton: JavaScriptProperty[Boolean]
lazy val showSelectButton: JavaScriptProperty[Boolean]
lazy val showSpellCheckButton: JavaScriptProperty[Boolean]
lazy val showTemplatesButton: JavaScriptProperty[Boolean]
lazy val showTextAreaButton: JavaScriptProperty[Boolean]
lazy val showTextFieldButton: JavaScriptProperty[Boolean]
lazy val showToolbar: JavaScriptProperty[Boolean]

Defines whether the native toolbar should be displayed.
Defines whether the native toolbar should be displayed.
Defaults to false.
lazy val showUndoButton: JavaScriptProperty[Boolean]
def smiley(): Unit

Displays the insert smiley dialog.
def source(): Unit

Toggles display of source in editor instead of rich content.
def specialChar(): Unit

Displays the insert special character dialog.
def strike(): Unit

Toggles the strike-through state on the selected content.
def subscript(): Unit

Toggles the subscript state on the selected content.
def superscript(): Unit

Toggles the superscript state on the selected content.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def table(): Unit
def tableDelete(): Unit
def tableProperties(): Unit
def templates(): Unit

Display templates dialog.
Display templates dialog. This allows changing the layout of the content area to reflect a predefined template.
def textArea(): Unit

Displays the create/edit text area dialog.
def textField(): Unit

Displays the create/edit text field dialog.
def toString(): String

Definition Classes
AnyRef → Any
def toolbarFocus(): Unit

Gives focus to the toolbar.
def underline(): Unit

Toggles the underline state on the selected content.
def undo(): Unit
def unlink(): Unit

Unlinks the selection.
def update(fireChanges: Boolean): Unit

Updates the HTML content of the wrapped component with the contents of the editor.
lazy val updateWrapped: Property[Boolean]

Updates the wrapped tag's content when the content is modified if this is set to true.
Updates the wrapped tag's content when the content is modified if this is set to true.
Defaults to false.
lazy val validateFrequency: JavaScriptProperty[Long]

The frequency at which the content is validated for changes in milliseconds.
The frequency at which the content is validated for changes in milliseconds. If this is set to 0 the content will only be validated upon blur.
Defaults to 1000.
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def webpage: Webpage[Session]

Attributes
protected
Definition Classes
WrappedComponent
val wrapped: HTMLTag

Definition Classes
RichEditor → WrappedComponent

class RichEditor extends WrappedComponent[HTMLTag]

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

def a11yHelp(): Unit

def about(): Unit

def accessNextSpace(): Unit

def accessPreviousSpace(): Unit

def afterInit(f: JavaScriptContent, onlyRealtime: Boolean = false): Unit

def anchor(): Unit

final def asInstanceOf[T0]: T0

val autoInit: Boolean

def bidiltr(): Unit

def bidirtl(): Unit

def blockquote(): Unit

def blur(): Unit

def blurBack(): Unit

def bold(): Unit

def bulletedList(): Unit

def bulletedListStyle(): Unit

def button(): Unit

def cellDelete(): Unit

def cellHorizontalSplit(): Unit

def cellInsertAfter(): Unit

def cellInsertBefore(): Unit

def cellMerge(): Unit

def cellMergeDown(): Unit

def cellMergeRight(): Unit

def cellProperties(): Unit

def cellVerticalSplit(): Unit

def checkSpell(): Unit

def checkbox(): Unit

def clone(): AnyRef

def colorDialog(): Unit

def columnDelete(): Unit

def columnInsertAfter(): Unit

def columnInsertBefore(): Unit

def contextMenu(): Unit

def copy(): Unit

def createDiv(): Unit

def cut(): Unit

def delete(): Unit

def editDiv(): Unit

def elementsPathFocus(): Unit

def enableClipboard(): Unit

def enter(): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def execApplyStyle(style: RichEditorStyle): Unit

def execCommand(command: String, value: Any = null): Unit

def execRemoveStyle(style: RichEditorStyle): Unit

def execToggleStyle(style: RichEditorStyle): Unit

def finalize(): Unit

def find(): Unit

def flash(): Unit

def fontSize(size: FontSize): Unit

def form(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def hiddenField(): Unit

def horizontalRule(): Unit

lazy val html: JavaScriptProperty[String]

def iframe(): Unit

def image(): Unit

def imageButton(): Unit

def indent(): Unit

def init(): Unit

def initializeComponent(values: Map[String, Any]): Unit

def initialized: Boolean

lazy val inline: Property[Boolean]

def insert(content: String, mode: InsertMode): Unit

final def isInstanceOf[T0]: Boolean

def italic(): Unit

def justifyBlock(): Unit

def justifyCenter(): Unit

def justifyLeft(): Unit