Class FontFieldEditor
- java.lang.Object
-
- org.eclipse.jface.preference.FieldEditor
-
- org.eclipse.jface.preference.FontFieldEditor
-
- Direct Known Subclasses:
PropagatingFontFieldEditor
public class FontFieldEditor extends FieldEditor
A field editor for a font type preference.
-
-
Field Summary
-
Fields inherited from class org.eclipse.jface.preference.FieldEditor
HORIZONTAL_GAP, IS_VALID, VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedFontFieldEditor()Creates a new font field editorFontFieldEditor(String name, String labelText, String previewAreaText, Composite parent)Creates a font field editor with an optional preview area.FontFieldEditor(String name, String labelText, Composite parent)Creates a font field editor without a preview.
-
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 voidapplyFont()Applies a font.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.intgetNumberOfControls()Returns the number of basic controls this field editor consists of.intgetPreferredPreviewHeight()Returns the preferred preview height.ControlgetPreviewControl()Returns the preview control for this field editor.protected LabelgetValueControl(Composite parent)Returns the value control for this field editor.voidsetChangeButtonText(String text)Sets the text of the change button.voidsetEnabled(boolean enabled, Composite parent)Set whether or not the controls in the field editor are enabled.protected voidsetToDefault()Store the default preference for the field being edited-
Methods inherited from class org.eclipse.jface.preference.FieldEditor
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
-
-
-
-
Constructor Detail
-
FontFieldEditor
protected FontFieldEditor()
Creates a new font field editor
-
FontFieldEditor
public FontFieldEditor(String name, String labelText, String previewAreaText, Composite parent)
Creates a font field editor with an optional preview area.- Parameters:
name- the name of the preference this field editor works onlabelText- the label text of the field editorpreviewAreaText- the text used for the preview window. If it isnullthere will be no preview area,parent- the parent of the field editor's control
-
FontFieldEditor
public FontFieldEditor(String name, String labelText, Composite parent)
Creates a font field editor without a preview.- Parameters:
name- the name of the preference this field editor works onlabelText- the label text of the field editorparent- the parent of the field editor's control
-
-
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
-
applyFont
protected void applyFont()
Description copied from class:FieldEditorApplies a font.The default implementation of this framework method does nothing. Subclasses should override this method if they want to change the font of the SWT control to a value different than the standard dialog font.
- Overrides:
applyFontin classFieldEditor
-
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
-
getChangeControl
protected Button getChangeControl(Composite parent)
Returns the change button for this field editor.- Parameters:
parent- The Composite 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
-
getPreferredPreviewHeight
public int getPreferredPreviewHeight()
Returns the preferred preview height.- Returns:
- the height, or
-1if no previewer is installed
-
getPreviewControl
public Control getPreviewControl()
Returns the preview control for this field editor.- Returns:
- the preview control
-
getValueControl
protected Label getValueControl(Composite parent)
Returns the value control for this field editor. The value control displays the currently selected font name.- Parameters:
parent- The Composite to create the viewer in if required- Returns:
- the value control
-
setChangeButtonText
public void setChangeButtonText(String text)
Sets the text of the change button.- Parameters:
text- the new text
-
setToDefault
protected void setToDefault()
Store the default preference for the field being edited
-
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.
-
-