com.ephox.editlive.common
Class TextEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.ephox.editlive.common.TextEvent
All Implemented Interfaces:
Serializable

public class TextEvent
extends EventObject

Object passed by EditLive! to raise events and actions.

On occasion it may be necessary to raise a custom event to notify EditLive! of an event.

See Also:
Serialized Form

Nested Class Summary
 class TextEvent.CustomAction
          The set of event codes used as the extra int in custom action events.
 
Field Summary
static int ABOUT_ACTION
          Displays the about dialog.
static int ACCEPT_ALL_CHANGES_ACTION
          Accept all changes in the document.
static int ACCEPT_CHANGE_ACTION
          Accept the first change in the current selection.
static int ADD_ATTRIBUTE_ACTION
          Deprecated. No longer used.
static int ADD_UNDO
          Adds an undo event to the undo manager.
static int ALIGN_CENTER_ACTION
          Centers the current paragraph.
static int ALIGN_LEFT_ACTION
          Aligns the current paragraph left.
static int ALIGN_RIGHT_ACTION
          Aligns the current paragraph right.
static int ALIGN_UPDATE_CENTER
          Notification that the caret is within a section with center alignment set.
static int ALIGN_UPDATE_LEFT
          Notification that the caret is within a section with left alignment set.
static int ALIGN_UPDATE_NONE
          Notification that the caret is within a section with no alignment set.
static int ALIGN_UPDATE_RIGHT
          Notification that the caret is within a section with right alignment set.
static int AUTO_CORRECT
          Sets the state of Auto Correct via a true/false string as the extra object.
static int BACKGROUND_SPELL_CHECKING
          Sets the state of Background Spell Checking via a true/false string as the extra object.
static int BIDI_ACTION
          Causes the text to be switched between left-to-right and right-to-left
static int BOLD_ACTION
          Bolds the currently selected text.
static int BOLD_UPDATE_OFF
          Notification that bold is off at the current cursor position.
static int BOLD_UPDATE_ON
          Notification that bold is on at the current cursor position.
static int BOOKMARK_ACTION
          Inserts a bookmark or edits one if the selected text already contains one.
static int BROWSER_MODE
          Causes the editor to switch back to browser mode.
static int CALL_JAVASCRIPT
          Calls a javascript function from the applet.
static int CAN_REDO
          The event fired when a redo is available.
static int CAN_UNDO
          The event fired when an undo is available.
static int CELL_PROPERTIES_ACTION
          Displays the cell properties dialog.
static int CLEAN_UP
          Prepares the editor for garbage collection by releasing most variable references.
static int CLEAR_STYLES_COMBO
          Clears the styles combo drop down.
static int COLUMN_PROPERTIES_ACTION
          Show the column properties dialog box.
static int CONVERT_ELEMENT_ACTION
          Deprecated. No longer used.
static int COPY_ACTION
          Copies the currently selected text.
static int CREATE_SECTION_ACTION
          Creates a Section from the selected text (if there is any)
static int CURRENT_ELEMENT_UPDATE
          Updates the path to the current XML element.
static int CUSTOM_ACTION
          A custom action that has been raised.
static int CUSTOM_INLINE_ACTION
          Apples a custom inline tag to the currently selected text.
static int CUSTOM_INLINE_UPDATE_OFF
          Notification that a Custom Inline tag is off at the current cursor position.
static int CUSTOM_INLINE_UPDATE_ON
          Notification that a Custom Inline tag is on at the current cursor position.
static int CUT_ACTION
          Cuts the currently selected text.
static int DAV_OPEN_ACTION
          Brings up a webdav browser to allow the user to select a file to open from the remote repository.
static int DAV_SAVE_ACTION
          Saves the current file file to the Oracle files repository it was opened from.
static int DAV_SAVEAS_ACTION
          Brings up a webdav browser to allow the user to select a file to save to an Oracle files repository.
static int DEFAULT_CURSOR_ACTION
          Sets the cursor to the default.
static int DELETE_CELL_ACTION
          Deletes a table cell.
static int DELETE_COLUMN_ACTION
          Deletes a table column.
static int DELETE_ROW_ACTION
          Deletes a table row.
static int DELETE_TABLE_ACTION
          Deletes the table the cursor is in
static int DESELECT_NODES_ACTION
          Deprecated. No longer used.
static int DESIGN_VIEW_ACTION
          Change editor pane to Design view.
static int DIRTY_CHANGED
          Used to notify bean listeners that the dirty state of the editor has changed.
static int DISABLE_CHANGE_RENDERING_ACTION
          Deprecated. no longer supported
static int DISABLE_IMAGE_RESAMPLING
          Stops the editor from resampling images when retrieving the HTML source
static int DISABLE_TRACK_CHANGES_ACTION
          Disable track changes on the document.
static int DISABLE_UNDO
          Temporarily disables undo events being added when manipulating the document directly.
static int DISPLAY_ACCESSIBILITY_REPORT_ACTION
          Display the accessibility report dialog.
static int DOUBLE_CLICK_ACTION
          Fired when the user double clicks in the HTMLPane.
static int EDIT_CUSTOM_TAG_ACTION
          Edits the selected custom tag.
static int EDIT_MATHML_ACTION
          Edits the MathML equation at the caret position.
static int EDITOR_INITIALIZED
          The notification that the editor has been initialized but the content is not necessarily loaded.
static int ENABLE_CHANGE_RENDERING_ACTION
          Deprecated. no longer supported
static int ENABLE_IMAGE_RESAMPLING
          Enables editor resampling images when retrieving the HTML source
static int ENABLE_TRACK_CHANGES_ACTION
          Enable track changes on the document.
static int ENABLE_UNDO
          Reenables undo events.
static int FIND_ACTION
          Displays the find dialog.
static int FLUSH_ENTITY_CACHE_ACTION
          Deprecated. No longer used.
static int FOCUS_MENUBAR
          Sets the focus to the menubar
static int FONT_COLOR_UPDATE
          Updates the currently selected font color.
static int FONT_NAME_UPDATE
          Notification that the font name (face) at the cursor has changed.
static int FONT_SIZE_ACTION
          Sets the font size for the selected text.
static int FONT_SIZE_UPDATE
          Notification that the font size of the text at the cursor has changed.
static int FONT_STYLE_ACTION
          Sets the style for the current paragraph.
static int FONT_STYLE_UPDATE
          Notification that the font style at the cursor has changed.
static int FONT_TYPE_ACTION
          Sets the font face for the selected text.
static int FORM_CHANGED_UPDATE
          Deprecated. No longer used.
static int FORM_FIELD_PROPERTIES_ACTION
          Notification that the caret is not within a form field.
static int FORM_PROPERTIES_ACTION
          Notification that the caret is not within a form field.
static int FORMAT_PAINTER_ACTION
          Activates the format painter function.
static int FORMAT_PAINTER_OFF
          Turns off the format painter button indicating that no format is ready to be painted anymore.
static int FORMAT_PAINTER_ON
          Turns on the format painter button indicating that a format is ready to be painted.
static int GET_XML_NODE_VALUE
          Deprecated. No longer used.
static int GRIDLINES_ACTION
          Toggle on/off the display of table girdlines.
static int HAVE_CHANGES_UPDATE
          Notification that operations now exist in the document.
static int HIGHLIGHT_COLOR_UPDATE
          Updates the currently selected font color.
static int HR_PROPERTIES_ACTION
          Display the HR properties dialog.
static int HYPERLINK_ACTION
          Inserts a hyperlink or edits one if the selected text already contains one.
static int IMAGE_LOADED
          Fires when an image is first loaded or something causes it to be resized
static int IMAGE_PROPERTIES_ACTION
          Displays the image properties dialog.
static int IMAGE_RESIZED
          Indicates that an image has just been resized.
static int IMPORT_WORD_DOCUMENT
          Import a word document from the filesystem
static int IN_BOOKMARK_UPDATE
          Indicates that the caret has been placed inside a hyperlink.
static int IN_CHANGE_UPDATE
          Notification that the current caret position is within an unaccepted change to the document.
static int IN_DIV_UPDATE
          Indicates that the caret has been placed inside a div or that only a div is selected.
static int IN_EDITABLE_CONTENT_UPDATE
          Indicates that the caret is positioned within editable content.
static int IN_FORM
          Notification that the caret is within a form.
static int IN_FORM_FIELD
          Notification that the caret is within a form field.
static int IN_HYPERLINK_UPDATE
          Indicates that the caret has been placed inside a hyperlink.
static int IN_TABLE
          Notification that the caret is within a table.
static int IN_XHTML_UPDATE
          Deprecated. No longer used.
static int INDENT_ACTION
          Indents the current selection.
static int INSERT_BUTTON_FIELD_ACTION
          Inserts a new BUTTON INPUT element
static int INSERT_CELL_ACTION
          Inserts a table cell.
static int INSERT_CHECKBOX_FIELD_ACTION
          Inserts a new CHECKBOX INPUT element
