|
Eclipse eRCP Release 1.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.preference.PreferencePage
Abstract base implementation for all preference page implementations.
Subclasses must implement the createControl
framework
method to supply the page's main control.
Subclasses should extend the doComputeSize
framework
method to compute the size of the page's control.
Subclasses may override the performOk
, performApply
,
performDefaults
, performCancel
, and performHelp
framework methods to react to the standard button events.
Subclasses may call the noDefaultAndApplyButton
framework
method before the page's control has been created to suppress
the standard Apply and Defaults buttons.
Constructor Summary | |
---|---|
protected |
PreferencePage()
Creates a new preference page with an empty title and no image. |
protected |
PreferencePage(String title)
Creates a new preference page with the given title and no image. |
protected |
PreferencePage(String title,
ImageDescriptor image)
Creates a new abstract preference page with the given title and image. |
Method Summary | |
---|---|
void |
applyData(Object data)
Apply the data to the receiver. |
Point |
computeSize()
Computes a size for this page's UI component. |
protected abstract Control |
createContents(Composite parent)
Creates and returns the SWT control for the customized body of this preference page under the given parent composite. |
void |
createControl(Composite parent)
The PreferencePage implementation of this
IDialogPage method creates a description label
and button bar for the page. |
void |
dispose()
The DialogPage implementation of an
IDialogPage method does nothing. |
protected IPreferenceStore |
doGetPreferenceStore()
Returns the preference store of this preference page. |
protected Button |
getApplyButton()
Returns the Apply button. |
IPreferencePageContainer |
getContainer()
Returns the container of this page. |
Control |
getControl()
Returns the top level control for this dialog page. |
protected Button |
getDefaultsButton()
Returns the Restore Defaults button. |
String |
getDescription()
|
Image |
getImage()
|
IPreferenceStore |
getPreferenceStore()
Returns the preference store of this preference page. |
String |
getTitle()
Returns this page's title. |
boolean |
isValid()
The preference page implementation of an IPreferencePage
method returns whether this preference page is valid. |
protected void |
noDefaultAndApplyButton()
Suppresses creation of the standard Default and Apply buttons for this page. |
boolean |
okToLeave()
The PreferencePage implementation of this
IPreferencePage method returns true
if the page is valid. |
protected void |
performApply()
Performs special processing when this page's Apply button has been pressed. |
boolean |
performCancel()
The preference page implementation of an IPreferencePage
method performs special processing when this page's Cancel button has
been pressed.
|
protected void |
performDefaults()
Performs special processing when this page's Defaults button has been pressed. |
boolean |
performOk()
Method declared on IPreferencePage. |
void |
setContainer(IPreferencePageContainer container)
(non-Javadoc) Method declared on IPreferencePage. |
void |
setDescription(String description)
|
void |
setImageDescriptor(ImageDescriptor desc)
Sets this page's image. |
void |
setPreferenceStore(IPreferenceStore store)
Sets the preference store for this preference page. |
void |
setSize(Point uiSize)
Sets the size of this page's UI component. |
void |
setTitle(String title)
The PreferencePage implementation of this IDialogPage
method extends the DialogPage implementation to update
the preference page container title. |
void |
setValid(boolean b)
Sets whether this page is valid. |
String |
toString()
Returns a string suitable for debugging purpose only. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
protected PreferencePage()
protected PreferencePage(String title)
title
- the title of this preference pageprotected PreferencePage(String title, ImageDescriptor image)
title
- the title of this preference pageimage
- the image for this preference page,
or null
if noneMethod Detail |
protected abstract Control createContents(Composite parent)
This framework method must be implemented by concrete subclasses. Any
subclass returning a Composite
object whose Layout
has default margins (for example, a GridLayout
) are expected to
set the margins of this Layout
to 0 pixels.
parent
- the parent composite
public void createControl(Composite parent)
PreferencePage
implementation of this
IDialogPage
method creates a description label
and button bar for the page. It calls createContents
to create the custom contents of the page.
If a subclass that overrides this method creates a Composite
that has a layout with default margins (for example, a GridLayout
)
it is expected to set the margins of this Layout
to 0 pixels.
parent
- parent of the new controlpublic Control getControl()
protected IPreferenceStore doGetPreferenceStore()
This is a framework hook method for subclasses to return a
page-specific preference store. The default implementation
returns null
.
null
if nonepublic IPreferencePageContainer getContainer()
null
if this
page has yet to be added to a containerpublic IPreferenceStore getPreferenceStore()
null
if nonepublic boolean isValid()
IPreferencePage
method returns whether this preference page is valid. Preference
pages are considered valid by default; call setValid(false)
to make a page invalid.
isValid
in interface IPreferencePage
true
if the page is in a valid state,
and false
if invalidprotected void noDefaultAndApplyButton()
Subclasses wishing a preference page wihthout these buttons should call this framework method before the page's control has been created.
public boolean okToLeave()
PreferencePage
implementation of this
IPreferencePage
method returns true
if the page is valid.
okToLeave
in interface IPreferencePage
false
to abort page flipping and the
have the current page remain visible, and true
to allow the page flipprotected void performApply()
This is a framework hook method for sublcasses to do special things when
the Apply button has been pressed.
The default implementation of this framework method simply calls
performOk
to simulate the pressing of the page's OK button.
performOk()
public boolean performCancel()
IPreferencePage
method performs special processing when this page's Cancel button has
been pressed.
This is a framework hook method for sublcasses to do special things when
the Cancel button has been pressed. The default implementation of this
framework method does nothing and returns true
.
performCancel
in interface IPreferencePage
false
to abort the container's cancel
procedure and true
to allow the cancel to happenprotected void performDefaults()
This is a framework hook method for subclasses to do special things when
the Defaults button has been pressed.
Subclasses may override, but should call super.performDefaults
.
public boolean performOk()
performOk
in interface IPreferencePage
false
to abort the container's OK
processing and true
to allow the OK to happenpublic void setContainer(IPreferencePageContainer container)
setContainer
in interface IPreferencePage
container
- the preference page container, or null
public void setPreferenceStore(IPreferenceStore store)
If preferenceStore is set to null, getPreferenceStore will invoke doGetPreferenceStore the next time it is called.
store
- the preference store, or null
getPreferenceStore()
public void setSize(Point uiSize)
IPreferencePage
setSize
in interface IPreferencePage
uiSize
- the size of the preference page encoded as
new Point(width,height)
public void setTitle(String title)
PreferencePage
implementation of this IDialogPage
method extends the DialogPage
implementation to update
the preference page container title. Subclasses may extend.
setTitle
in interface IPreferencePage
title
- the title of this dialog page,
or null
if nonepublic void setValid(boolean b)
b
- the new valid statepublic String toString()
protected Button getApplyButton()
protected Button getDefaultsButton()
public void applyData(Object data)
data
- public String getTitle()
IPreferencePage
getTitle
in interface IPreferencePage
null
if nonepublic Image getImage()
public void setImageDescriptor(ImageDescriptor desc)
IPreferencePage
setImageDescriptor
in interface IPreferencePage
desc
- the image for this dialog page,
or null
if nonepublic void dispose()
DialogPage
implementation of an
IDialogPage
method does nothing. Subclasses may extend.
dispose
in interface IPreferencePage
public Point computeSize()
IPreferencePage
computeSize
in interface IPreferencePage
new Point(width,height)
, or
(0,0)
if the page doesn't currently have any UI componentpublic void setDescription(String description)
public String getDescription()
|
Eclipse eRCP Release 1.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |