Class ColorFieldEditor
- java.lang.Object
-
- org.eclipse.jface.preference.FieldEditor
-
- org.eclipse.jface.preference.ColorFieldEditor
-
public class ColorFieldEditor extends FieldEditor
A field editor for a color type preference.
-
-
Field Summary
-
Fields inherited from class org.eclipse.jface.preference.FieldEditor
HORIZONTAL_GAP, IS_VALID, VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedColorFieldEditor()Creates a new color field editorColorFieldEditor(String name, String labelText, Composite parent)Creates a color field editor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidadjustForNumColumns(int numColumns)Adjusts the horizontal span of this field editor's basic controls.protected PointcomputeImageSize(Control window)Computes the size of the color image displayed on the button.protected voiddoFillIntoGrid(Composite parent, int numColumns)Fills this field editor's basic controls into the given parent.protected voiddoLoad()Initializes this field editor with the preference value from the preference store.protected voiddoLoadDefault()Initializes this field editor with the default preference value from the preference store.protected voiddoStore()Stores the preference value from this field editor into the preference store.protected ButtongetChangeControl(Composite parent)Returns the change button for this field editor.ColorSelectorgetColorSelector()Get the color selector used by the receiver.intgetNumberOfControls()Returns the number of basic controls this field editor consists of.voidsetEnabled(boolean enabled, Composite parent)Set whether or not the controls in the field editor are enabled.-
Methods inherited from class org.eclipse.jface.preference.FieldEditor
applyFont, checkParent, clearErrorMessage, clearMessage, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, createControl, dispose, fillIntoGrid, fireStateChanged, fireValueChanged, getFieldEditorFontName, getLabelControl, getLabelControl, getLabelText, getPage, getPreferenceName, getPreferencePage, getPreferenceStore, init, isValid, load, loadDefault, presentsDefaultValue, refreshValidState, setButtonLayoutData, setFocus, setLabelText, setPage, setPreferenceName, setPreferencePage, setPreferenceStore, setPresentsDefaultValue, setPropertyChangeListener, showErrorMessage, showMessage, store
-
-
-
-
Method Detail
-
adjustForNumColumns
protected void adjustForNumColumns(int numColumns)
Description copied from class:FieldEditorAdjusts 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
getNumberOfControlsmethod.- Specified by:
adjustForNumColumnsin classFieldEditor- Parameters:
numColumns- the number of columns
-
computeImageSize
protected Point computeImageSize(Control window)
Computes the size of the color image displayed on the button.This is an internal method and should not be called by clients.
- Parameters:
window- the window to create a GC on for calculation.- Returns:
- Point The image size
-
doFillIntoGrid
protected void doFillIntoGrid(Composite parent, int numColumns)
Description copied from class:FieldEditorFills 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:
doFillIntoGridin classFieldEditor- Parameters:
parent- the composite used as a parent for the basic controls; the parent's layout must be aGridLayoutnumColumns- the number of columns
-
doLoad
protected void doLoad()
Description copied from class:FieldEditorInitializes this field editor with the preference value from the preference store.Subclasses must implement this method to properly initialize the field editor.
- Specified by:
doLoadin classFieldEditor
-
doLoadDefault
protected void doLoadDefault()
Description copied from class:FieldEditorInitializes 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:
doLoadDefaultin classFieldEditor
-
doStore
protected void doStore()
Description copied from class:FieldEditorStores 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:
doStorein classFieldEditor
-
getColorSelector
public ColorSelector getColorSelector()
Get the color selector used by the receiver.- Returns:
- ColorSelector/
-
getChangeControl
protected Button getChangeControl(Composite parent)
Returns the change button for this field editor.- Parameters:
parent- The control to create the button in if required.- Returns:
- the change button
-
getNumberOfControls
public int getNumberOfControls()
Description copied from class:FieldEditorReturns the number of basic controls this field editor consists of.- Specified by:
getNumberOfControlsin classFieldEditor- Returns:
- the number of controls
-
setEnabled
public void setEnabled(boolean enabled, Composite parent)Description copied from class:FieldEditorSet whether or not the controls in the field editor are enabled.- Overrides:
setEnabledin classFieldEditor- Parameters:
enabled- The enabled state.parent- The parent of the controls in the group. Used to create the controls if required.
-
-