static int INSERT_COLUMN_ACTION
          Inserts a table column.
static int INSERT_COMMENT
          Inserts an HTML comment.
static int INSERT_DATE_TIME_ACTION
          Opens the Insert Date and Time dialog.
static int INSERT_ELEMENT_ACTION
          Deprecated. No longer used.
static int INSERT_ELEMENT_AFTER_ACTION
          Deprecated. No longer used.
static int INSERT_ELEMENT_BEFORE_ACTION
          Deprecated. No longer used.
static int INSERT_FILE_FIELD_ACTION
          Inserts a new FILE INPUT element
static int INSERT_FORM_ACTION
          Inserts a new FORM element if the caret is not currently positioned within an existing FORM
static int INSERT_HIDDEN_FIELD_ACTION
          Inserts a new HIDDEN INPUT element
static int INSERT_HR_ACTION
          Inserts a horizontal rule.
static int INSERT_IMAGE_ACTION
          Inserts an image.
static int INSERT_IMAGE_FIELD_ACTION
          Inserts a new IMAGE INPUT element
static int INSERT_LOCAL_IMAGE_ACTION
          Inserts a local image.
static int INSERT_MATHML_ACTION
          Inserts a MathML equation at the current caret position.
static int INSERT_OBJECT_ACTION
          Show the insert object dialog to allow the user to insert an object tag.
static int INSERT_PASSWORD_FIELD_ACTION
          Inserts a new PASSWORD INPUT element
static int INSERT_RADIO_FIELD_ACTION
          Inserts a new RADIO INPUT element
static int INSERT_RESET_FIELD_ACTION
          Inserts a new RESET INPUT element
static int INSERT_ROW_ACTION
          Inserts a table row.
static int INSERT_ROW_COLUMN_ACTION
          Displays the insert row/column dialog.
static int INSERT_SELECT_FIELD_ACTION
          Inserts a new SELECT INPUT element
static int INSERT_SUBMIT_FIELD_ACTION
          Inserts a new SUBMIT INPUT element
static int INSERT_SYMBOL_ACTION
          Inserts a symbol at the caret position.
static int INSERT_TABLE_ACTION
          Inserts a table.
static int INSERT_TABLE_WIZARD_ACTION
          Insert a table with a specified number of rows and columns.
static int INSERT_TEXT_FIELD_ACTION
          Inserts a new TEXT INPUT element
static int INSERT_TEXTAREA_FIELD_ACTION
          Inserts a new TEXTAREA INPUT element
static int IS_CUSTOM_TAG_UPDATE
          Indicates that the caret has been placed on an image or that only an image is selected.
static int IS_HR_UPDATE
          Indicates that the selection is a HR.
static int IS_IMAGE_UPDATE
          Indicates that the caret has been placed on an image or that only an image is selected.
static int IS_LIST_UPDATE
          Indicates that the caret has been placed in a list.
static int IS_MATHML_UPDATE
          Indicates that the selection is a MathML element.
static int IS_OBJECT_UPDATE
          Indicates that the selection is an object.
static int ITALIC_ACTION
          Italicises the currently selected text.
static int ITALIC_UPDATE_OFF
          Notification that italic is off at the current cursor position.
static int ITALIC_UPDATE_ON
          Notification that italic is on at the current cursor position.
static int IWWCM_DOMINO_FILE
           
static int IWWCM_DOMINO_HYPERLINK
           
static int IWWCM_DOMINO_IMAGE
           
static int IWWCM_HYPERLINK_DIALOG
          Calls to JavaScript to launch the IWWCM 6.0 Insert Hyperlink Dialog
static int IWWCM_IMAGE_DIALOG
          Calls to JavaScript to launch the IWWCM 6.0 Insert Image Dialog
static int JOIN_ELEMENTS_ACTION
          Deprecated. No longer used.
static int LINK_CLICKED
          Fired when the user clicks on a link that is not editable.
static int LIST_PROPERTIES_ACTION
          Displays the table properties dialog.
static int LIST_UPDATE_NONE
          Notification that the caret is not within a list.
static int LIST_UPDATE_ORDERED
          Notification that the caret is within an ordered list.
static int LIST_UPDATE_UNORDERED
          Notification that the caret is within an unordered list.
static int LOADING_COMPLETE
          The notification that the editor has completely finished loading.
static int LOG_CURRENT_STATE
          Causes the editor to log its current state.
static int MENU_COLOR_ACTION
          Sets the color for the selected text.
static int MENU_HIGHLIGHT_ACTION
          Sets the background color for the selected text.
static int MENUBAR_CREATED
          Indicates that the menu bar has finished loading
static int MERGE_ACTION
          Merges the selected tables cells.
static int MOVE_ELEMENT_DOWN_ACTION
          Deprecated. No longer used.
static int MOVE_ELEMENT_UP_ACTION
          Deprecated. No longer used.
static int NEW_ACTION
          Creates a new document in the editor.
static int NEXT_OPERATION_ACTION
          Select the next unaccepted change after the current caret position.
static int NO_CHANGES_UPDATE
          Notification that there are no operations in the document.
static int NO_TABLE_SELECTION_UPDATE
          Notification that the selection is no longer in table cell mode.
static int NO_TEXT_SELECTED
          Notification that no text is selected in the editor.
static int NOT_CUSTOM_TAG_UPDATE
          Indicates that the caret is no longer on an image.
static int NOT_HR_UPDATE
          Indicates that the selection is not a HR.
static int NOT_IMAGE_UPDATE
          Indicates that the caret is no longer on an image.
static int NOT_IN_BOOKMARK_UPDATE
          Indicates that the caret is no longer in a hyperlink.
static int NOT_IN_CHANGE_UPDATE
          Notification that the current caret position is not within an unaccepted change to the document.
static int NOT_IN_DIV_UPDATE
          Indicates that the caret is no longer inside a div.
static int NOT_IN_EDITABLE_CONTENT_UPDATE
          Indicates that the caret is positioned within uneditable content.
static int NOT_IN_FORM
          Notification that the caret is not within a form.
static int NOT_IN_FORM_FIELD
          Notification that the caret is not within a form field.
static int NOT_IN_HYPERLINK_UPDATE
          Indicates that the caret is no longer in a hyperlink.
static int NOT_IN_TABLE
          Notification that the caret is not within a table.
static int NOT_IN_XHTML_UPDATE
          Deprecated. No longer used.
static int NOT_MATHML_UPDATE
          Indicates that the selection is not a MathML element.
static int NOT_OBJECT_UPDATE
          Indicates that the selection is not an object.
static int OBJECT_PROPERTIES_ACTION
          Show the object properties dialog.
static int OPEN_ACTION
          Opens a document in the editor.
static int ORDERED_LIST_ACTION
          Inserts an ordered list.
static int OUTDENT_ACTION
          Outdents the current selection.
static int PARAGRAPH_MARKER_ACTION
          Toggles the paragraph marker on and off.
static int PARAGRAPH_MARKER_UPDATE_OFF
          Notification that the paragraph marker is off.
static int PARAGRAPH_MARKER_UPDATE_ON
          Notification that the paragraph marker is on.
static int PASTE_ACTION
          Pastes the contents of the clipboard.
static int PASTE_SPECIAL_ACTION
          Pastes the contents of the clipboard using the selected method from the Paste Special dialog.
static int POPULATE_STYLES_COMBO
          Populates the styles combo.
static int PREVIEW_IN_BROWSER_ACTION
          Deprecated. No longer used.
static int PREVIOUS_OPERATION_ACTION
          Select the first unaccepted change before the current caret position.
static int PRINT_ACTION
          Prints the current editor contents in a new browser window.
static int QUICKR_EXTERNAL_HYPERLINK_DIALOG
          Calls to JavaScript to launch the Quickr external hyperlink dialog
static int QUICKR_HYPERLINK_DIALOG
          Calls to JavaScript to launch the Quickr Insert Hyperlink Dialog
static int QUICKR_IMAGE_DIALOG
          Calls to JavaScript to launch the Quickr Insert Image Dialog
static int QUICKR_LOCAL_DOCUMENT_PICKER
          Calls to JavaScript to launch the Quickr local document picker
static int QUICKR_REMOTE_DOCUMENT_PICKER
          Calls to JavaScript to launch the Quickr remote document picker
static int REDO_ACTION
          Causes the last undone action to be redone.
static int REFORMAT
          Reformats the text in source view.
static int REINITIALIZE
          Reinitializes the bean.
static int REJECT_ALL_CHANGES_ACTION
          Accept all changes in the document.
static int REJECT_CHANGE_ACTION
          Reject the first change in the current selection.
static int RELOAD_XHTML_BLOCK
          Deprecated. No longer used.
static int REMOVE_BOOKMARK_ACTION
          Removes the bookmark at the cursor
static int REMOVE_ELEMENT_ACTION
          Deprecated. No longer used.
static int REMOVE_FORMATTING_ACTION
          Remove the formatting from the current selection.
