org.eclipse.nebula.widgets.richtext

Class RichTextCellEditor

java.lang.Object

org.eclipse.jface.viewers.CellEditor

org.eclipse.nebula.widgets.richtext.RichTextCellEditor

public class RichTextCellEditor
extends org.eclipse.jface.viewers.CellEditor

A cell editor that manages HTML entry fields. It uses the RichTextEditor as editing control.

It creates the RichTextEditor instance always using the style bit SWT.EMBEDDED to ensure the editor is opened with a minimum size. Otherwise the editing framework will set the bounds to the size of the current cell, which makes the editor unusable.

Additionally it supports the style bit SWT.RESIZE which is set by default if no specialized style is set. This enables resizing support of the embedded inline RichTextEditor. By additionally specifying the SWT.MIN style bit, it is not possible for a user to resize the editor below the specified minimum size via

As the RichTextEditor uses a Browser internally, it is also possible to specify the browser type via style bit.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jface.viewers.CellEditor

org.eclipse.jface.viewers.CellEditor.LayoutData

Field Summary

Fields

Modifier and Type	Field and Description
protected RichTextEditor	editor The rich text editor control, initially null.
protected RichTextEditorConfiguration	editorConfiguration The RichTextEditorConfiguration that should be used for creating the inline rich text editor control.

Fields inherited from class org.eclipse.jface.viewers.CellEditor

COPY, CUT, DELETE, FIND, PASTE, REDO, SELECT_ALL, UNDO

Constructor Summary

Constructors

Constructor and Description
RichTextCellEditor(org.eclipse.swt.widgets.Composite parent) Create a resizable RichTextCellEditor with the default RichTextEditorConfiguration.
RichTextCellEditor(org.eclipse.swt.widgets.Composite parent, int style) Create a resizable RichTextCellEditor with the default RichTextEditorConfiguration and the given style bits.
RichTextCellEditor(org.eclipse.swt.widgets.Composite parent, RichTextEditorConfiguration editorConfiguration, int style) Create a resizable RichTextCellEditor with the given RichTextEditorConfiguration and the given style bits.
RichTextCellEditor(org.eclipse.swt.widgets.Composite parent, ToolbarConfiguration toolbarConfiguration) Deprecated. Use a constructor with RichTextEditorConfiguration parameter
RichTextCellEditor(org.eclipse.swt.widgets.Composite parent, ToolbarConfiguration toolbarConfiguration, int style) Deprecated. Use a constructor with RichTextEditorConfiguration parameter

Method Summary

