Class TTextCellEditor


  • public class TTextCellEditor
    extends org.eclipse.jface.viewers.CellEditor
    A cell editor that manages a text entry field. The cell editor's value is the text string itself.

    This class may be instantiated or subclassed.

    • 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 Description
      protected org.eclipse.swt.widgets.Text text
      The text control; initially null.
      • Fields inherited from class org.eclipse.jface.viewers.CellEditor

        COPY, CUT, DELETE, FIND, PASTE, REDO, SELECT_ALL, UNDO
    • Constructor Summary

      Constructors 
      Constructor Description
      TTextCellEditor​(int column, org.eclipse.swt.widgets.Composite parent)
      Creates a new text string cell editor parented under the given control.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected org.eclipse.swt.widgets.Control createControl​(org.eclipse.swt.widgets.Composite parent)  
      protected boolean dependsOnExternalFocusListener()
      This implementation of CellEditor.dependsOnExternalFocusListener() returns false if the current instance's class is TextCellEditor, and true otherwise.
      protected java.lang.Object doGetValue()
      The TextCellEditor implementation of this CellEditor framework method returns the text string.
      protected void doSetFocus()  
      protected void doSetValue​(java.lang.Object value)
      The TextCellEditor implementation of this CellEditor framework method accepts a text string (type String).
      protected void editOccured​(org.eclipse.swt.events.ModifyEvent e)
      Processes a modify event that occurred in this text cell editor.
      org.eclipse.jface.viewers.CellEditor.LayoutData getLayoutData()
      Since a text editor field is scrollable we don't set a minimumSize.
      protected void handleDefaultSelection​(org.eclipse.swt.events.SelectionEvent event)
      Handles a default selection event from the text control by applying the editor value and deactivating this cell editor.
      boolean isCopyEnabled()
      The TextCellEditor implementation of this CellEditor method returns true if the current selection is not empty.
      boolean isCutEnabled()
      The TextCellEditor implementation of this CellEditor method returns true if the current selection is not empty.
      boolean isDeleteEnabled()
      The TextCellEditor implementation of this CellEditor method returns true if there is a selection or if the caret is not positioned at the end of the text.
      boolean isPasteEnabled()
      The TextCellEditor implementation of this CellEditor method always returns true.
      boolean isSaveAllEnabled()
      Check if save all is enabled
      boolean isSelectAllEnabled()
      Returns true if this cell editor is able to perform the select all action.
      protected void keyReleaseOccured​(org.eclipse.swt.events.KeyEvent keyEvent)
      Processes a key release event that occurred in this cell editor.
      void performCopy()
      The TextCellEditor implementation of this CellEditor method copies the current selection to the clipboard.
      void performCut()
      The TextCellEditor implementation of this CellEditor method cuts the current selection to the clipboard.
      void performDelete()
      The TextCellEditor implementation of this CellEditor method deletes the current selection or, if there is no selection, the character next character from the current position.
      void performPaste()
      The TextCellEditor implementation of this CellEditor method pastes the the clipboard contents over the current selection.
      void performSelectAll()
      The TextCellEditor implementation of this CellEditor method selects all of the current text.
      • Methods inherited from class org.eclipse.jface.viewers.CellEditor

        activate, activate, addListener, addPropertyChangeListener, create, deactivate, deactivate, dispose, fireApplyEditorValue, fireCancelEditor, fireEditorValueChanged, fireEnablementChanged, focusLost, getControl, getDoubleClickTimeout, getErrorMessage, getStyle, getValidator, getValue, isActivated, isCorrect, isDirty, isFindEnabled, isRedoEnabled, isUndoEnabled, isValueValid, markDirty, performFind, performRedo, 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

      • text

        protected org.eclipse.swt.widgets.Text text
        The text control; initially null.
    • Constructor Detail

      • TTextCellEditor

        public TTextCellEditor​(int column,
                               org.eclipse.swt.widgets.Composite parent)
        Creates a new text string cell editor parented under the given control. The cell editor value is the string itself, which is initially the empty string. Initially, the cell editor has no cell validator.
        Parameters:
        parent - the parent control
    • Method Detail

      • createControl

        protected org.eclipse.swt.widgets.Control createControl​(org.eclipse.swt.widgets.Composite parent)
        Specified by:
        createControl in class org.eclipse.jface.viewers.CellEditor
      • doGetValue

        protected java.lang.Object doGetValue()
        The TextCellEditor implementation of this CellEditor framework method returns the text string.
        Specified by:
        doGetValue in class org.eclipse.jface.viewers.CellEditor
        Returns:
        the text string
      • doSetFocus

        protected void doSetFocus()
        Specified by:
        doSetFocus in class org.eclipse.jface.viewers.CellEditor
      • doSetValue

        protected void doSetValue​(java.lang.Object value)
        The TextCellEditor implementation of this CellEditor framework method accepts a text string (type String).
        Specified by:
        doSetValue in class org.eclipse.jface.viewers.CellEditor
        Parameters:
        value - a text string (type String)
      • editOccured

        protected void editOccured​(org.eclipse.swt.events.ModifyEvent e)
        Processes a modify event that occurred in this 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
      • getLayoutData

        public org.eclipse.jface.viewers.CellEditor.LayoutData getLayoutData()
        Since a text editor field is scrollable we don't set a minimumSize.
        Overrides:
        getLayoutData in class org.eclipse.jface.viewers.CellEditor
      • handleDefaultSelection

        protected void handleDefaultSelection​(org.eclipse.swt.events.SelectionEvent event)
        Handles a default selection event from the text control by applying the editor value and deactivating this cell editor.
        Parameters:
        event - the selection event
        Since:
        3.0
      • isCopyEnabled

        public boolean isCopyEnabled()
        The TextCellEditor implementation of this CellEditor method returns true if the current selection is not empty.
        Overrides:
        isCopyEnabled in class org.eclipse.jface.viewers.CellEditor
      • isCutEnabled

        public boolean isCutEnabled()
        The TextCellEditor implementation of this CellEditor method returns true if the current selection is not empty.
        Overrides:
        isCutEnabled in class org.eclipse.jface.viewers.CellEditor
      • isDeleteEnabled

        public boolean isDeleteEnabled()
        The TextCellEditor implementation of this CellEditor method returns true if there is a selection or if the caret is not positioned at the end of the text.
        Overrides:
        isDeleteEnabled in class org.eclipse.jface.viewers.CellEditor
      • isPasteEnabled

        public boolean isPasteEnabled()
        The TextCellEditor implementation of this CellEditor method always returns true.
        Overrides:
        isPasteEnabled in class org.eclipse.jface.viewers.CellEditor
      • isSaveAllEnabled

        public boolean isSaveAllEnabled()
        Check if save all is enabled
        Returns:
        true if it is
      • isSelectAllEnabled

        public boolean isSelectAllEnabled()
        Returns true if this cell editor is able to perform the select all action.

        This default implementation always returns false.

        Subclasses may override

        Overrides:
        isSelectAllEnabled in class org.eclipse.jface.viewers.CellEditor
        Returns:
        true if select all is possible, false otherwise
      • keyReleaseOccured

        protected void keyReleaseOccured​(org.eclipse.swt.events.KeyEvent keyEvent)
        Processes a key release event that occurred in this cell editor.

        The TextCellEditor implementation of this framework method ignores when the RETURN key is pressed since this is handled in handleDefaultSelection. An exception is made for Ctrl+Enter for multi-line texts, since a default selection event is not sent in this case.

        Overrides:
        keyReleaseOccured in class org.eclipse.jface.viewers.CellEditor
        Parameters:
        keyEvent - the key event
      • performCopy

        public void performCopy()
        The TextCellEditor implementation of this CellEditor method copies the current selection to the clipboard.
        Overrides:
        performCopy in class org.eclipse.jface.viewers.CellEditor
      • performCut

        public void performCut()
        The TextCellEditor implementation of this CellEditor method cuts the current selection to the clipboard.
        Overrides:
        performCut in class org.eclipse.jface.viewers.CellEditor
      • performDelete

        public void performDelete()
        The TextCellEditor implementation of this CellEditor method deletes the current selection or, if there is no selection, the character next character from the current position.
        Overrides:
        performDelete in class org.eclipse.jface.viewers.CellEditor
      • performPaste

        public void performPaste()
        The TextCellEditor implementation of this CellEditor method pastes the the clipboard contents over the current selection.
        Overrides:
        performPaste in class org.eclipse.jface.viewers.CellEditor
      • performSelectAll

        public void performSelectAll()
        The TextCellEditor implementation of this CellEditor method selects all of the current text.
        Overrides:
        performSelectAll in class org.eclipse.jface.viewers.CellEditor
      • dependsOnExternalFocusListener

        protected boolean dependsOnExternalFocusListener()
        This implementation of CellEditor.dependsOnExternalFocusListener() returns false if the current instance's class is TextCellEditor, and true otherwise. Subclasses that hook their own focus listener should override this method and return false. See also bug 58777.
        Overrides:
        dependsOnExternalFocusListener in class org.eclipse.jface.viewers.CellEditor
        Since:
        3.4