static int REMOVE_HYPERLINK_ACTION
          Removes the hyperlink from the current selection.
static int REMOVE_SECTION_ACTION
          Removes the Section at the cursor location
static int REPLACE_WORD_ACTION
          Replaces the current word in the HTMLPane with the extra string of the event.
static int ROW_PROPERTIES_ACTION
          Show the row properties dialog box.
static int SAVE_ACTION
          Saves the current document to a file.
static int SAVE_AS_ACTION
          Saves the current document to a file the user specifies.
static int SCRIPT_UPDATE_SUB_OFF
          Toggles the sub button off.
static int SCRIPT_UPDATE_SUB_ON
          Toggles sub button on
static int SCRIPT_UPDATE_SUP_OFF
          Toggles the sup button off.
static int SCRIPT_UPDATE_SUP_ON
          Toggles sup button on.
static int SECTION_PROPERTIES_ACTION
          Displays the Section properties dialog.
static int SELECT_ALL_ACTION
          Selects the entire document.
static int SELECT_NODE_ACTION
          Selects the element passed in as the extra object.
static int SELECT_OPERATION_ACTION
          Select the range affected by a track changes operation.
static int SET_CARET_POSITION
          Scroll the design view to the specified position.
static int SET_TEXT_LTR
          Toggles the currently selected block elements for LTR
static int SET_TEXT_RTL
          Toggles the currently selected block elements for RTL
static int SET_USERNAME
          Set the user name for the current user.
static int SET_XSLT
          Deprecated. No longer used.
static int SHOW_ATTRIBUTE_PANE_ACTION
          Deprecated. No longer used.
static int SHOW_CONTEXT_MENU
          Shows the contextual menu.
static int SHOW_CUSTOM_PROPERTIES
          Indicates that a custom properties dialog should be shown by the host of the bean.
static int SHOW_DOCUMENT_NAVIGATOR_ACTION
          Shows or hides the document navigator.
static int SHOW_TAGS_ACTION
          Deprecated. No longer used.
static int SHOW_TRACK_CHANGES_DIALOG
          Show the track changes dialog.
static int SHOW_TREE_VIEW_ACTION
          Deprecated. No longer used.
static int SHOW_VALIDATION_PANE_ACTION
          Deprecated. No longer used.
static int SOME_TEXT_SELECTED
          Notification that some text is selected in the editor.
static int SOURCE_RETRIEVED
          A notification that the current contents of the editor are about to be retrieved, usually during the save process
static int SPELLING_ACTION
          Spell checks the document.
static int SPELLING_FINISHED
          Fired when the spelling dialog is closed.
static int SPLIT_ACTION
          Splits the current table cell.
static int STORE_XHTML_ACTION
          Deprecated. No longer used.
static int STRIKE_ACTION
          Adds strikethrough to the currently selected text.
static int STRIKE_UPDATE_OFF
          Notification that strikethrough is off at the current cursor position.
static int STRIKE_UPDATE_ON
          Notification that strikethrough is on at the current cursor position.
static int SUB_ACTION
          Sub the currently selected text.
static int SUP_ACTION
          Sup the currently selected text.
static int SYNC_XHTML_ACTION
          Deprecated. No longer used.
static int TAB_CHANGED_ACTION
          Notification that the user has selected a different tab.
static int TAB_CHANGED_UPDATE
          Notifies the tab row that it should update the selected tab.
static int TABLE_AUTOFIT
          Automatically sizes columns in the current table
static int TABLE_PROPERTIES_ACTION
          Displays the table properties dialog.
static int TABLE_SELECTION_UPDATE
          Notification that the selection is now in table cell mode.
static int TAG_LIST_UPDATE
          An updated list of tags that form the containment hierarchy at the current caret position.
static int TARGET_VIEW_CHANGE
          Deprecated. No longer used.
static int TEXT_DIRECTION_UPDATE
          Notification that the current block element is LTR, RTL or none.
static int TEXT_VIEW_ACTION
          Change editor pane to text view.
static int THESAURUS_DIALOG_ACTION
          Shows the Thesaurus Dialog.
static int TOOLBAR_COLOR_ACTION
          Deprecated. The toolbar color button now uses MENU_COLOR_ACTION.
static int TOOLBAR_CREATED
          Indicates that the toolbar has finished loading
static int TRANSFER_FOCUS
          Tells the applet to transfer input focus out of the editor.
static int UNDERLINE_ACTION
          Underlines the currently selected text.
static int UNDERLINE_UPDATE_OFF
          Notification that underline is off at the current cursor position.
static int UNDERLINE_UPDATE_ON
          Notification that underline is on at the current cursor position.
static int UNDO_ACTION
          Causes the last action to be undone.
static int UNDO_ADDED
          The event that is broadcasted when an undo event has been added to the undo/redo manager.
static int UNORDERED_LIST_ACTION
          Inserts an unordered list.
static int UPDATE_LOAD_PROGRESS
          Updates the progress bar while the applet is loading.
static int UPDATE_STATE
          Updates the enabled state of the toolbar buttons and menu items of the editor.
static int UPLOAD_FORM_ACTION
          Deprecated. No longer used.
static int VALIDATE_XML_ACTION
          Deprecated. No longer used.
static int WAIT_CURSOR_ACTION
          Sets the cursor to the busy cursor.
static int WINDOW_MODE
          Causes the editor to switch to window mode.
static int WORD_COUNT_ACTION
          Displays the word count dialog.
static int XML_CHANGED_UPDATE
          Deprecated. No longer used.
static int XML_CLEAR_ERRORS
          Deprecated. No longer used.
static int XML_ERROR_UPDATE
          Deprecated. No longer used.
static int XML_FOCUS_ELEMENT
          Deprecated. No longer used.
static int XML_VALIDATION_FINISHED
          Deprecated. No longer used.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
TextEvent(Object source, int action, Object extraS, int extraI)
          Creates a new TextEvent.
 
Method Summary
 boolean equals(Object o)
           
 int getActionCommand()
          Returns the action ID.
 int getExtraInt()
          Returns the extra int.
 Object getExtraObject()
          Returns the extra object.
 String getExtraString()
          Returns the extra object information as a String, or null if it is not an instance of String.
 int hashCode()
           
 boolean isHandled()
          Returns true if the event has been handled.
 boolean isRaiseEventAction(String raiseEventName)
          Returns true if this is a Raise Event action that matches the string passed in
static boolean isRaiseEventAction(TextEvent event, String raiseEventName)
          Deprecated. use isRaiseEventAction(String) instead
 void setExtraString(String string)
           
 void setHandled(boolean b)
          Sets whether or not this event has been handled.
 String toString()
          Returns a String representation of this TextEvent.
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

CAN_REDO

public static final int CAN_REDO
The event fired when a redo is available.

See Also:
Constant Field Values

CAN_UNDO

public static final int CAN_UNDO
The event fired when an undo is available.

See Also:
Constant Field Values

REDO_ACTION

public static final int REDO_ACTION
Causes the last undone action to be redone.

See Also:
Constant Field Values

UNDO_ACTION

public static final int UNDO_ACTION
Causes the last action to be undone.

See Also:
Constant Field Values

WINDOW_MODE

public static final int WINDOW_MODE
Causes the editor to switch to window mode. Not available in the bean version.

See Also:
Constant Field Values

BROWSER_MODE

public static final int BROWSER_MODE
Causes the editor to switch back to browser mode. Not available in the bean version.

See Also:
Constant Field Values

CLEAN_UP

public static final int CLEAN_UP
Prepares the editor for garbage collection by releasing most variable references. The editor would be garbage collected anyway, this event simply makes the garbage collection more efficient by reducing the number of circular references. This event should not be fired in the JavaBean.

See Also:
Constant Field Values

CLEAR_STYLES_COMBO

public static final int CLEAR_STYLES_COMBO
Clears the styles combo drop down. NOTE: This has been deprecated and will do nothing if used in an event.

See Also:
Constant Field Values

POPULATE_STYLES_COMBO

public static final int POPULATE_STYLES_COMBO
Populates the styles combo.

See Also:
Constant Field Values

SOME_TEXT_SELECTED

public static final int SOME_TEXT_SELECTED
Notification that some text is selected in the editor.

See Also:
Constant Field Values

NO_TEXT_SELECTED

public static final int NO_TEXT_SELECTED
Notification that no text is selected in the editor.

See Also:
Constant Field Values

NOT_IN_TABLE

public static final int NOT_IN_TABLE
Notification that the caret is not within a table.

See Also:
Constant Field Values

IN_TABLE

public static final int IN_TABLE
Notification that the caret is within a table.

See Also:
Constant Field Values

LIST_UPDATE_NONE

public static final int LIST_UPDATE_NONE
Notification that the caret is not within a list.

See Also:
Constant Field Values

LIST_UPDATE_ORDERED

public static final int LIST_UPDATE_ORDERED
Notification that the caret is within an ordered list.

See Also:
Constant Field Values

LIST_UPDATE_UNORDERED