Modifier and Type	Method and Description
void	create(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.swt.widgets.Control	createControl(org.eclipse.swt.widgets.Composite parent)
protected java.lang.Object	doGetValue()
protected void	doSetFocus()
protected void	doSetValue(java.lang.Object value)
protected void	editOccured(org.eclipse.swt.events.ModifyEvent e) Processes a modify event that occurred in this rich text cell editor.
protected void	focusLost()
protected org.eclipse.swt.graphics.Point	getMinimumDimension()
RichTextEditor	getRichTextEditor() Return the created RichTextEditor control.

Methods inherited from class org.eclipse.jface.viewers.CellEditor

activate, activate, addListener, addPropertyChangeListener, deactivate, deactivate, dependsOnExternalFocusListener, dispose, fireApplyEditorValue, fireCancelEditor, fireEditorValueChanged, fireEnablementChanged, getControl, getDoubleClickTimeout, getErrorMessage, getLayoutData, getStyle, getValidator, getValue, isActivated, isCopyEnabled, isCorrect, isCutEnabled, isDeleteEnabled, isDirty, isFindEnabled, isPasteEnabled, isRedoEnabled, isSelectAllEnabled, isUndoEnabled, isValueValid, keyReleaseOccured, markDirty, performCopy, performCut, performDelete, performFind, performPaste, performRedo, performSelectAll, performUndo, removeListener, removePropertyChangeListener, setErrorMessage, setFocus, setStyle, setValidator, setValue, setValueValid, valueChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

editor

protected RichTextEditor editor

The rich text editor control, initially null.

editorConfiguration

protected RichTextEditorConfiguration editorConfiguration

The RichTextEditorConfiguration that should be used for creating the inline rich text editor control. If null the default RichTextEditorConfiguration will be used.

Constructor Detail

RichTextCellEditor

public RichTextCellEditor(org.eclipse.swt.widgets.Composite parent)

Create a resizable RichTextCellEditor with the default RichTextEditorConfiguration.

Parameters:

parent - The parent composite.

RichTextCellEditor

@Deprecated
public RichTextCellEditor(org.eclipse.swt.widgets.Composite parent,
                                       ToolbarConfiguration toolbarConfiguration)

Deprecated. Use a constructor with RichTextEditorConfiguration parameter

Create a resizable RichTextCellEditor with the given ToolbarConfiguration.

Parameters:

parent - The parent composite.

toolbarConfiguration - The ToolbarConfiguration that should be used for creating the RichTextEditor.

RichTextCellEditor

public RichTextCellEditor(org.eclipse.swt.widgets.Composite parent,
                          int style)

Create a resizable RichTextCellEditor with the default RichTextEditorConfiguration and the given style bits.

Parameters:

parent - The parent composite.

style - The style bits to use.

RichTextCellEditor

@Deprecated
public RichTextCellEditor(org.eclipse.swt.widgets.Composite parent,
                                       ToolbarConfiguration toolbarConfiguration,
                                       int style)

Deprecated. Use a constructor with RichTextEditorConfiguration parameter

Create a resizable RichTextCellEditor with the given ToolbarConfiguration and the given style bits.

Parameters:

parent - The parent composite.

toolbarConfiguration - The ToolbarConfiguration that should be used for creating the RichTextEditor.

style - The style bits to use.

RichTextCellEditor

public RichTextCellEditor(org.eclipse.swt.widgets.Composite parent,
                          RichTextEditorConfiguration editorConfiguration,
                          int style)

Create a resizable RichTextCellEditor with the given RichTextEditorConfiguration and the given style bits.

Parameters:

parent - The parent composite.

editorConfiguration - The RichTextEditorConfiguration that should be used for creating the RichTextEditor.

style - The style bits to use.

Method Detail

create

public void create(org.eclipse.swt.widgets.Composite parent)

Overrides:

create in class org.eclipse.jface.viewers.CellEditor

createControl

protected org.eclipse.swt.widgets.Control createControl(org.eclipse.swt.widgets.Composite parent)

Specified by:

createControl in class org.eclipse.jface.viewers.CellEditor

getMinimumDimension

protected org.eclipse.swt.graphics.Point getMinimumDimension()

Returns:

The minimum dimension used for the rich text editor control.

doGetValue

protected java.lang.Object doGetValue()

Specified by:

doGetValue in class org.eclipse.jface.viewers.CellEditor

doSetFocus

protected void doSetFocus()

Specified by:

doSetFocus in class org.eclipse.jface.viewers.CellEditor

doSetValue

protected void doSetValue(java.lang.Object value)

Specified by:

doSetValue in class org.eclipse.jface.viewers.CellEditor

editOccured

protected void editOccured(org.eclipse.swt.events.ModifyEvent e)

Processes a modify event that occurred in this rich text cell editor. This framework method performs validation and sets the error message accordingly, and then reports a change via fireEditorValueChanged. Subclasses should call this method at appropriate times. Subclasses may extend or reimplement.

Parameters:

e - the SWT modify event

See Also:

TextCellEditor

focusLost

protected void focusLost()

Overrides:

focusLost in class org.eclipse.jface.viewers.CellEditor

getRichTextEditor

public RichTextEditor getRichTextEditor()

Return the created RichTextEditor control.

Returns:

The RichTextEditor control, or null if this cell editor has no control.