org.eclipse.xtext.ui.editor.preferences

Class AbstractPreferencePage

java.lang.Object

org.eclipse.jface.dialogs.DialogPage

org.eclipse.jface.preference.PreferencePage

org.eclipse.jface.preference.FieldEditorPreferencePage

org.eclipse.xtext.ui.editor.preferences.AbstractPreferencePage

All Implemented Interfaces:

EventListener, org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.preference.IPreferencePage, org.eclipse.jface.util.IPropertyChangeListener, org.eclipse.ui.IWorkbenchPreferencePage, org.eclipse.ui.IWorkbenchPropertyPage

Direct Known Subclasses:

LanguageRootPreferencePage, RefactoringPreferencePage, SyntaxColoringPreferencePage

public abstract class AbstractPreferencePage
extends org.eclipse.jface.preference.FieldEditorPreferencePage
implements org.eclipse.ui.IWorkbenchPreferencePage, org.eclipse.ui.IWorkbenchPropertyPage

This implementation works with a FixedScopedPreferenceStore

The following changes have been made:

• 'useProjectSettings' is now stored in the project preference store as opposed to the project meta-data stored in the workspace. This is done so that import of a project automatically gets the intended 'useProjectSettings'.

Author:

Dennis Hübner - Initial contribution and API, Henrik Lindberg - changes to store 'use project settings' in project

See Also:

PropertyAndPreferencePage

Field Summary

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

FLAT, GRID, MARGIN_HEIGHT, MARGIN_WIDTH, VERTICAL_SPACING

Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

Constructors

Constructor and Description
AbstractPreferencePage()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addField(org.eclipse.jface.preference.FieldEditor editor)
protected org.eclipse.swt.widgets.Control	createContents(org.eclipse.swt.widgets.Composite parent)
void	createControl(org.eclipse.swt.widgets.Composite parent)
protected org.eclipse.jface.preference.IPreferenceStore	doGetPreferenceStore()
org.eclipse.core.runtime.IAdaptable	getElement()
protected String	getLanguageName()
protected String	getQualifier() Deprecated. Use qualifiedName() instead
protected org.eclipse.ui.IWorkbench	getWorkbench()
void	init(org.eclipse.ui.IWorkbench workbench)
boolean	isPropertyPage()
boolean	performOk()
protected String	qualifiedName()
void	setElement(org.eclipse.core.runtime.IAdaptable element)
protected void	updateFieldEditors(boolean enabled) Loads values of all field editors using current search scopes in the preference store.
protected String	useProjectSettingsPreferenceName() Produces the preference key to use for the 'use project settings' flag when this preference page is is used as a properties page.

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

adjustGridLayout, applyFont, checkState, createFieldEditors, dispose, getFieldEditorParent, initialize, performDefaults, propertyChange, setVisible

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

applyData, applyDialogFont, computeSize, contributeButtons, createDescriptionLabel, createNoteComposite, doComputeSize, getApplyButton, getContainer, getDefaultsButton, getPreferenceStore, isValid, noDefaultAndApplyButton, okToLeave, performApply, performCancel, performHelp, setContainer, setErrorMessage, setMessage, setPreferenceStore, setSize, setTitle, setValid, toString, updateApplyButton

Methods inherited from class org.eclipse.jface.dialogs.DialogPage

convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getImage, getMessage, getMessageType, getShell, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, setButtonLayoutData, setControl, setDescription, setImageDescriptor, setMessage

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jface.preference.IPreferencePage

computeSize, isValid, okToLeave, performCancel, setContainer, setSize

Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage

dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible

Constructor Detail

AbstractPreferencePage

public AbstractPreferencePage()

Method Detail

init

public void init(org.eclipse.ui.IWorkbench workbench)

Specified by:

init in interface org.eclipse.ui.IWorkbenchPreferencePage

getWorkbench

protected org.eclipse.ui.IWorkbench getWorkbench()

setElement

public void setElement(org.eclipse.core.runtime.IAdaptable element)

Specified by:

setElement in interface org.eclipse.ui.IWorkbenchPropertyPage

getElement

public org.eclipse.core.runtime.IAdaptable getElement()

Specified by:

getElement in interface org.eclipse.ui.IWorkbenchPropertyPage

isPropertyPage

public boolean isPropertyPage()

doGetPreferenceStore

protected org.eclipse.jface.preference.IPreferenceStore doGetPreferenceStore()

Overrides:

doGetPreferenceStore in class org.eclipse.jface.preference.PreferencePage

getQualifier

@Deprecated
protected String getQualifier()

Deprecated. Use qualifiedName() instead

Returns:

the qualifer used to look up the preference node of the configured preferencesstore

createContents

protected org.eclipse.swt.widgets.Control createContents(org.eclipse.swt.widgets.Composite parent)

Overrides:

createContents in class org.eclipse.jface.preference.FieldEditorPreferencePage

getLanguageName

protected String getLanguageName()

qualifiedName

protected String qualifiedName()

Returns:

prefix for preference keys

createControl

public void createControl(org.eclipse.swt.widgets.Composite parent)

Specified by:

createControl in interface org.eclipse.jface.dialogs.IDialogPage

Overrides:

createControl in class org.eclipse.jface.preference.PreferencePage

addField

protected void addField(org.eclipse.jface.preference.FieldEditor editor)

Overrides:

addField in class org.eclipse.jface.preference.FieldEditorPreferencePage

useProjectSettingsPreferenceName

protected String useProjectSettingsPreferenceName()

Produces the preference key to use for the 'use project settings' flag when this preference page is is used as a properties page.

Returns:

the concatenation of qualifiedName(), "." and USE_PROJECT_SETTINGS.

Since:

2.8

updateFieldEditors

protected void updateFieldEditors(boolean enabled)

Loads values of all field editors using current search scopes in the preference store. Also updates fields enabled status. (The effect is that fields show project specific values when enabled, and instance scoped/default values when disabled).

Parameters:

enabled -

performOk

public boolean performOk()

Specified by:

performOk in interface org.eclipse.jface.preference.IPreferencePage

Overrides:

performOk in class org.eclipse.jface.preference.FieldEditorPreferencePage