public static final int LIST_UPDATE_UNORDERED
Notification that the caret is within an unordered list.

See Also:
Constant Field Values

ALIGN_UPDATE_NONE

public static final int ALIGN_UPDATE_NONE
Notification that the caret is within a section with no alignment set.

See Also:
Constant Field Values

ALIGN_UPDATE_LEFT

public static final int ALIGN_UPDATE_LEFT
Notification that the caret is within a section with left alignment set.

See Also:
Constant Field Values

ALIGN_UPDATE_CENTER

public static final int ALIGN_UPDATE_CENTER
Notification that the caret is within a section with center alignment set.

See Also:
Constant Field Values

ALIGN_UPDATE_RIGHT

public static final int ALIGN_UPDATE_RIGHT
Notification that the caret is within a section with right alignment set.

See Also:
Constant Field Values

FONT_SIZE_UPDATE

public static final int FONT_SIZE_UPDATE
Notification that the font size of the text at the cursor has changed. The extra string should be the new font size.

See Also:
Constant Field Values

FONT_STYLE_UPDATE

public static final int FONT_STYLE_UPDATE
Notification that the font style at the cursor has changed. The extra string should be the new font style.

See Also:
Constant Field Values

FONT_NAME_UPDATE

public static final int FONT_NAME_UPDATE
Notification that the font name (face) at the cursor has changed. The extra string should be the new font name.

See Also:
Constant Field Values

UNDERLINE_UPDATE_OFF

public static final int UNDERLINE_UPDATE_OFF
Notification that underline is off at the current cursor position.

See Also:
Constant Field Values

UNDERLINE_UPDATE_ON

public static final int UNDERLINE_UPDATE_ON
Notification that underline is on at the current cursor position.

See Also:
Constant Field Values

ITALIC_UPDATE_OFF

public static final int ITALIC_UPDATE_OFF
Notification that italic is off at the current cursor position.

See Also:
Constant Field Values

ITALIC_UPDATE_ON

public static final int ITALIC_UPDATE_ON
Notification that italic is on at the current cursor position.

See Also:
Constant Field Values

BOLD_UPDATE_OFF

public static final int BOLD_UPDATE_OFF
Notification that bold is off at the current cursor position.

See Also:
Constant Field Values

BOLD_UPDATE_ON

public static final int BOLD_UPDATE_ON
Notification that bold is on at the current cursor position.

See Also:
Constant Field Values

DESIGN_VIEW_ACTION

public static final int DESIGN_VIEW_ACTION
Change editor pane to Design view.

See Also:
Constant Field Values

TEXT_VIEW_ACTION

public static final int TEXT_VIEW_ACTION
Change editor pane to text view.

See Also:
Constant Field Values

CUT_ACTION

public static final int CUT_ACTION
Cuts the currently selected text.

See Also:
Constant Field Values

COPY_ACTION

public static final int COPY_ACTION
Copies the currently selected text.

See Also:
Constant Field Values

PASTE_ACTION

public static final int PASTE_ACTION
Pastes the contents of the clipboard.

See Also:
Constant Field Values

SELECT_ALL_ACTION

public static final int SELECT_ALL_ACTION
Selects the entire document.

See Also:
Constant Field Values

ALIGN_RIGHT_ACTION

public static final int ALIGN_RIGHT_ACTION
Aligns the current paragraph right.

See Also:
Constant Field Values

ALIGN_LEFT_ACTION

public static final int ALIGN_LEFT_ACTION
Aligns the current paragraph left.

See Also:
Constant Field Values

ALIGN_CENTER_ACTION

public static final int ALIGN_CENTER_ACTION
Centers the current paragraph.

See Also:
Constant Field Values

UNDERLINE_ACTION

public static final int UNDERLINE_ACTION
Underlines the currently selected text.

See Also:
Constant Field Values

ITALIC_ACTION

public static final int ITALIC_ACTION
Italicises the currently selected text.

See Also:
Constant Field Values

BOLD_ACTION

public static final int BOLD_ACTION
Bolds the currently selected text.

See Also:
Constant Field Values

DEFAULT_CURSOR_ACTION

public static final int DEFAULT_CURSOR_ACTION
Sets the cursor to the default.

See Also:
Constant Field Values

WAIT_CURSOR_ACTION

public static final int WAIT_CURSOR_ACTION
Sets the cursor to the busy cursor.

See Also:
Constant Field Values

INSERT_MATHML_ACTION

public static final int INSERT_MATHML_ACTION
Inserts a MathML equation at the current caret position. Only available when a MathML editor is available.

See Also:
Constant Field Values

EDIT_MATHML_ACTION

public static final int EDIT_MATHML_ACTION
Edits the MathML equation at the caret position. Only available when a MathML editor is available.

See Also:
Constant Field Values

WORD_COUNT_ACTION

public static final int WORD_COUNT_ACTION
Displays the word count dialog.

See Also:
Constant Field Values

SPELLING_ACTION

public static final int SPELLING_ACTION
Spell checks the document.

See Also:
Constant Field Values

INSERT_SYMBOL_ACTION

public static final int INSERT_SYMBOL_ACTION
Inserts a symbol at the caret position.

See Also:
Constant Field Values

SPLIT_ACTION

public static final int SPLIT_ACTION
Splits the current table cell.

See Also:
Constant Field Values

MERGE_ACTION

public static final int MERGE_ACTION
Merges the selected tables cells.

See Also:
Constant Field Values

INSERT_COLUMN_ACTION

public static final int INSERT_COLUMN_ACTION
Inserts a table column.

See Also:
Constant Field Values

INSERT_ROW_ACTION

public static final int INSERT_ROW_ACTION
Inserts a table row.

See Also:
Constant Field Values

INSERT_CELL_ACTION

public static final int INSERT_CELL_ACTION
Inserts a table cell.

See Also:
Constant Field Values

INSERT_ROW_COLUMN_ACTION

public static final int INSERT_ROW_COLUMN_ACTION
Displays the insert row/column dialog.

See Also:
Constant Field Values

DELETE_CELL_ACTION

public static final int DELETE_CELL_ACTION
Deletes a table cell.

See Also:
Constant Field Values

DELETE_ROW_ACTION

public static final int DELETE_ROW_ACTION
Deletes a table row.

See Also:
Constant Field Values

DELETE_COLUMN_ACTION

public static final int DELETE_COLUMN_ACTION
Deletes a table column.

See Also:
Constant Field Values

CELL_PROPERTIES_ACTION

public static final int CELL_PROPERTIES_ACTION
Displays the cell properties dialog.

See Also:
Constant Field Values

TABLE_PROPERTIES_ACTION

public static final int TABLE_PROPERTIES_ACTION
Displays the table properties dialog.

See Also:
Constant Field Values

INSERT_TABLE_ACTION

public static final int INSERT_TABLE_ACTION
Inserts a table.

See Also:
Constant Field Values

INSERT_IMAGE_ACTION

public static final int INSERT_IMAGE_ACTION
Inserts an image.

See Also:
Constant Field Values

INSERT_LOCAL_IMAGE_ACTION

public static final int INSERT_LOCAL_IMAGE_ACTION
Inserts a local image.

See Also:
Constant Field Values

EDIT_CUSTOM_TAG_ACTION

public static final int EDIT_CUSTOM_TAG_ACTION
Edits the selected custom tag.

See Also:
Constant Field Values

IMAGE_PROPERTIES_ACTION

public static final int IMAGE_PROPERTIES_ACTION
Displays the image properties dialog.

See Also:
Constant Field Values

ORDERED_LIST_ACTION

public static final int ORDERED_LIST_ACTION
Inserts an ordered list.

See Also:
Constant Field Values

UNORDERED_LIST_ACTION

public static final int UNORDERED_LIST_ACTION
Inserts an unordered list.

See Also:
Constant Field Values

UPLOAD_FORM_ACTION

@Deprecated
public static final int UPLOAD_FORM_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

INSERT_HR_ACTION

public static final int INSERT_HR_ACTION
Inserts a horizontal rule.

See Also:
Constant Field Values

HYPERLINK_ACTION

public static final int HYPERLINK_ACTION
Inserts a hyperlink or edits one if the selected text already contains one.

See Also:
Constant Field Values

BOOKMARK_ACTION

public static final int BOOKMARK_ACTION
Inserts a bookmark or edits one if the selected text already contains one.

See Also:
Constant Field Values

MENU_COLOR_ACTION

public static final int MENU_COLOR_ACTION
Sets the color for the selected text.

See Also:
Constant Field Values

TOOLBAR_COLOR_ACTION

@Deprecated
public static final int TOOLBAR_COLOR_ACTION
Deprecated. The toolbar color button now uses MENU_COLOR_ACTION.
No longer used.

See Also:
Constant Field Values

INDENT_ACTION

public static final int INDENT_ACTION
Indents the current selection.

See Also:
Constant Field Values

OUTDENT_ACTION

public static final int OUTDENT_ACTION
Outdents the current selection.

See Also:
Constant Field Values

