ptolemy.backtrack.eclipse.plugin.preferences

Class SectionPreferencePage

java.lang.Object

org.eclipse.jface.dialogs.DialogPage

org.eclipse.jface.preference.PreferencePage

org.eclipse.jface.preference.FieldEditorPreferencePage

ptolemy.backtrack.eclipse.plugin.preferences.SectionPreferencePage

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

Direct Known Subclasses:

BacktrackingPreferencePage, EditorPreferencePage

public class SectionPreferencePage
extends org.eclipse.jface.preference.FieldEditorPreferencePage
implements org.eclipse.ui.IWorkbenchPreferencePage

The superclass for preference pages with multiple sections.

Since:

Ptolemy II 5.1

Version:

$Id: SectionPreferencePage.java 65763 2013-03-07 01:54:37Z cxh $

Author:

Thomas Feng

Accepted Rating:

Red (tfeng)

Proposed Rating:

Red (tfeng)

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
SectionPreferencePage(java.lang.String description) Construct a preference page with multiple sections and with a page description.

Method Summary

Modifier and Type	Method and Description
protected org.eclipse.swt.widgets.Composite	_createSection(java.lang.String title, java.lang.String description) Create a section in this page with a title and a section description.
protected org.eclipse.swt.widgets.Composite	_getParent(org.eclipse.jface.preference.FieldEditor editor) Given a field editor, return its parent.
protected org.eclipse.swt.widgets.Composite	_newComposite(org.eclipse.swt.widgets.Composite parent) Create a new container with the given parent.
protected org.eclipse.swt.widgets.Composite	_newComposite(org.eclipse.swt.widgets.Composite parent, int column) Create a new container with the given composite container as its parent, and use a grid layout with the specified number of columns.
protected org.eclipse.swt.widgets.Group	_newGroup(org.eclipse.swt.widgets.Composite parent, java.lang.String title) Create a new group with the given parent and the given title.
protected static void	_setEnabled(org.eclipse.swt.widgets.Composite composite, boolean enabled) Set whether a container and all its children are enabled.
protected void	_setParent(org.eclipse.jface.preference.FieldEditor editor, org.eclipse.swt.widgets.Composite parent) Set the parent of a field editor.
org.eclipse.swt.widgets.Control	createContents(org.eclipse.swt.widgets.Composite parent) Create the contents of the preference page with the parent as its container.
protected void	createFieldEditors() Create field editors.
void	init(org.eclipse.ui.IWorkbench workbench) Initialize.

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

addField, adjustGridLayout, applyFont, checkState, dispose, getFieldEditorParent, initialize, performDefaults, performOk, propertyChange, setVisible

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

applyData, applyDialogFont, computeSize, contributeButtons, createControl, createDescriptionLabel, createNoteComposite, doComputeSize, doGetPreferenceStore, 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, performOk, setContainer, setSize

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

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

Constructor Detail

SectionPreferencePage

public SectionPreferencePage(java.lang.String description)

Construct a preference page with multiple sections and with a page description.

Parameters:

description - The description.

Method Detail

createContents

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

Create the contents of the preference page with the parent as its container.

Overrides:

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

Parameters:

parent - The parent container.

Returns:

The parent itself.

init

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

Initialize. This method is inherited from the abstract superclass, and does nothing.

Specified by:

init in interface org.eclipse.ui.IWorkbenchPreferencePage

Parameters:

workbench - The workbench.

_createSection

protected org.eclipse.swt.widgets.Composite _createSection(java.lang.String title,
                                                           java.lang.String description)

Create a section in this page with a title and a section description.

Parameters:

title - The title.

description - The description.

Returns:

The container that can contain all the controls in the created section.

_getParent

protected org.eclipse.swt.widgets.Composite _getParent(org.eclipse.jface.preference.FieldEditor editor)

Given a field editor, return its parent.

Parameters:

editor - The field editor.

Returns:

The parent.

See Also:

_setParent(FieldEditor, Composite)

_newComposite

protected org.eclipse.swt.widgets.Composite _newComposite(org.eclipse.swt.widgets.Composite parent)

Create a new container with the given parent.

Parameters:

parent - The parent container.

Returns:

The new container.

_newComposite

protected org.eclipse.swt.widgets.Composite _newComposite(org.eclipse.swt.widgets.Composite parent,
                                                          int column)

Create a new container with the given composite container as its parent, and use a grid layout with the specified number of columns.

Parameters:

parent - The parent container.

column - The number of columns in the grid layout.

Returns:

The new container.

_newGroup

protected org.eclipse.swt.widgets.Group _newGroup(org.eclipse.swt.widgets.Composite parent,
                                                  java.lang.String title)

Create a new group with the given parent and the given title.

Parameters:

parent - The parent container.

title - The title.

Returns:

The new group.

_setEnabled

protected static void _setEnabled(org.eclipse.swt.widgets.Composite composite,
                                  boolean enabled)

Set whether a container and all its children are enabled.

Parameters:

composite - The container.

enabled - Whether the container and all its children are enabled.

_setParent

protected void _setParent(org.eclipse.jface.preference.FieldEditor editor,
                          org.eclipse.swt.widgets.Composite parent)

Set the parent of a field editor.

Parameters:

editor - The field editor.

parent - The parent.

See Also:

_getParent(FieldEditor)

createFieldEditors

protected void createFieldEditors()

Create field editors. This method is inherited from the abstract superclass, and does nothing.

Specified by:

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