EditorCommand (JxBrowser 7.30.2 API)

java.lang.Object
- com.teamdev.jxbrowser.frame.EditorCommand

```
public final class EditorCommand
extends java.lang.Object
```
Provides the supported commands that can be executed in a Frame.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class EditorCommand.Name
The list of command names.

Nested Classes
Modifier and Type	Class and Description
`static class`	`EditorCommand.Name` The list of command names.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static EditorCommand`	`backgroundColor(Color color)` Returns a command that allows setting the given background `color` for the selected text in a WYSIWYG editor.
`static EditorCommand`	`backgroundColor(java.lang.String colorName)` Returns a command that allows setting the given background `colorName` for the selected text in a WYSIWYG editor.
`static EditorCommand`	`bold()` Returns a command that allows making the selected text bold in a WYSIWYG editor.
`static EditorCommand`	`copy()` Returns a command that allows copying the selected text in the frame.
`static EditorCommand`	`createLink(java.lang.String url)` Returns a command that allows making the link to the specified `URL` in a WYSIWYG editor.
`static EditorCommand`	`cut()` Returns a command that allows cutting the selected text in a text field, text area or WYSIWYG editor.
`static EditorCommand`	`delete()` Returns a command that allows deleting the selected text in a text field, text area or WYSIWYG editor.
`static EditorCommand`	`deleteBackward()` Returns a command that allows deleting character before the caret position in a text field, text area or WYSIWYG editor.
`static EditorCommand`	`deleteForward()` Returns a command that allows deleting character after the caret position in a text field, text area or WYSIWYG editor.
`static EditorCommand`	`deleteToBeginningOfLine()` Returns a command that allows deleting character from the caret position to the beginning of line in a text field, text area or WYSIWYG editor.
`static EditorCommand`	`deleteWordBackward()` Returns a command that allows deleting a word before the caret position in a text field, text area or WYSIWYG editor.
`static EditorCommand`	`deleteWordForward()` Returns a command that allows deleting a word after the caret position in a text field, text area or WYSIWYG editor.
`static EditorCommand`	`findText(java.lang.String text)` Returns a command that allows searching for the given `text` occurrence from the current caret position in the frame.
`static EditorCommand`	`fontName(FontName fontName)` Returns a command that allows setting the given `fontName` for the selected text in a WYSIWYG editor.
`static EditorCommand`	`fontSize(AbsoluteFontSize fontSize)` Returns a command that allows setting the given `fontSize` for the selected text in a WYSIWYG editor.
`static EditorCommand`	`foregroundColor(Color color)` Returns a command that allows setting the given foreground `color` for the selected text in a WYSIWYG editor.
`static EditorCommand`	`foregroundColor(java.lang.String colorName)` Returns a command that allows setting the given foreground `colorName` for the selected text in a WYSIWYG editor.
`static EditorCommand`	`ignoreSpelling()` Returns a command that allows disabling the spelling mistakes highlighting in a text area or a WYSIWYG editor.
`static EditorCommand`	`indent()` Returns a command that allows making indent of the selected text in a WYSIWYG editor.
`static EditorCommand`	`insertHtml(java.lang.String html)` Returns a command that allows inserting the given `html` content in a WYSIWYG editor.
`static EditorCommand`	`insertImage(java.lang.String imageSrc)` Returns a command that allows inserting an image with the given `imageSrc` in a WYSIWYG editor.
`static EditorCommand`	`insertNewLine()` Returns a command that allows inserting a new line in a WYSIWYG editor.
`static EditorCommand`	`insertOrderedList()` Returns a command that allows inserting an ordered list in a WYSIWYG editor.
`static EditorCommand`	`insertParagraph()` Returns a command that allows inserting a paragraph in a WYSIWYG editor.
`static EditorCommand`	`insertTab()` Returns a command that allows inserting a tab character in a WYSIWYG editor.
`static EditorCommand`	`insertText(java.lang.String text)` Returns a command that allows inserting the given `text` content in a WYSIWYG editor or a text field.
`static EditorCommand`	`insertUnorderedList()` Returns a command that allows inserting an unordered list in a WYSIWYG editor.
`static EditorCommand`	`italic()` Returns a command that allows making the selected text italic in a WYSIWYG editor.
`static EditorCommand`	`justifyCenter()` Returns a command that allows center justification the selected text in a WYSIWYG editor.
`static EditorCommand`	`justifyFull()` Returns a command that allows full justification the selected text in a WYSIWYG editor.
`static EditorCommand`	`justifyLeft()` Returns a command that allows left justification the selected text in a WYSIWYG editor.
`static EditorCommand`	`justifyRight()` Returns a command that allows right justification the selected text in a WYSIWYG editor.
`static EditorCommand`	`movePageDown()` Returns a command that allows moving the caret position at one page down in a text area or a WYSIWYG editor.
`static EditorCommand`	`movePageUp()` Returns a command that allows moving the caret position at one page up in a text area or a WYSIWYG editor.
`static EditorCommand`	`moveToBeginningOfLine()` Returns a command that allows moving a word to the beginning of line in a text area or a WYSIWYG editor.
`static EditorCommand`	`moveToBeginningOfLineAndModifySelection()` Returns a command that allows moving a word to the beginning of line and modifying selection in a text area or a WYSIWYG editor.
`static EditorCommand`	`moveToEndOfLine()` Returns a command that allows moving a word to the end of line in a text area or a WYSIWYG editor.
`static EditorCommand`	`moveToEndOfLineAndModifySelection()` Returns a command that allows moving a word to the end of line and modifying selection in a text area or a WYSIWYG editor.
`static EditorCommand`	`moveWordLeft()` Returns a command that allows moving a word left in a text area or a WYSIWYG editor.
`static EditorCommand`	`moveWordLeftAndModifySelection()` Returns a command that allows moving a word left and modifying selection in a text area or a WYSIWYG editor.
`static EditorCommand`	`moveWordRight()` Returns a command that allows moving a word right in a text area or a WYSIWYG editor.
`static EditorCommand`	`moveWordRightAndModifySelection()` Returns a command that allows moving a word right and modifying selection in a text area or a WYSIWYG editor.
`EditorCommand.Name`	`name()` Returns the `Name` of the command.
`static EditorCommand`	`outdent()` Returns a command that allows making outdent of the selected text in a WYSIWYG editor.
`static EditorCommand`	`paste()` Returns a command that allows pasting content of the clipboard in a text field, text area or a WYSIWYG editor.
`static EditorCommand`	`redo()` Returns a command that allows reversing the last `undo()` action.
`static EditorCommand`	`removeFormat()` Returns a command that allows removing all styles of the selected text (bold, italic, etc.) in a WYSIWYG editor.
`static EditorCommand`	`scrollLineDown()` Returns a command that allows scrolling one line down.
`static EditorCommand`	`scrollLineUp()` Returns a command that allows scrolling one line up.
`static EditorCommand`	`scrollPageBackward()` Returns a command that allows scrolling a page backward.
`static EditorCommand`	`scrollPageForward()` Returns a command that allows scrolling a page forward.
`static EditorCommand`	`scrollToBeginningOfDocument()` Returns a command that allows scrolling content to the beginning of the document in the frame.
`static EditorCommand`	`scrollToEndOfDocument()` Returns a command that allows scrolling content to the end of the document in the frame.
`static EditorCommand`	`selectAll()` Returns a command that allows selecting all text in the frame or the currently focused text field, text area or a WYSIWYG editor.
`static EditorCommand`	`selectLine()` Returns a command that allows selecting a line at the caret position in a text area or a WYSIWYG editor.
`static EditorCommand`	`selectParagraph()` Returns a command that allows selecting the whole paragraph at the caret position in a text area or a WYSIWYG editor.
`static EditorCommand`	`selectSentence()` Returns a command that allows selecting the whole sentence at the caret position in a text area or a WYSIWYG editor.
`static EditorCommand`	`selectWord()` Returns a command that allows selecting the word at the caret position in a text field, text area or a WYSIWYG editor.
`static EditorCommand`	`strikethrough()` Returns a command that allows making the selected text strikethrough in a WYSIWYG editor.
`static EditorCommand`	`subscript()` Returns a command that allows making the selected text subscript in a WYSIWYG editor.
`static EditorCommand`	`superscript()` Returns a command that allows making the selected text superscript in a WYSIWYG editor.
`static EditorCommand`	`toggleBold()` Returns a command that allows toggling bold style for the selected text in a WYSIWYG editor.
`static EditorCommand`	`toggleItalic()` Returns a command that allows toggling italic style for the selected text in a WYSIWYG editor.
`static EditorCommand`	`toggleUnderline()` Returns a command that allows toggling underline style for the selected text in a WYSIWYG editor.
`static EditorCommand`	`underline()` Returns a command that allows underlying the selected text in a WYSIWYG editor.
`static EditorCommand`	`undo()` Returns a command that allows reversing the last action.
`static EditorCommand`	`unlink()` Returns a command that allows removing the link from the text in a WYSIWYG editor.
`static EditorCommand`	`unselect()` Returns a command that allows clearing the current selection in a frame.
`java.lang.String`	`value()` Returns a string that represents the command value.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - bold
```
public static EditorCommand bold()
```
    Returns a command that allows making the selected text bold in a WYSIWYG editor.
  - copy
```
public static EditorCommand copy()
```
    Returns a command that allows copying the selected text in the frame.
  - cut
```
public static EditorCommand cut()
```
    Returns a command that allows cutting the selected text in a text field, text area or WYSIWYG editor.
  - delete
```
public static EditorCommand delete()
```
    Returns a command that allows deleting the selected text in a text field, text area or WYSIWYG editor.
  - deleteBackward
```
public static EditorCommand deleteBackward()
```
    Returns a command that allows deleting character before the caret position in a text field, text area or WYSIWYG editor.
  - deleteForward
```
public static EditorCommand deleteForward()
```
    Returns a command that allows deleting character after the caret position in a text field, text area or WYSIWYG editor.
  - deleteToBeginningOfLine
```
public static EditorCommand deleteToBeginningOfLine()
```
    Returns a command that allows deleting character from the caret position to the beginning of line in a text field, text area or WYSIWYG editor.
  - deleteWordBackward
```
public static EditorCommand deleteWordBackward()
```
    Returns a command that allows deleting a word before the caret position in a text field, text area or WYSIWYG editor.
  - deleteWordForward
```
public static EditorCommand deleteWordForward()
```
    Returns a command that allows deleting a word after the caret position in a text field, text area or WYSIWYG editor.
  - insertNewLine
```
public static EditorCommand insertNewLine()
```
    Returns a command that allows inserting a new line in a WYSIWYG editor.
  - insertParagraph
```
public static EditorCommand insertParagraph()
```
    Returns a command that allows inserting a paragraph in a WYSIWYG editor.
  - insertTab
```
public static EditorCommand insertTab()
```
    Returns a command that allows inserting a tab character in a WYSIWYG editor.
  - ignoreSpelling
```
public static EditorCommand ignoreSpelling()
```
    Returns a command that allows disabling the spelling mistakes highlighting in a text area or a WYSIWYG editor.
  - italic
```
public static EditorCommand italic()
```
    Returns a command that allows making the selected text italic in a WYSIWYG editor.
  - movePageUp
```
public static EditorCommand movePageUp()
```
    Returns a command that allows moving the caret position at one page up in a text area or a WYSIWYG editor.
  - movePageDown
```
public static EditorCommand movePageDown()
```
    Returns a command that allows moving the caret position at one page down in a text area or a WYSIWYG editor.
  - moveWordLeft
```
public static EditorCommand moveWordLeft()
```
    Returns a command that allows moving a word left in a text area or a WYSIWYG editor.
  - moveWordLeftAndModifySelection
```
public static EditorCommand moveWordLeftAndModifySelection()
```
    Returns a command that allows moving a word left and modifying selection in a text area or a WYSIWYG editor.
  - moveWordRight
```
public static EditorCommand moveWordRight()
```
    Returns a command that allows moving a word right in a text area or a WYSIWYG editor.
  - moveWordRightAndModifySelection
```
public static EditorCommand moveWordRightAndModifySelection()
```
    Returns a command that allows moving a word right and modifying selection in a text area or a WYSIWYG editor.
  - moveToBeginningOfLine
```
public static EditorCommand moveToBeginningOfLine()
```
    Returns a command that allows moving a word to the beginning of line in a text area or a WYSIWYG editor.
  - moveToBeginningOfLineAndModifySelection
```
public static EditorCommand moveToBeginningOfLineAndModifySelection()
```
    Returns a command that allows moving a word to the beginning of line and modifying selection in a text area or a WYSIWYG editor.
  - moveToEndOfLine
```
public static EditorCommand moveToEndOfLine()
```
    Returns a command that allows moving a word to the end of line in a text area or a WYSIWYG editor.
  - moveToEndOfLineAndModifySelection
```
public static EditorCommand moveToEndOfLineAndModifySelection()
```
    Returns a command that allows moving a word to the end of line and modifying selection in a text area or a WYSIWYG editor.
  - paste
```
public static EditorCommand paste()
```
    Returns a command that allows pasting content of the clipboard in a text field, text area or a WYSIWYG editor.
  - redo
```
public static EditorCommand redo()
```
    Returns a command that allows reversing the last undo() action.
  - scrollPageBackward
```
public static EditorCommand scrollPageBackward()
```
    Returns a command that allows scrolling a page backward.
  - scrollPageForward
```
public static EditorCommand scrollPageForward()
```
    Returns a command that allows scrolling a page forward.
  - scrollLineUp
```
public static EditorCommand scrollLineUp()
```
    Returns a command that allows scrolling one line up.
  - scrollLineDown
```
public static EditorCommand scrollLineDown()
```
    Returns a command that allows scrolling one line down.
  - scrollToBeginningOfDocument
```
public static EditorCommand scrollToBeginningOfDocument()
```
    Returns a command that allows scrolling content to the beginning of the document in the frame.
  - scrollToEndOfDocument
```
public static EditorCommand scrollToEndOfDocument()
```
    Returns a command that allows scrolling content to the end of the document in the frame.
  - selectAll
```
public static EditorCommand selectAll()
```
    Returns a command that allows selecting all text in the frame or the currently focused text field, text area or a WYSIWYG editor.
  - selectLine
```
public static EditorCommand selectLine()
```
    Returns a command that allows selecting a line at the caret position in a text area or a WYSIWYG editor.
  - selectParagraph
```
public static EditorCommand selectParagraph()
```
    Returns a command that allows selecting the whole paragraph at the caret position in a text area or a WYSIWYG editor.
  - selectSentence
```
public static EditorCommand selectSentence()
```
    Returns a command that allows selecting the whole sentence at the caret position in a text area or a WYSIWYG editor.
  - selectWord
```
public static EditorCommand selectWord()
```
    Returns a command that allows selecting the word at the caret position in a text field, text area or a WYSIWYG editor.
  - toggleBold
```
public static EditorCommand toggleBold()
```
    Returns a command that allows toggling bold style for the selected text in a WYSIWYG editor.
  - toggleItalic
```
public static EditorCommand toggleItalic()
```
    Returns a command that allows toggling italic style for the selected text in a WYSIWYG editor.
  - toggleUnderline
```
public static EditorCommand toggleUnderline()
```
    Returns a command that allows toggling underline style for the selected text in a WYSIWYG editor.
  - underline
```
public static EditorCommand underline()
```
    Returns a command that allows underlying the selected text in a WYSIWYG editor.
  - undo
```
public static EditorCommand undo()
```
    Returns a command that allows reversing the last action.
  - unselect
```
public static EditorCommand unselect()
```
    Returns a command that allows clearing the current selection in a frame.
  - strikethrough
```
public static EditorCommand strikethrough()
```
    Returns a command that allows making the selected text strikethrough in a WYSIWYG editor.
  - superscript
```
public static EditorCommand superscript()
```
    Returns a command that allows making the selected text superscript in a WYSIWYG editor.
  - subscript
```
public static EditorCommand subscript()
```
    Returns a command that allows making the selected text subscript in a WYSIWYG editor.
  - removeFormat
```
public static EditorCommand removeFormat()
```
    Returns a command that allows removing all styles of the selected text (bold, italic, etc.) in a WYSIWYG editor.
  - unlink
```
public static EditorCommand unlink()
```
    Returns a command that allows removing the link from the text in a WYSIWYG editor.
  - justifyCenter
```
public static EditorCommand justifyCenter()
```
    Returns a command that allows center justification the selected text in a WYSIWYG editor.
  - justifyFull
```
public static EditorCommand justifyFull()
```
    Returns a command that allows full justification the selected text in a WYSIWYG editor.
  - justifyLeft
```
public static EditorCommand justifyLeft()
```
    Returns a command that allows left justification the selected text in a WYSIWYG editor.
  - justifyRight
```
public static EditorCommand justifyRight()
```
    Returns a command that allows right justification the selected text in a WYSIWYG editor.
  - indent
```
public static EditorCommand indent()
```
    Returns a command that allows making indent of the selected text in a WYSIWYG editor.
  - outdent
```
public static EditorCommand outdent()
```
    Returns a command that allows making outdent of the selected text in a WYSIWYG editor.
  - insertOrderedList
```
public static EditorCommand insertOrderedList()
```
    Returns a command that allows inserting an ordered list in a WYSIWYG editor.
  - insertUnorderedList
```
public static EditorCommand insertUnorderedList()
```
    Returns a command that allows inserting an unordered list in a WYSIWYG editor.
  - backgroundColor
```
public static EditorCommand backgroundColor(Color color)
```
    Returns a command that allows setting the given background color for the selected text in a WYSIWYG editor.
    
    Parameters:
    
    color - a new background color
  - backgroundColor
```
public static EditorCommand backgroundColor(java.lang.String colorName)
```
    Returns a command that allows setting the given background colorName for the selected text in a WYSIWYG editor.
    
    Parameters:
    
    colorName - a new background color name
    
    Throws:
    
    java.lang.IllegalArgumentException - when colorName is empty or blank
  - findText
```
public static EditorCommand findText(java.lang.String text)
```
    Returns a command that allows searching for the given text occurrence from the current caret position in the frame. If match found, this command will select it and scroll down to make it visible, if needed.
    
    Parameters:
    
    text - a text to search
    
    Throws:
    
    java.lang.IllegalArgumentException - when text is empty
  - fontSize
```
public static EditorCommand fontSize(AbsoluteFontSize fontSize)
```
    Returns a command that allows setting the given fontSize for the selected text in a WYSIWYG editor.
    
    Parameters:
    
    fontSize - a new font size
  - fontName
```
public static EditorCommand fontName(FontName fontName)
```
    Returns a command that allows setting the given fontName for the selected text in a WYSIWYG editor.
    
    Parameters:
    
    fontName - a new font name
  - foregroundColor
```
public static EditorCommand foregroundColor(Color color)
```
    Returns a command that allows setting the given foreground color for the selected text in a WYSIWYG editor.
    
    Parameters:
    
    color - a new foreground color
  - foregroundColor
```
public static EditorCommand foregroundColor(java.lang.String colorName)
```
    Returns a command that allows setting the given foreground colorName for the selected text in a WYSIWYG editor.
    
    Parameters:
    
    colorName - a new foreground color name
    
    Throws:
    
    java.lang.IllegalArgumentException - when colorName is empty or blank
  - insertImage
```
public static EditorCommand insertImage(java.lang.String imageSrc)
```
    Returns a command that allows inserting an image with the given imageSrc in a WYSIWYG editor. If the imageSrc points to an invalid location, then image won't be inserted.
    
    Parameters:
    
    imageSrc - the value of the src attribute of the IMG tag
    
    Throws:
    
    java.lang.IllegalArgumentException - when imageSrc is empty or blank
  - insertHtml
```
public static EditorCommand insertHtml(java.lang.String html)
```
    Returns a command that allows inserting the given html content in a WYSIWYG editor.
    
    Parameters:
    
    html - an html content to insert.
    
    Throws:
    
    java.lang.IllegalArgumentException - when html is empty or blank
  - insertText
```
public static EditorCommand insertText(java.lang.String text)
```
    Returns a command that allows inserting the given text content in a WYSIWYG editor or a text field.
    
    Parameters:
    
    text - a text content to insert
  - createLink
```
public static EditorCommand createLink(java.lang.String url)
```
    Returns a command that allows making the link to the specified URL in a WYSIWYG editor.
    
    Parameters:
    
    url - the value of the href attribute of the A tag
    
    Throws:
    
    java.lang.IllegalArgumentException - when url is empty or blank
  - name
```
public EditorCommand.Name name()
```
    Returns the Name of the command.
  - value
```
public java.lang.String value()
```
    Returns a string that represents the command value.

Class EditorCommand

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

bold

copy

cut

delete

deleteBackward

deleteForward

deleteToBeginningOfLine

deleteWordBackward

deleteWordForward

insertNewLine

insertParagraph

insertTab

ignoreSpelling

italic

movePageUp

movePageDown

moveWordLeft

moveWordLeftAndModifySelection

moveWordRight

moveWordRightAndModifySelection

moveToBeginningOfLine

moveToBeginningOfLineAndModifySelection

moveToEndOfLine

moveToEndOfLineAndModifySelection

paste

redo

scrollPageBackward

scrollPageForward

scrollLineUp

scrollLineDown

scrollToBeginningOfDocument

scrollToEndOfDocument

selectAll

selectLine

selectParagraph

selectSentence

selectWord

toggleBold

toggleItalic

toggleUnderline

underline

undo

unselect

strikethrough

superscript

subscript

removeFormat

unlink

justifyCenter

justifyFull

justifyLeft

justifyRight

indent

outdent

insertOrderedList

insertUnorderedList

backgroundColor

backgroundColor

findText

fontSize

fontName

foregroundColor

foregroundColor

insertImage

insertHtml

insertText

createLink

name

value