FONT_SIZE_ACTION

public static final int FONT_SIZE_ACTION
Sets the font size for the selected text.

See Also:
Constant Field Values

FONT_TYPE_ACTION

public static final int FONT_TYPE_ACTION
Sets the font face for the selected text.

See Also:
Constant Field Values

FONT_STYLE_ACTION

public static final int FONT_STYLE_ACTION
Sets the style for the current paragraph.

See Also:
Constant Field Values

FIND_ACTION

public static final int FIND_ACTION
Displays the find dialog.

See Also:
Constant Field Values

OPEN_ACTION

public static final int OPEN_ACTION
Opens a document in the editor.

See Also:
Constant Field Values

NEW_ACTION

public static final int NEW_ACTION
Creates a new document in the editor.

See Also:
Constant Field Values

SAVE_ACTION

public static final int SAVE_ACTION
Saves the current document to a file.

See Also:
Constant Field Values

SAVE_AS_ACTION

public static final int SAVE_AS_ACTION
Saves the current document to a file the user specifies.

See Also:
Constant Field Values

CUSTOM_ACTION

public static final int CUSTOM_ACTION
A custom action that has been raised. The custom action to perform is stored in the extra int.

See Also:
Constant Field Values

UPDATE_LOAD_PROGRESS

public static final int UPDATE_LOAD_PROGRESS
Updates the progress bar while the applet is loading. Not applicable for the JavaBean or once the applet has loaded.

See Also:
Constant Field Values

ABOUT_ACTION

public static final int ABOUT_ACTION
Displays the about dialog.

See Also:
Constant Field Values

FORM_CHANGED_UPDATE

@Deprecated
public static final int FORM_CHANGED_UPDATE
Deprecated. No longer used.
See Also:
Constant Field Values

SHOW_CONTEXT_MENU

public static final int SHOW_CONTEXT_MENU
Shows the contextual menu. The extra object should be the Point the menu should be shown as.

See Also:
Constant Field Values

IN_HYPERLINK_UPDATE

public static final int IN_HYPERLINK_UPDATE
Indicates that the caret has been placed inside a hyperlink.

See Also:
Constant Field Values

NOT_IN_HYPERLINK_UPDATE

public static final int NOT_IN_HYPERLINK_UPDATE
Indicates that the caret is no longer in a hyperlink.

See Also:
Constant Field Values

IS_IMAGE_UPDATE

public static final int IS_IMAGE_UPDATE
Indicates that the caret has been placed on an image or that only an image is selected.

See Also:
Constant Field Values

NOT_IMAGE_UPDATE

public static final int NOT_IMAGE_UPDATE
Indicates that the caret is no longer on an image.

See Also:
Constant Field Values

IS_CUSTOM_TAG_UPDATE

public static final int IS_CUSTOM_TAG_UPDATE
Indicates that the caret has been placed on an image or that only an image is selected.

See Also:
Constant Field Values

NOT_CUSTOM_TAG_UPDATE

public static final int NOT_CUSTOM_TAG_UPDATE
Indicates that the caret is no longer on an image.

See Also:
Constant Field Values

IN_BOOKMARK_UPDATE

public static final int IN_BOOKMARK_UPDATE
Indicates that the caret has been placed inside a hyperlink.

See Also:
Constant Field Values

NOT_IN_BOOKMARK_UPDATE

public static final int NOT_IN_BOOKMARK_UPDATE
Indicates that the caret is no longer in a hyperlink.

See Also:
Constant Field Values

TAB_CHANGED_ACTION

public static final int TAB_CHANGED_ACTION
Notification that the user has selected a different tab.

See Also:
Constant Field Values

TAB_CHANGED_UPDATE

public static final int TAB_CHANGED_UPDATE
Notifies the tab row that it should update the selected tab.

See Also:
Constant Field Values

GRIDLINES_ACTION

public static final int GRIDLINES_ACTION
Toggle on/off the display of table girdlines.

See Also:
Constant Field Values

REMOVE_FORMATTING_ACTION

public static final int REMOVE_FORMATTING_ACTION
Remove the formatting from the current selection.

See Also:
Constant Field Values

LIST_PROPERTIES_ACTION

public static final int LIST_PROPERTIES_ACTION
Displays the table properties dialog.

See Also:
Constant Field Values

IS_LIST_UPDATE

public static final int IS_LIST_UPDATE
Indicates that the caret has been placed in a list.

See Also:
Constant Field Values

STRIKE_UPDATE_ON

public static final int STRIKE_UPDATE_ON
Notification that strikethrough is on at the current cursor position.

See Also:
Constant Field Values

STRIKE_UPDATE_OFF

public static final int STRIKE_UPDATE_OFF
Notification that strikethrough is off at the current cursor position.

See Also:
Constant Field Values

STRIKE_ACTION

public static final int STRIKE_ACTION
Adds strikethrough to the currently selected text.

See Also:
Constant Field Values

MENU_HIGHLIGHT_ACTION

public static final int MENU_HIGHLIGHT_ACTION
Sets the background color for the selected text.

See Also:
Constant Field Values

CUSTOM_INLINE_UPDATE_OFF

public static final int CUSTOM_INLINE_UPDATE_OFF
Notification that a Custom Inline tag is off at the current cursor position.

See Also:
Constant Field Values

CUSTOM_INLINE_UPDATE_ON

public static final int CUSTOM_INLINE_UPDATE_ON
Notification that a Custom Inline tag is on at the current cursor position.

See Also:
Constant Field Values

CUSTOM_INLINE_ACTION

public static final int CUSTOM_INLINE_ACTION
Apples a custom inline tag to the currently selected text.

See Also:
Constant Field Values

DAV_SAVE_ACTION

public static final int DAV_SAVE_ACTION
Saves the current file file to the Oracle files repository it was opened from.

See Also:
Constant Field Values

DAV_SAVEAS_ACTION

public static final int DAV_SAVEAS_ACTION
Brings up a webdav browser to allow the user to select a file to save to an Oracle files repository.

See Also:
Constant Field Values

DAV_OPEN_ACTION

public static final int DAV_OPEN_ACTION
Brings up a webdav browser to allow the user to select a file to open from the remote repository.

See Also:
Constant Field Values

SHOW_CUSTOM_PROPERTIES

public static final int SHOW_CUSTOM_PROPERTIES
Indicates that a custom properties dialog should be shown by the host of the bean. This event does nothing inside EditLive! and is only intended as a flag for external components.

See Also:
Constant Field Values

TAG_LIST_UPDATE

public static final int TAG_LIST_UPDATE
An updated list of tags that form the containment hierarchy at the current caret position. Each tag is separated by whitespace and tags may appear in any order.

See Also:
Constant Field Values

NO_TABLE_SELECTION_UPDATE

public static final int NO_TABLE_SELECTION_UPDATE
Notification that the selection is no longer in table cell mode.

See Also:
Constant Field Values

TABLE_SELECTION_UPDATE

public static final int TABLE_SELECTION_UPDATE
Notification that the selection is now in table cell mode.

See Also:
Constant Field Values

COLUMN_PROPERTIES_ACTION

public static final int COLUMN_PROPERTIES_ACTION
Show the column properties dialog box.

See Also:
Constant Field Values

ROW_PROPERTIES_ACTION

public static final int ROW_PROPERTIES_ACTION
Show the row properties dialog box.

See Also:
Constant Field Values

ADD_UNDO

public static final int ADD_UNDO
Adds an undo event to the undo manager. This only has effect if we are not already in the middle of changing the HTML DOM.

See Also:
Constant Field Values

INSERT_ELEMENT_BEFORE_ACTION

@Deprecated
public static final int INSERT_ELEMENT_BEFORE_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

INSERT_ELEMENT_AFTER_ACTION

@Deprecated
public static final int INSERT_ELEMENT_AFTER_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

REMOVE_ELEMENT_ACTION

@Deprecated
public static final int REMOVE_ELEMENT_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

CONVERT_ELEMENT_ACTION

@Deprecated
public static final int CONVERT_ELEMENT_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

MOVE_ELEMENT_UP_ACTION

@Deprecated
public static final int MOVE_ELEMENT_UP_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

MOVE_ELEMENT_DOWN_ACTION

@Deprecated
public static final int MOVE_ELEMENT_DOWN_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

VALIDATE_XML_ACTION

@Deprecated
public static final int VALIDATE_XML_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

CURRENT_ELEMENT_UPDATE

public static final int CURRENT_ELEMENT_UPDATE
Updates the path to the current XML element.

See Also:
Constant Field Values

SELECT_NODE_ACTION

public static final int SELECT_NODE_ACTION
Selects the element passed in as the extra object.

See Also:
Constant Field Values

INSERT_ELEMENT_ACTION

@Deprecated
public static final int INSERT_ELEMENT_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

XML_CHANGED_UPDATE

@Deprecated
public static final int XML_CHANGED_UPDATE
Deprecated. No longer used.
See Also:
Constant Field Values

