|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.preference.FieldEditor
org.eclipse.jface.preference.FontFieldEditor
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 | |
---|---|
protected |
FontFieldEditor()
Creates a new font field editor |
|
FontFieldEditor(String name,
String labelText,
Composite parent)
Creates a font field editor without a preview. |
|
FontFieldEditor(String name,
String labelText,
String previewAreaText,
Composite parent)
Creates a font field editor with an optional preview area. |
Method Summary | |
---|---|
protected void |
adjustForNumColumns(int numColumns)
Adjusts the horizontal span of this field editor's basic controls. |
protected void |
applyFont()
Applies a font. |
protected void |
doFillIntoGrid(Composite parent,
int numColumns)
Fills this field editor's basic controls into the given parent. |
protected void |
doLoad()
Initializes this field editor with the preference value from the preference store. |
protected void |
doLoadDefault()
Initializes this field editor with the default preference value from the preference store. |
protected void |
doStore()
Stores the preference value from this field editor into the preference store. |
protected Button |
getChangeControl(Composite parent)
Returns the change button for this field editor. |
int |
getNumberOfControls()
Returns the number of basic controls this field editor consists of. |
int |
getPreferredPreviewHeight()
Returns the preferred preview height. |
Control |
getPreviewControl()
Returns the preview control for this field editor. |
protected Label |
getValueControl(Composite parent)
Returns the value control for this field editor. |
void |
setChangeButtonText(String text)
Sets the text of the change button. |
void |
setEnabled(boolean enabled,
Composite parent)
Set whether or not the controls in the field editor are enabled. |
protected void |
setToDefault()
Store the default preference for the field being edited |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected FontFieldEditor()
public FontFieldEditor(String name, String labelText, String previewAreaText, Composite parent)
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 is
null
there will be no preview area,parent
- the parent of the field editor's controlpublic FontFieldEditor(String name, String labelText, Composite parent)
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 controlMethod Detail |
protected void adjustForNumColumns(int numColumns)
FieldEditor
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.
adjustForNumColumns
in class FieldEditor
numColumns
- the number of columnsprotected void applyFont()
FieldEditor
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.
applyFont
in class FieldEditor
protected void doFillIntoGrid(Composite parent, int numColumns)
FieldEditor
Subclasses must implement this method to create the controls for this field editor.
doFillIntoGrid
in class FieldEditor
parent
- the composite used as a parent for the basic controls;
the parent's layout must be a GridLayout
numColumns
- the number of columnsprotected void doLoad()
FieldEditor
Subclasses must implement this method to properly initialize the field editor.
doLoad
in class FieldEditor
protected void doLoadDefault()
FieldEditor
Subclasses must implement this method to properly initialize the field editor.
doLoadDefault
in class FieldEditor
protected void doStore()
FieldEditor
Subclasses must implement this method to save the entered value into the preference store.
doStore
in class FieldEditor
protected Button getChangeControl(Composite parent)
parent
- The Composite to create the button in if required.
public int getNumberOfControls()
FieldEditor
getNumberOfControls
in class FieldEditor
public int getPreferredPreviewHeight()
-1
if no previewer
is installedpublic Control getPreviewControl()
protected Label getValueControl(Composite parent)
parent
- The Composite to create the viewer in if required
public void setChangeButtonText(String text)
text
- the new textprotected void setToDefault()
public void setEnabled(boolean enabled, Composite parent)
FieldEditor
setEnabled
in class FieldEditor
enabled
- The enabled state.parent
- The parent of the controls in the group.
Used to create the controls if required.
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.