Package org.eclipse.jface.preference
Interface IPreferencePage
- All Superinterfaces:
IDialogPage
- All Known Subinterfaces:
ISearchScopePage,IWorkbenchPreferencePage,IWorkbenchPropertyPage,IWorkbenchPropertyPageMulti
- All Known Implementing Classes:
ActivitiesPreferencePage,ActivityCategoryPreferencePage,ComparePreferencePage,FieldEditorPreferencePage,PreferencePage,PropertyPage,RepositoryManipulationPage,RootScopePage,TemplatePreferencePage,TextEditorPreferencePage,WizardPropertyPage
An interface for a preference page. This interface
is used primarily by the page's container
-
Method Summary
Modifier and TypeMethodDescriptionComputes a size for this page's UI component.booleanisValid()Returns whether this dialog page is in a valid state.booleanChecks whether it is alright to leave this page.booleanNotifies that the container of this preference page has been canceled.booleanNotifies that the OK button of this page's container has been pressed.voidsetContainer(IPreferencePageContainer preferencePageContainer) Sets or clears the container of this page.voidSets the size of this page's UI component.Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage
createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible
-
Method Details
-
computeSize
Point computeSize()Computes a size for this page's UI component.- Returns:
- the size of the preference page encoded as
new Point(width,height), or(0,0)if the page doesn't currently have any UI component
-
isValid
boolean isValid()Returns whether this dialog page is in a valid state.- Returns:
trueif the page is in a valid state, andfalseif invalid
-
okToLeave
boolean okToLeave()Checks whether it is alright to leave this page.- Returns:
falseto abort page flipping and the have the current page remain visible, andtrueto allow the page flip
-
performCancel
boolean performCancel()Notifies that the container of this preference page has been canceled.- Returns:
falseto abort the container's cancel procedure andtrueto allow the cancel to happen
-
performOk
boolean performOk()Notifies that the OK button of this page's container has been pressed.- Returns:
falseto abort the container's OK processing andtrueto allow the OK to happen
-
setContainer
Sets or clears the container of this page.- Parameters:
preferencePageContainer- the preference page container, ornull
-
setSize
Sets the size of this page's UI component.- Parameters:
size- the size of the preference page encoded asnew Point(width,height)
-