JOIN_ELEMENTS_ACTION

@Deprecated
public static final int JOIN_ELEMENTS_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

SHOW_TAGS_ACTION

@Deprecated
public static final int SHOW_TAGS_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

XML_ERROR_UPDATE

@Deprecated
public static final int XML_ERROR_UPDATE
Deprecated. No longer used.
See Also:
Constant Field Values

XML_CLEAR_ERRORS

@Deprecated
public static final int XML_CLEAR_ERRORS
Deprecated. No longer used.
See Also:
Constant Field Values

FLUSH_ENTITY_CACHE_ACTION

@Deprecated
public static final int FLUSH_ENTITY_CACHE_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

IN_XHTML_UPDATE

@Deprecated
public static final int IN_XHTML_UPDATE
Deprecated. No longer used.
See Also:
Constant Field Values

NOT_IN_XHTML_UPDATE

@Deprecated
public static final int NOT_IN_XHTML_UPDATE
Deprecated. No longer used.
See Also:
Constant Field Values

DESELECT_NODES_ACTION

@Deprecated
public static final int DESELECT_NODES_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

SET_XSLT

@Deprecated
public static final int SET_XSLT
Deprecated. No longer used.
See Also:
Constant Field Values

SHOW_ATTRIBUTE_PANE_ACTION

@Deprecated
public static final int SHOW_ATTRIBUTE_PANE_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

SHOW_TREE_VIEW_ACTION

@Deprecated
public static final int SHOW_TREE_VIEW_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

SHOW_DOCUMENT_NAVIGATOR_ACTION

public static final int SHOW_DOCUMENT_NAVIGATOR_ACTION
Shows or hides the document navigator. The extra string should be either "true" or "false".

See Also:
Constant Field Values

SHOW_VALIDATION_PANE_ACTION

@Deprecated
public static final int SHOW_VALIDATION_PANE_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

TARGET_VIEW_CHANGE

@Deprecated
public static final int TARGET_VIEW_CHANGE
Deprecated. No longer used.
See Also:
Constant Field Values

ADD_ATTRIBUTE_ACTION

@Deprecated
public static final int ADD_ATTRIBUTE_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

XML_VALIDATION_FINISHED

@Deprecated
public static final int XML_VALIDATION_FINISHED
Deprecated. No longer used.
See Also:
Constant Field Values

PREVIEW_IN_BROWSER_ACTION

@Deprecated
public static final int PREVIEW_IN_BROWSER_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

LOADING_COMPLETE

public static final int LOADING_COMPLETE
The notification that the editor has completely finished loading.

See Also:
Constant Field Values

REFORMAT

public static final int REFORMAT
Reformats the text in source view.

See Also:
Constant Field Values

UNDO_ADDED

public static final int UNDO_ADDED
The event that is broadcasted when an undo event has been added to the undo/redo manager.

See Also:
Constant Field Values

XML_FOCUS_ELEMENT

@Deprecated
public static final int XML_FOCUS_ELEMENT
Deprecated. No longer used.
See Also:
Constant Field Values

DISABLE_UNDO

public static final int DISABLE_UNDO
Temporarily disables undo events being added when manipulating the document directly. Firing other events may cause undo events to be reenabled or may ignore this setting and add undo's. While undo events are disabled, changes made directly on the HTMLDocument or via the JTextPane will not be added.

See Also:
Constant Field Values

ENABLE_UNDO

public static final int ENABLE_UNDO
Reenables undo events.

See Also:
Constant Field Values

LINK_CLICKED

public static final int LINK_CLICKED
Fired when the user clicks on a link that is not editable. The extra string is the HREF of the url they clicked, the source object is the firing mouse event except in the case of MathML related text events.

See Also:
Constant Field Values

INSERT_COMMENT

public static final int INSERT_COMMENT
Inserts an HTML comment.

See Also:
Constant Field Values

GET_XML_NODE_VALUE

@Deprecated
public static final int GET_XML_NODE_VALUE
Deprecated. No longer used.
See Also:
Constant Field Values

DOUBLE_CLICK_ACTION

public static final int DOUBLE_CLICK_ACTION
Fired when the user double clicks in the HTMLPane.

See Also:
Constant Field Values

PARAGRAPH_MARKER_ACTION

public static final int PARAGRAPH_MARKER_ACTION
Toggles the paragraph marker on and off.

See Also:
Constant Field Values

PARAGRAPH_MARKER_UPDATE_ON

public static final int PARAGRAPH_MARKER_UPDATE_ON
Notification that the paragraph marker is on.

See Also:
Constant Field Values

PARAGRAPH_MARKER_UPDATE_OFF

public static final int PARAGRAPH_MARKER_UPDATE_OFF
Notification that the paragraph marker is off.

See Also:
Constant Field Values

INSERT_TABLE_WIZARD_ACTION

public static final int INSERT_TABLE_WIZARD_ACTION
Insert a table with a specified number of rows and columns. No dialog is shown to the user. The number of rows and columns should be specified using a Dimension as the extra object.

See Also:
Constant Field Values

REMOVE_HYPERLINK_ACTION

public static final int REMOVE_HYPERLINK_ACTION
Removes the hyperlink from the current selection.

See Also:
Constant Field Values

BACKGROUND_SPELL_CHECKING

public static final int BACKGROUND_SPELL_CHECKING
Sets the state of Background Spell Checking via a true/false string as the extra object. If the extra object is null, background checking will be toggled.

See Also:
Constant Field Values

HR_PROPERTIES_ACTION

public static final int HR_PROPERTIES_ACTION
Display the HR properties dialog.

See Also:
Constant Field Values

INSERT_OBJECT_ACTION

public static final int INSERT_OBJECT_ACTION
Show the insert object dialog to allow the user to insert an object tag.

See Also:
Constant Field Values

OBJECT_PROPERTIES_ACTION

public static final int OBJECT_PROPERTIES_ACTION
Show the object properties dialog.

See Also:
Constant Field Values

IS_HR_UPDATE

public static final int IS_HR_UPDATE
Indicates that the selection is a HR.

See Also:
Constant Field Values

NOT_HR_UPDATE

public static final int NOT_HR_UPDATE
Indicates that the selection is not a HR.

See Also:
Constant Field Values

IS_OBJECT_UPDATE

public static final int IS_OBJECT_UPDATE
Indicates that the selection is an object.

See Also:
Constant Field Values

NOT_OBJECT_UPDATE

public static final int NOT_OBJECT_UPDATE
Indicates that the selection is not an object.

See Also:
Constant Field Values

FORMAT_PAINTER_ACTION

public static final int FORMAT_PAINTER_ACTION
Activates the format painter function.

See Also:
Constant Field Values

PASTE_SPECIAL_ACTION

public static final int PASTE_SPECIAL_ACTION
Pastes the contents of the clipboard using the selected method from the Paste Special dialog.

See Also:
Constant Field Values

SPELLING_FINISHED

public static final int SPELLING_FINISHED
Fired when the spelling dialog is closed.

See Also:
Constant Field Values

FORMAT_PAINTER_OFF

public static final int FORMAT_PAINTER_OFF
Turns off the format painter button indicating that no format is ready to be painted anymore.

See Also:
Constant Field Values

FORMAT_PAINTER_ON

public static final int FORMAT_PAINTER_ON
Turns on the format painter button indicating that a format is ready to be painted.

See Also:
Constant Field Values

IS_MATHML_UPDATE

public static final int IS_MATHML_UPDATE
Indicates that the selection is a MathML element.

See Also:
Constant Field Values

NOT_MATHML_UPDATE

public static final int NOT_MATHML_UPDATE
Indicates that the selection is not a MathML element.

See Also:
Constant Field Values

FONT_COLOR_UPDATE

public static final int FONT_COLOR_UPDATE
Updates the currently selected font color.

See Also:
Constant Field Values

HIGHLIGHT_COLOR_UPDATE

public static final int HIGHLIGHT_COLOR_UPDATE
Updates the currently selected font color.

See Also:
Constant Field Values

REINITIALIZE

public static final int REINITIALIZE
Reinitializes the bean. Only effective if the configuration was set using a DOM and the DOM has been updated.

See Also:
Constant Field Values

INSERT_DATE_TIME_ACTION

public static final int INSERT_DATE_TIME_ACTION
Opens the Insert Date and Time dialog.

See Also:
Constant Field Values

PRINT_ACTION

public static final int PRINT_ACTION
Prints the current editor contents in a new browser window. The extra object for this event will be either EditorMode.DESIGN or EditorMode.CODE depending on the current editor mode.

See Also:
Constant Field Values

IN_FORM

public static final int IN_FORM
Notification that the caret is within a form.

See Also:
Constant Field Values

NOT_IN_FORM

public static final int NOT_IN_FORM
Notification that the caret is not within a form.

See Also:
Constant Field Values

IN_FORM_FIELD

public static final int IN_FORM_FIELD
Notification that the caret is within a form field.

See Also:
Constant Field Values

NOT_IN_FORM_FIELD

public static final int NOT_IN_FORM_FIELD
Notification that the caret is not within a form field.

See Also:
Constant Field Values

FORM_PROPERTIES_ACTION

public static final int FORM_PROPERTIES_ACTION
Notification that the caret is not within a form field.

See Also:
Constant Field Values

FORM_FIELD_PROPERTIES_ACTION

public static final int FORM_FIELD_PROPERTIES_ACTION
Notification that the caret is not within a form field.

See Also:
Constant Field Values

MENUBAR_CREATED

public static final int MENUBAR_CREATED
Indicates that the menu bar has finished loading

See Also:
Constant Field Values

TOOLBAR_CREATED

public static final int TOOLBAR_CREATED
Indicates that the toolbar has finished loading

See Also:
Constant Field Values

INSERT_FORM_ACTION

public static final int INSERT_FORM_ACTION
Inserts a new FORM element if the caret is not currently positioned within an existing FORM

See Also:
Constant Field Values

INSERT_TEXT_FIELD_ACTION

public static final int INSERT_TEXT_FIELD_ACTION
Inserts a new TEXT INPUT element

See Also:
Constant Field Values

INSERT_PASSWORD_FIELD_ACTION

public static final int INSERT_PASSWORD_FIELD_ACTION
Inserts a new PASSWORD INPUT element

See Also:
Constant Field Values

INSERT_HIDDEN_FIELD_ACTION

public static final int INSERT_HIDDEN_FIELD_ACTION
Inserts a new HIDDEN INPUT element

See Also:
Constant Field Values

INSERT_FILE_FIELD_ACTION

public static final int INSERT_FILE_FIELD_ACTION
Inserts a new FILE INPUT element

See Also:
Constant Field Values

INSERT_BUTTON_FIELD_ACTION

public static final int INSERT_BUTTON_FIELD_ACTION
Inserts a new BUTTON INPUT element

See Also:
Constant Field Values

INSERT_SUBMIT_FIELD_ACTION

public static final int INSERT_SUBMIT_FIELD_ACTION
Inserts a new SUBMIT INPUT element

See Also:
Constant Field Values

INSERT_RESET_FIELD_ACTION

public static final int INSERT_RESET_FIELD_ACTION
Inserts a new RESET INPUT element

See Also:
Constant Field Values

INSERT_CHECKBOX_FIELD_ACTION

public static final int INSERT_CHECKBOX_FIELD_ACTION
Inserts a new CHECKBOX INPUT element

See Also:
Constant Field Values

INSERT_RADIO_FIELD_ACTION

public static final int INSERT_RADIO_FIELD_ACTION
Inserts a new RADIO INPUT element

See Also:
Constant Field Values

INSERT_TEXTAREA_FIELD_ACTION

public static final int INSERT_TEXTAREA_FIELD_ACTION
Inserts a new TEXTAREA INPUT element

See Also:
Constant Field Values

INSERT_SELECT_FIELD_ACTION

public static final int INSERT_SELECT_FIELD_ACTION
Inserts a new SELECT INPUT element

See Also:
Constant Field Values

INSERT_IMAGE_FIELD_ACTION

public static final int INSERT_IMAGE_FIELD_ACTION
Inserts a new IMAGE INPUT element

See Also:
Constant Field Values

DISPLAY_ACCESSIBILITY_REPORT_ACTION

public static final int DISPLAY_ACCESSIBILITY_REPORT_ACTION
Display the accessibility report dialog. NOTE: this action now requires the Accessibility Plugin

See Also:
Constant Field Values

SET_CARET_POSITION

public static final int SET_CARET_POSITION
Scroll the design view to the specified position. The extra object must be a Position instance, created from the current document to scroll to.

See Also:
Constant Field Values

SUP_ACTION

public static final int SUP_ACTION
Sup the currently selected text.

See Also:
Constant Field Values

SUB_ACTION

public static final int SUB_ACTION
Sub the currently selected text.

See Also:
Constant Field Values

SCRIPT_UPDATE_SUP_OFF

public static final int SCRIPT_UPDATE_SUP_OFF
Toggles the sup button off.

See Also:
Constant Field Values

SCRIPT_UPDATE_SUP_ON

public static final int SCRIPT_UPDATE_SUP_ON
Toggles sup button on.

See Also:
Constant Field Values

SCRIPT_UPDATE_SUB_ON

public static final int SCRIPT_UPDATE_SUB_ON
Toggles sub button on

See Also:
Constant Field Values

SCRIPT_UPDATE_SUB_OFF

public static final int SCRIPT_UPDATE_SUB_OFF
Toggles the sub button off.

See Also:
Constant Field Values

STORE_XHTML_ACTION

@Deprecated
public static final int STORE_XHTML_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

SYNC_XHTML_ACTION

@Deprecated
public static final int SYNC_XHTML_ACTION
Deprecated. No longer used.
See Also:
Constant Field Values

RELOAD_XHTML_BLOCK

@Deprecated
public static final int RELOAD_XHTML_BLOCK
Deprecated. No longer used.
See Also:
Constant Field Values

IN_EDITABLE_CONTENT_UPDATE

public static final int IN_EDITABLE_CONTENT_UPDATE
Indicates that the caret is positioned within editable content.

See Also:
Constant Field Values

NOT_IN_EDITABLE_CONTENT_UPDATE

public static final int NOT_IN_EDITABLE_CONTENT_UPDATE
Indicates that the caret is positioned within uneditable content.

See Also:
Constant Field Values

TABLE_AUTOFIT

public static final int TABLE_AUTOFIT
Automatically sizes columns in the current table

See Also:
Constant Field Values

THESAURUS_DIALOG_ACTION

public static final int THESAURUS_DIALOG_ACTION
Shows the Thesaurus Dialog.

See Also:
Constant Field Values

REPLACE_WORD_ACTION

public static final int REPLACE_WORD_ACTION
Replaces the current word in the HTMLPane with the extra string of the event.

See Also:
Constant Field Values

REMOVE_BOOKMARK_ACTION

public static final int REMOVE_BOOKMARK_ACTION
Removes the bookmark at the cursor

See Also:
Constant Field Values

ENABLE_TRACK_CHANGES_ACTION

public static final int ENABLE_TRACK_CHANGES_ACTION
Enable track changes on the document. After this action is fired any change made to the document will be tracked and submitted with the document. Changes will be visualized within the editor so that users can see what changes have been made. Any previously tracked changes will be redisplayed.

See Also:
Constant Field Values

DISABLE_TRACK_CHANGES_ACTION

public static final int DISABLE_TRACK_CHANGES_ACTION
Disable track changes on the document. After this action is fired, changes to the document will not be tracked. No change markup will be removed, however existing change information for changes that occurred while track changes was enable will be preserved and will still be submitted with the document.

See Also:
Constant Field Values

IN_CHANGE_UPDATE

public static final int IN_CHANGE_UPDATE
Notification that the current caret position is within an unaccepted change to the document. The extra string and extra int values are unused.

See Also:
Constant Field Values

NOT_IN_CHANGE_UPDATE

public static final int NOT_IN_CHANGE_UPDATE
Notification that the current caret position is not within an unaccepted change to the document. The extra string and extra int values are unused.

See Also:
Constant Field Values

ACCEPT_CHANGE_ACTION

public static final int ACCEPT_CHANGE_ACTION
Accept the first change in the current selection. The effects of the change is permanently applied to the document and the accepted change is no longer included in the list of changes to the document. The extra string and extra int values are unused.

See Also:
Constant Field Values

REJECT_CHANGE_ACTION

public static final int REJECT_CHANGE_ACTION
Reject the first change in the current selection. The effects of the change is permanently unapplied to the document and the accepted change is no longer included in the list of changes to the document. The extra string and extra int values are unused.

See Also:
Constant Field Values

SHOW_TRACK_CHANGES_DIALOG

public static final int SHOW_TRACK_CHANGES_DIALOG
Show the track changes dialog.

See Also:
Constant Field Values

SET_USERNAME

public static final int SET_USERNAME
Set the user name for the current user. The username to set is specified as the extra string parameter.

See Also:
Constant Field Values

SELECT_OPERATION_ACTION

public static final int SELECT_OPERATION_ACTION
Select the range affected by a track changes operation. The operation must be provided as the extra object for the event. The extra int for the event is not used.

See Also:
Constant Field Values

NEXT_OPERATION_ACTION

public static final int NEXT_OPERATION_ACTION
Select the next unaccepted change after the current caret position. The extra object and extra int are not used.

See Also:
Constant Field Values

PREVIOUS_OPERATION_ACTION

public static final int PREVIOUS_OPERATION_ACTION
Select the first unaccepted change before the current caret position. The extra object and extra int are not used.

See Also:
Constant Field Values

IWWCM_IMAGE_DIALOG

public static final int IWWCM_IMAGE_DIALOG
Calls to JavaScript to launch the IWWCM 6.0 Insert Image Dialog

See Also:
Constant Field Values

