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
-
Field Summary
Fields Modifier and Type Field Description protected RichTextEditor
editor
The rich text editor control, initiallynull
.protected RichTextEditorConfiguration
editorConfiguration
TheRichTextEditorConfiguration
that should be used for creating the inline rich text editor control. -
Constructor Summary
Constructors Constructor Description RichTextCellEditor(org.eclipse.swt.widgets.Composite parent)
Create a resizableRichTextCellEditor
with the defaultRichTextEditorConfiguration
.RichTextCellEditor(org.eclipse.swt.widgets.Composite parent, int style)
Create a resizableRichTextCellEditor
with the defaultRichTextEditorConfiguration
and the given style bits.RichTextCellEditor(org.eclipse.swt.widgets.Composite parent, RichTextEditorConfiguration editorConfiguration, int style)
Create a resizableRichTextCellEditor
with the givenRichTextEditorConfiguration
and the given style bits.RichTextCellEditor(org.eclipse.swt.widgets.Composite parent, ToolbarConfiguration toolbarConfiguration)
Deprecated.Use a constructor withRichTextEditorConfiguration
parameterRichTextCellEditor(org.eclipse.swt.widgets.Composite parent, ToolbarConfiguration toolbarConfiguration, int style)
Deprecated.Use a constructor withRichTextEditorConfiguration
parameter -
Method Summary
Modifier and Type Method 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 createdRichTextEditor
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
-
Field Details
-
editor
The rich text editor control, initiallynull
. -
editorConfiguration
TheRichTextEditorConfiguration
that should be used for creating the inline rich text editor control. Ifnull
the defaultRichTextEditorConfiguration
will be used.
-
-
Constructor Details
-
RichTextCellEditor
public RichTextCellEditor(org.eclipse.swt.widgets.Composite parent)Create a resizableRichTextCellEditor
with the defaultRichTextEditorConfiguration
.- Parameters:
parent
- The parent composite.
-
RichTextCellEditor
@Deprecated public RichTextCellEditor(org.eclipse.swt.widgets.Composite parent, ToolbarConfiguration toolbarConfiguration)Deprecated.Use a constructor withRichTextEditorConfiguration
parameterCreate a resizableRichTextCellEditor
with the givenToolbarConfiguration
.- Parameters:
parent
- The parent composite.toolbarConfiguration
- TheToolbarConfiguration
that should be used for creating theRichTextEditor
.
-
RichTextCellEditor
public RichTextCellEditor(org.eclipse.swt.widgets.Composite parent, int style)Create a resizableRichTextCellEditor
with the defaultRichTextEditorConfiguration
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 withRichTextEditorConfiguration
parameterCreate a resizableRichTextCellEditor
with the givenToolbarConfiguration
and the given style bits.- Parameters:
parent
- The parent composite.toolbarConfiguration
- TheToolbarConfiguration
that should be used for creating theRichTextEditor
.style
- The style bits to use.
-
RichTextCellEditor
public RichTextCellEditor(org.eclipse.swt.widgets.Composite parent, RichTextEditorConfiguration editorConfiguration, int style)Create a resizableRichTextCellEditor
with the givenRichTextEditorConfiguration
and the given style bits.- Parameters:
parent
- The parent composite.editorConfiguration
- TheRichTextEditorConfiguration
that should be used for creating theRichTextEditor
.style
- The style bits to use.
-
-
Method Details
-
create
public void create(org.eclipse.swt.widgets.Composite parent)- Overrides:
create
in classorg.eclipse.jface.viewers.CellEditor
-
createControl
protected org.eclipse.swt.widgets.Control createControl(org.eclipse.swt.widgets.Composite parent)- Specified by:
createControl
in classorg.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 classorg.eclipse.jface.viewers.CellEditor
-
doSetFocus
protected void doSetFocus()- Specified by:
doSetFocus
in classorg.eclipse.jface.viewers.CellEditor
-
doSetValue
protected void doSetValue(java.lang.Object value)- Specified by:
doSetValue
in classorg.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 viafireEditorValueChanged
. 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 classorg.eclipse.jface.viewers.CellEditor
-
getRichTextEditor
Return the createdRichTextEditor
control.- Returns:
- The
RichTextEditor
control, ornull
if this cell editor has no control.
-