org.eclipse.ocl.common.ui.internal.preferences
Class AbstractProjectPreferencePage

java.lang.Object
  org.eclipse.jface.dialogs.DialogPage
      org.eclipse.jface.preference.PreferencePage
          org.eclipse.ocl.common.ui.internal.preferences.AbstractProjectPreferencePage

All Implemented Interfaces:

java.util.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:

CommonProjectPreferencePage, EcoreAndUmlProjectPreferencePage, OCLinEcoreProjectPreferencePage, UMLProjectPreferencePage

public abstract class AbstractProjectPreferencePage
extends org.eclipse.jface.preference.PreferencePage
implements org.eclipse.jface.util.IPropertyChangeListener, org.eclipse.ui.IWorkbenchPreferencePage, org.eclipse.ui.IWorkbenchPropertyPage

An abstract Project/Property preference page providing support for use as a global preference page or as a project-specific property page.

Nested Class Summary

protected static interface	AbstractProjectPreferencePage.IFieldEditor
protected static class	AbstractProjectPreferencePage.MyComboFieldEditor

Field Summary

protected static java.lang.String[][]	ANY_LESS_VALUES
protected static java.lang.String[][]	BOOLEANS

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

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

AbstractProjectPreferencePage(java.lang.String pluginId, java.lang.String pageTitle)

Method Summary

protected void	adjustGridLayout() Adjust the layout of the field editors so that they are properly aligned.
protected void	checkState() Recomputes the page's error state by calling isValid for every field editor.
protected abstract AbstractProjectPreferencePage	createClonePage()
protected org.eclipse.swt.widgets.Control	createContents(org.eclipse.swt.widgets.Composite parent) Insert the project-specific button and link on project-specific pages.
void	createFieldEditors(org.eclipse.swt.widgets.Composite fieldEditorParent) Creates the field editors.
protected abstract void	createFieldEditors(org.eclipse.swt.widgets.Composite fieldEditorParent, java.util.List<AbstractProjectPreferencePage.IFieldEditor> fields)
void	dispose() The field editor preference page implementation of an IDialogPage method disposes of this page's controls and images.
org.eclipse.core.resources.IProject	getElement() Return the object that owns the properties shown in this property page, which is a non-null IProject for a project Property page and null for a global preference page.
org.eclipse.jface.preference.IPreferenceStore	getPreferenceStore() Returns the prevailing project or workspace preference store.
org.eclipse.jface.preference.IPreferenceStore	getWorkspaceStore()
void	init(org.eclipse.ui.IWorkbench workbench)
protected void	initialize()
protected void	performDefaults() Performing defaults reverts workspace settings to built-in defaults or project settings to workspace settings.
boolean	performOk()
void	propertyChange(org.eclipse.jface.util.PropertyChangeEvent event) The field editor preference page implementation of this IPreferencePage (and IPropertyChangeListener) method intercepts IS_VALID events but passes other events on to its superclass.
void	setElement(org.eclipse.core.runtime.IAdaptable element) Receives the object that owns the properties shown in this property page.
void	setVisible(boolean visible)
protected void	updateFieldEditors()

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

applyData, applyDialogFont, computeSize, contributeButtons, createControl, createDescriptionLabel, createNoteComposite, doComputeSize, doGetPreferenceStore, getApplyButton, getContainer, getDefaultsButton, 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

createControl, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle

Field Detail

BOOLEANS

protected static final java.lang.String[][] BOOLEANS

ANY_LESS_VALUES

protected static final java.lang.String[][] ANY_LESS_VALUES

Constructor Detail

AbstractProjectPreferencePage

public AbstractProjectPreferencePage(java.lang.String pluginId,
                                     java.lang.String pageTitle)

Method Detail

adjustGridLayout

protected void adjustGridLayout()

Adjust the layout of the field editors so that they are properly aligned.

checkState

protected void checkState()

Recomputes the page's error state by calling isValid for every field editor.

createClonePage

protected abstract AbstractProjectPreferencePage createClonePage()

createContents

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

Insert the project-specific button and link on project-specific pages.

Specified by:

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

createFieldEditors

public void createFieldEditors(org.eclipse.swt.widgets.Composite fieldEditorParent)

Creates the field editors. Field editors are abstractions of the common GUI blocks needed to manipulate various types of preferences. Each field editor knows how to save and restore itself.

createFieldEditors

protected abstract void createFieldEditors(org.eclipse.swt.widgets.Composite fieldEditorParent,
                                           java.util.List<AbstractProjectPreferencePage.IFieldEditor> fields)

dispose

public void dispose()

The field editor preference page implementation of an IDialogPage method disposes of this page's controls and images. Subclasses may override to release their own allocated SWT resources, but must call super.dispose.

Specified by:

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

Overrides:

dispose in class org.eclipse.jface.dialogs.DialogPage

getElement

public final org.eclipse.core.resources.IProject getElement()

Return the object that owns the properties shown in this property page, which is a non-null IProject for a project Property page and null for a global preference page.

Specified by:

getElement in interface org.eclipse.ui.IWorkbenchPropertyPage

getPreferenceStore

public org.eclipse.jface.preference.IPreferenceStore getPreferenceStore()

Returns the prevailing project or workspace preference store.

Overrides:

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

getWorkspaceStore

public org.eclipse.jface.preference.IPreferenceStore getWorkspaceStore()

init

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

Specified by:

init in interface org.eclipse.ui.IWorkbenchPreferencePage

initialize

protected void initialize()

performDefaults

protected void performDefaults()

Performing defaults reverts workspace settings to built-in defaults or project settings to workspace settings.

Overrides:

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

performOk

public boolean performOk()

Specified by:

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

Overrides:

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

propertyChange

public void propertyChange(org.eclipse.jface.util.PropertyChangeEvent event)

The field editor preference page implementation of this IPreferencePage (and IPropertyChangeListener) method intercepts IS_VALID events but passes other events on to its superclass.

Specified by:

propertyChange in interface org.eclipse.jface.util.IPropertyChangeListener

setElement

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

Receives the object that owns the properties shown in this property page.

Specified by:

setElement in interface org.eclipse.ui.IWorkbenchPropertyPage

See Also:

IWorkbenchPropertyPage.setElement(org.eclipse.core.runtime.IAdaptable)

setVisible

public void setVisible(boolean visible)

Specified by:

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

Overrides:

setVisible in class org.eclipse.jface.dialogs.DialogPage

updateFieldEditors

protected void updateFieldEditors()