IWWCM_HYPERLINK_DIALOG

public static final int IWWCM_HYPERLINK_DIALOG
Calls to JavaScript to launch the IWWCM 6.0 Insert Hyperlink Dialog

See Also:
Constant Field Values

IMPORT_WORD_DOCUMENT

public static final int IMPORT_WORD_DOCUMENT
Import a word document from the filesystem

See Also:
Constant Field Values

ACCEPT_ALL_CHANGES_ACTION

public static final int ACCEPT_ALL_CHANGES_ACTION
Accept all changes in the document. The extra string and extra int values are unused.

See Also:
Constant Field Values

ENABLE_CHANGE_RENDERING_ACTION

@Deprecated
public static final int ENABLE_CHANGE_RENDERING_ACTION
Deprecated. no longer supported
See Also:
Constant Field Values

DISABLE_CHANGE_RENDERING_ACTION

@Deprecated
public static final int DISABLE_CHANGE_RENDERING_ACTION
Deprecated. no longer supported
See Also:
Constant Field Values

REJECT_ALL_CHANGES_ACTION

public static final int REJECT_ALL_CHANGES_ACTION
Accept all changes in the document. The extra string and extra int values are unused.

See Also:
Constant Field Values

HAVE_CHANGES_UPDATE

public static final int HAVE_CHANGES_UPDATE
Notification that operations now exist in the document. The extra string and extra int values are unused.

See Also:
Constant Field Values

NO_CHANGES_UPDATE

public static final int NO_CHANGES_UPDATE
Notification that there are no operations in the document. The extra string and extra int values are unused.

See Also:
Constant Field Values

EDITOR_INITIALIZED

public static final int EDITOR_INITIALIZED
The notification that the editor has been initialized but the content is not necessarily loaded.

See Also:
Constant Field Values

IWWCM_DOMINO_IMAGE

public static final int IWWCM_DOMINO_IMAGE
See Also:
Constant Field Values

IWWCM_DOMINO_HYPERLINK

public static final int IWWCM_DOMINO_HYPERLINK
See Also:
Constant Field Values

IWWCM_DOMINO_FILE

public static final int IWWCM_DOMINO_FILE
See Also:
Constant Field Values

LOG_CURRENT_STATE

public static final int LOG_CURRENT_STATE
Causes the editor to log its current state. Useful for debugging.

See Also:
Constant Field Values

DIRTY_CHANGED

public static final int DIRTY_CHANGED
Used to notify bean listeners that the dirty state of the editor has changed. The extra object contains a Boolean indicating the new state.

See Also:
Constant Field Values

IN_DIV_UPDATE

public static final int IN_DIV_UPDATE
Indicates that the caret has been placed inside a div or that only a div is selected.

See Also:
Constant Field Values

NOT_IN_DIV_UPDATE

public static final int NOT_IN_DIV_UPDATE
Indicates that the caret is no longer inside a div.

See Also:
Constant Field Values

SECTION_PROPERTIES_ACTION

public static final int SECTION_PROPERTIES_ACTION
Displays the Section properties dialog.

See Also:
Constant Field Values

CREATE_SECTION_ACTION

public static final int CREATE_SECTION_ACTION
Creates a Section from the selected text (if there is any)

See Also:
Constant Field Values

REMOVE_SECTION_ACTION

public static final int REMOVE_SECTION_ACTION
Removes the Section at the cursor location

See Also:
Constant Field Values

QUICKR_IMAGE_DIALOG

public static final int QUICKR_IMAGE_DIALOG
Calls to JavaScript to launch the Quickr Insert Image Dialog

See Also:
Constant Field Values

QUICKR_HYPERLINK_DIALOG

public static final int QUICKR_HYPERLINK_DIALOG
Calls to JavaScript to launch the Quickr Insert Hyperlink Dialog

See Also:
Constant Field Values

AUTO_CORRECT

public static final int AUTO_CORRECT
Sets the state of Auto Correct via a true/false string as the extra object. Note that this feature is only available in the Enterprise Edition.

See Also:
Constant Field Values

QUICKR_LOCAL_DOCUMENT_PICKER

public static final int QUICKR_LOCAL_DOCUMENT_PICKER
Calls to JavaScript to launch the Quickr local document picker

See Also:
Constant Field Values

QUICKR_EXTERNAL_HYPERLINK_DIALOG

public static final int QUICKR_EXTERNAL_HYPERLINK_DIALOG
Calls to JavaScript to launch the Quickr external hyperlink dialog

See Also:
Constant Field Values

QUICKR_REMOTE_DOCUMENT_PICKER

public static final int QUICKR_REMOTE_DOCUMENT_PICKER
Calls to JavaScript to launch the Quickr remote document picker

See Also:
Constant Field Values

UPDATE_STATE

public static final int UPDATE_STATE
Updates the enabled state of the toolbar buttons and menu items of the editor. Useful to call after the document is changed via Advanced API.

See Also:
Constant Field Values

CALL_JAVASCRIPT

public static final int CALL_JAVASCRIPT
Calls a javascript function from the applet. Expects a JSFunctionCall object as its extraObject. Custom implementations may want to handle this if you are using your own applet.

See Also:
Constant Field Values

TRANSFER_FOCUS

public static final int TRANSFER_FOCUS
Tells the applet to transfer input focus out of the editor. If the extraObject is Boolean.TRUE or "forwards", focus is transferred to the next focusable element on the page. If the extraObject is Boolean.FALSE or "backwards", focus is transferred to the previous focusable element on the page. In both cases, elements are considered in order of DOM structure and not the order of tabIndex.

See Also:
Constant Field Values

SOURCE_RETRIEVED

public static final int SOURCE_RETRIEVED
A notification that the current contents of the editor are about to be retrieved, usually during the save process

See Also:
Constant Field Values

FOCUS_MENUBAR

public static final int FOCUS_MENUBAR
Sets the focus to the menubar

See Also:
Constant Field Values

IMAGE_LOADED

public static final int IMAGE_LOADED
Fires when an image is first loaded or something causes it to be resized

See Also:
Constant Field Values

DISABLE_IMAGE_RESAMPLING

public static final int DISABLE_IMAGE_RESAMPLING
Stops the editor from resampling images when retrieving the HTML source

See Also:
Constant Field Values

ENABLE_IMAGE_RESAMPLING

public static final int ENABLE_IMAGE_RESAMPLING
Enables editor resampling images when retrieving the HTML source

See Also:
Constant Field Values

IMAGE_RESIZED

public static final int IMAGE_RESIZED
Indicates that an image has just been resized. The image Element object is passed through as the extra object.

See Also:
Constant Field Values

BIDI_ACTION

public static final int BIDI_ACTION
Causes the text to be switched between left-to-right and right-to-left

See Also:
Constant Field Values

DELETE_TABLE_ACTION

public static final int DELETE_TABLE_ACTION
Deletes the table the cursor is in

See Also:
Constant Field Values

SET_TEXT_LTR

public static final int SET_TEXT_LTR
Toggles the currently selected block elements for LTR

See Also:
Constant Field Values

SET_TEXT_RTL

public static final int SET_TEXT_RTL
Toggles the currently selected block elements for RTL

See Also:
Constant Field Values

TEXT_DIRECTION_UPDATE

public static final int TEXT_DIRECTION_UPDATE
Notification that the current block element is LTR, RTL or none. Uses ComponentOrientation.

See Also:
Constant Field Values
Constructor Detail

TextEvent

public TextEvent(Object source,
                 int action,
                 Object extraS,
                 int extraI)
Creates a new TextEvent.

Parameters:
source - Source object of the action.
action - The action that occurred.
extraS - Extra information that can be passed as a string, or null if not used.
extraI - Extra information that can be passed as an integer, or -1 if not used.
Method Detail

getActionCommand

public int getActionCommand()
Returns the action ID.


getExtraString

public String getExtraString()
Returns the extra object information as a String, or null if it is not an instance of String.


getExtraObject

public Object getExtraObject()
Returns the extra object.


getExtraInt

public int getExtraInt()
Returns the extra int.


isHandled

public boolean isHandled()
Returns true if the event has been handled.

See Also:
setHandled(boolean)

setHandled

public void setHandled(boolean b)
Sets whether or not this event has been handled. Once the event has been marked as handled it will not be broadcasted to any further bean listeners.

Parameters:
b - true if the event has been handled, otherwise false.
See Also:
isHandled()

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Returns a String representation of this TextEvent.

Overrides:
toString in class EventObject
Returns:
A a String representation of this TextEvent.

setExtraString

public void setExtraString(String string)

isRaiseEventAction

public boolean isRaiseEventAction(String raiseEventName)
Returns true if this is a Raise Event action that matches the string passed in


isRaiseEventAction

@Deprecated
public static boolean isRaiseEventAction(TextEvent event,
                                                    String raiseEventName)
Deprecated. use isRaiseEventAction(String) instead


Copyright (c) 2005-2012 Ephox Pty Ltd. All rights reserved.