|
Eclipse eRCP Release 1.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An interface for a preference page. This interface is used primarily by the page's container
Method Summary | |
---|---|
Point |
computeSize()
Computes a size for this page's UI component. |
void |
dispose()
Disposes the SWT resources allocated by this page. |
String |
getTitle()
Returns this page's title. |
boolean |
isValid()
Returns whether this dialog page is in a valid state. |
boolean |
okToLeave()
Checks whether it is alright to leave this page. |
boolean |
performCancel()
Notifies that the container of this preference page has been canceled. |
boolean |
performOk()
Notifies that the OK button of this page's container has been pressed. |
void |
setContainer(IPreferencePageContainer preferencePageContainer)
Sets or clears the container of this page. |
void |
setImageDescriptor(ImageDescriptor image)
Sets this page's image. |
void |
setSize(Point size)
Sets the size of this page's UI component. |
void |
setTitle(String title)
Set this page's title. |
Method Detail |
public Point computeSize()
new Point(width,height)
, or
(0,0)
if the page doesn't currently have any UI componentpublic boolean isValid()
true
if the page is in a valid state,
and false
if invalidpublic boolean okToLeave()
false
to abort page flipping and the
have the current page remain visible, and true
to allow the page flippublic boolean performCancel()
false
to abort the container's cancel
procedure and true
to allow the cancel to happenpublic boolean performOk()
false
to abort the container's OK
processing and true
to allow the OK to happenpublic void setContainer(IPreferencePageContainer preferencePageContainer)
preferencePageContainer
- the preference page container, or null
public void setSize(Point size)
size
- the size of the preference page encoded as
new Point(width,height)
public void dispose()
public String getTitle()
null
if nonepublic void setImageDescriptor(ImageDescriptor image)
image
- the image for this dialog page,
or null
if nonepublic void setTitle(String title)
title
- the title of this dialog page,
or null
if none
|
Eclipse eRCP Release 1.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |