org.eclipse.ui.texteditor
Class WorkbenchChainedTextFontFieldEditor

java.lang.Object
  |
  +--org.eclipse.jface.preference.FieldEditor
        |
        +--org.eclipse.jface.preference.FontFieldEditor
              |
              +--org.eclipse.jface.text.PropagatingFontFieldEditor
                    |
                    +--org.eclipse.ui.texteditor.WorkbenchChainedTextFontFieldEditor

Direct Known Subclasses:

PropagatingFontFieldEditor

public class WorkbenchChainedTextFontFieldEditor

extends PropagatingFontFieldEditor

This font field editor implements chaining between the workbench's preference store and a given target preference store. Any time the workbench's preference for the text font changes, the change is propagated to the target store. Propagation means that the actual text font stored in the workbench store is set as default text font in the target store. If the target store does not contain a value rather than the default text font, the new default text font is immediately effective.

Since:

2.0

See Also:

FontFieldEditor

Field Summary

Fields inherited from class org.eclipse.jface.preference.FieldEditor

HORIZONTAL_GAP, IS_VALID, VALUE

Constructor Summary

WorkbenchChainedTextFontFieldEditor(String name, String labelText, Composite parent)
Creates a new font field editor with the given parameters.

Method Summary

static void

startPropagate(IPreferenceStore target, String targetKey) Starts the propagation of the text font preference set in the workbench to given target preference store using the given preference key.

Methods inherited from class org.eclipse.jface.text.PropagatingFontFieldEditor

doLoad, doLoadDefault, startPropagate

Methods inherited from class org.eclipse.jface.preference.FontFieldEditor

adjustForNumColumns, applyFont, doFillIntoGrid, doStore, getChangeControl, getNumberOfControls, getPreferredPreviewHeight, getPreviewControl, getValueControl, setChangeButtonText, setToDefault

Methods inherited from class org.eclipse.jface.preference.FieldEditor

checkParent, clearErrorMessage, clearMessage, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, createControl, dispose, fillIntoGrid, fireStateChanged, fireValueChanged, getFieldEditorFontName, getLabelControl, getLabelControl, getLabelText, getPreferenceName, getPreferencePage, getPreferenceStore, init, isValid, load, loadDefault, presentsDefaultValue, refreshValidState, setFocus, setLabelText, setPreferenceName, setPreferencePage, setPreferenceStore, setPresentsDefaultValue, setPropertyChangeListener, showErrorMessage, showMessage, store

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkbenchChainedTextFontFieldEditor

public WorkbenchChainedTextFontFieldEditor(String name,
                                           String labelText,
                                           Composite parent)

Creates a new font field editor with the given parameters.

Parameters:

name - the editor's name

labelText - the text shown as editor description

parent - the editor's parent widget

Method Detail

startPropagate

public static void startPropagate(IPreferenceStore target,
                                  String targetKey)

Starts the propagation of the text font preference set in the workbench to given target preference store using the given preference key.

Parameters:

target - the target preference store

targetKey - the key to be used in the target preference store