Package org.eclipse.nebula.widgets.nattable.extension.nebula.richtext

Class RichTextCellEditor

java.lang.Object
org.eclipse.nebula.widgets.nattable.edit.editor.AbstractCellEditor
org.eclipse.nebula.widgets.nattable.extension.nebula.richtext.RichTextCellEditor
All Implemented Interfaces:
ICellEditor
public class RichTextCellEditor extends AbstractCellEditor
NatTable ICellEditor implementation that makes use of the Nebula RichTextEditor.

  • Field Details

    • editor

      protected org.eclipse.nebula.widgets.richtext.RichTextEditor editor
      The rich text editor control, initially null.

    • editorConfiguration

      protected org.eclipse.nebula.widgets.richtext.RichTextEditorConfiguration editorConfiguration
      The RichTextEditorConfiguration that should be used for creating the inline rich text editor control. If null the default RichTextEditorConfiguration will be used.
      Since:
      1.1

    • style

      protected int style
      The style bits that are used to create the rich text editor control.

  • Constructor Details

    • RichTextCellEditor

      public RichTextCellEditor()
      Create a new resizable RichTextCellEditor with a default configuration.

    • RichTextCellEditor

      public RichTextCellEditor(org.eclipse.nebula.widgets.richtext.RichTextEditorConfiguration editorConfiguration)
      Create a new resizable RichTextCellEditor with the given configuration.
      Parameters:
      editorConfiguration - The RichTextEditorConfiguration that should be used for creating the RichTextEditor
      Since:
      1.1

    • RichTextCellEditor

      public RichTextCellEditor(int style)
      Create a new RichTextCellEditor with a default configuration and the given style bits.
      Parameters:
      style - The style bits that should be used to create the rich text editor control.

    • RichTextCellEditor

      public RichTextCellEditor(org.eclipse.nebula.widgets.richtext.RichTextEditorConfiguration editorConfiguration, int style)
      Create a new RichTextCellEditor with the given configuration and the given style bits.
      Parameters:
      editorConfiguration - The RichTextEditorConfiguration that should be used for creating the RichTextEditor
      style - The style bits that should be used to create the rich text editor control.
      Since:
      1.1

  • Method Details

    • getEditorValue

      public Object getEditorValue()
      Description copied from interface: ICellEditor
      Returns the current value in this editor prior to conversion. For a text editor that is used to edit integer values, this would mean it returns the text value instead of the converted integer value. This method is only intended to be used internally .
      Returns:
      The current value in this editor prior to conversion.

    • setEditorValue

      public void setEditorValue(Object value)
      Description copied from interface: ICellEditor
      Sets the given value to editor control. This method is used to put the display values to the wrapped editor.
      Parameters:
      value - The display value to set to the wrapped editor control.

    • getEditorControl

      public org.eclipse.nebula.widgets.richtext.RichTextEditor getEditorControl()
      Returns:
      The editor control that is wrapped by this ICellEditor.
      Since:
      1.1

    • activateCell

      protected org.eclipse.swt.widgets.Control activateCell(org.eclipse.swt.widgets.Composite parent, Object originalCanonicalValue)
      Description copied from class: AbstractCellEditor
      This method will be called by AbstractCellEditor.activateCell(Composite, Object, EditModeEnum, ICellEditHandler, ILayerCell, IConfigRegistry) after initializing the activation values and before adding the default listeners. In this method the underlying editor control should be created and initialized, hiding default configuration from editor implementors.
      Specified by:
      activateCell in class AbstractCellEditor
      Parameters:
      parent - The parent Composite, needed for the creation of the editor control.
      originalCanonicalValue - The value that should be put to the activated editor control.
      Returns:
      The SWT Control to be used for capturing the new cell value.

    • createEditorControl

      public org.eclipse.nebula.widgets.richtext.RichTextEditor createEditorControl(org.eclipse.swt.widgets.Composite parent)
      Description copied from interface: ICellEditor
      Creates the editor control that is wrapped by this ICellEditor. Will use the style configurations in ConfigRegistry for styling the control.
      Parameters:
      parent - The Composite that will be the parent of the new editor control. Can not be null
      Returns:
      The created editor control that is wrapped by this ICellEditor.

    • createRichTextEditor

      protected org.eclipse.nebula.widgets.richtext.RichTextEditor createRichTextEditor(org.eclipse.swt.widgets.Composite parent)
      Parameters:
      parent - the parent used to create the RichTextEditor wrapped by this RichtextCellEditor.
      Returns:
      the created RichTextEditor

    • getMinimumDimension

      protected org.eclipse.swt.graphics.Point getMinimumDimension()
      Returns:
      The minimum dimension used for the rich text editor control.