org.mailster.gui.prefs
Class DefaultConfigurationPage

java.lang.Object
  extended by org.eclipse.jface.dialogs.DialogPage
      extended by org.eclipse.jface.preference.PreferencePage
          extended by org.mailster.gui.prefs.DefaultConfigurationPage
All Implemented Interfaces:
org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.preference.IPreferencePage
Direct Known Subclasses:
GeneralConfigurationPage, POP3ConfigurationPage, ProtocolsConfigurationPage, TrayConfigurationPage

public abstract class DefaultConfigurationPage
extends org.eclipse.jface.preference.PreferencePage

DefaultConfigurationPage extends PreferencePage to make use of localized button texts and to display the default button images for the ok, cancel, apply and defaults button. All configuration pages that need finer control on the created editor Controls should inherit this class.

Author:
Sebastian Machhausen, Edouard De Oliveira

Field Summary
 
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
 
Constructor Summary
DefaultConfigurationPage()
          DefaultConfigurationPage default constructor.
DefaultConfigurationPage(java.lang.String title)
          Creates a new abstract DefaultConfigurationPage with the given title.
DefaultConfigurationPage(java.lang.String title, org.eclipse.jface.resource.ImageDescriptor image)
          Creates a new abstract DefaultConfigurationPage with the given title and image.
 
Method Summary
 void createControl(org.eclipse.swt.widgets.Composite parent)
          Creates the control for this DefaultConfigurationPage.
 void setupEditor(org.eclipse.jface.preference.FieldEditor editor)
          Adds the editor to the current preference page.
 
Methods inherited from class org.eclipse.jface.preference.PreferencePage
applyData, applyDialogFont, computeSize, contributeButtons, createContents, createDescriptionLabel, createNoteComposite, doComputeSize, doGetPreferenceStore, getApplyButton, getContainer, getDefaultsButton, getPreferenceStore, isValid, noDefaultAndApplyButton, okToLeave, performApply, performCancel, performDefaults, performHelp, performOk, setContainer, setErrorMessage, setMessage, setPreferenceStore, setSize, setTitle, setValid, toString, updateApplyButton
 
Methods inherited from class org.eclipse.jface.dialogs.DialogPage
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getImage, getMessage, getMessageType, getShell, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, setButtonLayoutData, setControl, setDescription, setImageDescriptor, setMessage, setVisible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, setDescription, setImageDescriptor, setVisible
 

Constructor Detail

DefaultConfigurationPage

public DefaultConfigurationPage()
DefaultConfigurationPage default constructor.


DefaultConfigurationPage

public DefaultConfigurationPage(java.lang.String title)
Creates a new abstract DefaultConfigurationPage with the given title.

Parameters:
title - the page title

DefaultConfigurationPage

public DefaultConfigurationPage(java.lang.String title,
                                org.eclipse.jface.resource.ImageDescriptor image)
Creates a new abstract DefaultConfigurationPage with the given title and image.

Parameters:
title - the page title
image - the image for this page, or null if none
Method Detail

createControl

public void createControl(org.eclipse.swt.widgets.Composite parent)
Creates the control for this DefaultConfigurationPage.

Specified by:
createControl in interface org.eclipse.jface.dialogs.IDialogPage
Overrides:
createControl in class org.eclipse.jface.preference.PreferencePage
Parameters:
parent - the parent container to embed the created control into

setupEditor

public void setupEditor(org.eclipse.jface.preference.FieldEditor editor)
Adds the editor to the current preference page. Links it with the page IPreferenceStore and then load stored value.

Parameters:
editor - the field editor to setup