Package org.eclipse.jface.viewers

Class CheckboxCellEditor

  • public class CheckboxCellEditor
extends CellEditor
    A cell editor that manages a checkbox. The cell editor's value is a boolean.

    This class may be instantiated; it is not intended to be subclassed.

    Note that this implementation simply fakes it and does does not create any new controls. The mere activation of this editor means that the value of the check box is being toggled by the end users; the listener method applyEditorValue is immediately called to signal the change.

    Restriction:
    This class is not intended to be subclassed by clients.

    • Constructor Detail

      • CheckboxCellEditor

        public CheckboxCellEditor()
        Creates a new checkbox cell editor with no control
        Since:
        2.1

      • CheckboxCellEditor

        public CheckboxCellEditor​(Composite parent)
        Creates a new checkbox cell editor parented under the given control. The cell editor value is a boolean value, which is initially false. Initially, the cell editor has no cell validator.
        Parameters:
        parent - the parent control

      • CheckboxCellEditor

        public CheckboxCellEditor​(Composite parent,
                          int style)
        Creates a new checkbox cell editor parented under the given control. The cell editor value is a boolean value, which is initially false. Initially, the cell editor has no cell validator.
        Parameters:
        parent - the parent control
        style - the style bits
        Since:
        2.1

    • Method Detail

      • activate

        public void activate()
        The CheckboxCellEditor implementation of this CellEditor framework method simulates the toggling of the checkbox control and notifies listeners with ICellEditorListener.applyEditorValue.
        Overrides:
        activate in class CellEditor

      • createControl

        protected Control createControl​(Composite parent)
        The CheckboxCellEditor implementation of this CellEditor framework method does nothing and returns null.
        Specified by:
        createControl in class CellEditor
        Parameters:
        parent - the parent control
        Returns:
        the new control, or null if this cell editor has no control

      • doGetValue

        protected Object doGetValue()
        The CheckboxCellEditor implementation of this CellEditor framework method returns the checkbox setting wrapped as a Boolean.
        Specified by:
        doGetValue in class CellEditor
        Returns:
        the Boolean checkbox value
        See Also:
        CellEditor.getValue()

      • doSetFocus

        protected void doSetFocus()
        Description copied from class: CellEditor
        Sets the focus to the cell editor's control.

        This framework method must be implemented by concrete subclasses.

        Specified by:
        doSetFocus in class CellEditor
        See Also:
        CellEditor.setFocus()