Class ComboFieldEditor


  • public class ComboFieldEditor
    extends FieldEditor
    A field editor for a combo box that allows the drop-down selection of one of a list of items.
    Since:
    3.3
    • Constructor Detail

      • ComboFieldEditor

        public ComboFieldEditor​(String name,
                                String labelText,
                                String[][] entryNamesAndValues,
                                Composite parent)
        Create the combo box field editor.
        Parameters:
        name - the name of the preference this field editor works on
        labelText - the label text of the field editor
        entryNamesAndValues - the names (labels) and underlying values to populate the combo widget. These should be arranged as: { {name1, value1}, {name2, value2}, ...}
        parent - the parent composite
    • Method Detail

      • adjustForNumColumns

        protected void adjustForNumColumns​(int numColumns)
        Description copied from class: FieldEditor
        Adjusts the horizontal span of this field editor's basic controls.

        Subclasses must implement this method to adjust the horizontal span of controls so they appear correct in the given number of columns.

        The number of columns will always be equal to or greater than the value returned by this editor's getNumberOfControls method.

        Specified by:
        adjustForNumColumns in class FieldEditor
        Parameters:
        numColumns - the number of columns
      • doFillIntoGrid

        protected void doFillIntoGrid​(Composite parent,
                                      int numColumns)
        Description copied from class: FieldEditor
        Fills this field editor's basic controls into the given parent.

        Subclasses must implement this method to create the controls for this field editor.

        Note this method may be called by the constructor, so it must not access fields on the receiver object because they will not be fully initialized.

        Specified by:
        doFillIntoGrid in class FieldEditor
        Parameters:
        parent - the composite used as a parent for the basic controls; the parent's layout must be a GridLayout
        numColumns - the number of columns
      • doLoad

        protected void doLoad()
        Description copied from class: FieldEditor
        Initializes this field editor with the preference value from the preference store.

        Subclasses must implement this method to properly initialize the field editor.

        Specified by:
        doLoad in class FieldEditor
      • doLoadDefault

        protected void doLoadDefault()
        Description copied from class: FieldEditor
        Initializes this field editor with the default preference value from the preference store.

        Subclasses must implement this method to properly initialize the field editor.

        Specified by:
        doLoadDefault in class FieldEditor
      • doStore

        protected void doStore()
        Description copied from class: FieldEditor
        Stores the preference value from this field editor into the preference store.

        Subclasses must implement this method to save the entered value into the preference store.

        Specified by:
        doStore in class FieldEditor
      • getNumberOfControls

        public int getNumberOfControls()
        Description copied from class: FieldEditor
        Returns the number of basic controls this field editor consists of.
        Specified by:
        getNumberOfControls in class FieldEditor
        Returns:
        the number of controls
      • setEnabled

        public void setEnabled​(boolean enabled,
                               Composite parent)
        Description copied from class: FieldEditor
        Set whether or not the controls in the field editor are enabled.
        Overrides:
        setEnabled in class FieldEditor
        Parameters:
        enabled - The enabled state.
        parent - The parent of the controls in the group. Used to create the controls if required.