Class WizardPropertyPage
- All Implemented Interfaces:
IDialogPage,IMessageProvider,IPreferencePage,IWorkbenchPropertyPage
- Since:
- 3.4
-
Field Summary
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract voidApply the changes made on the property pageprotected ControlcreateContents(Composite parent) Creates and returns the SWT control for the customized body of this preference page under the given parent composite.protected abstract IWizardReturn a wizard.protected voidPerforms special processing when this page's Apply button has been pressed.booleanThe preference page implementation of anIPreferencePagemethod performs special processing when this page's Cancel button has been pressed.protected voidPerforms special processing when this page's Defaults button has been pressed.booleanNotifies that the OK button of this page's container has been pressed.Methods inherited from class org.eclipse.ui.dialogs.PropertyPage
getElement, setElementMethods inherited from class org.eclipse.jface.preference.PreferencePage
applyData, applyDialogFont, computeSize, contributeButtons, createControl, createDescriptionLabel, createNoteComposite, doComputeSize, doGetPreferenceStore, getApplyButton, getContainer, getDefaultsButton, getPreferenceStore, isValid, noDefaultAndApplyButton, noDefaultButton, okToLeave, performHelp, setContainer, setErrorMessage, setMessage, setPreferenceStore, setSize, setTitle, setValid, toString, updateApplyButtonMethods 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, setVisibleMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.eclipse.jface.dialogs.IDialogPage
createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisibleMethods inherited from interface org.eclipse.jface.preference.IPreferencePage
computeSize, isValid, okToLeave, setContainer, setSize
-
Constructor Details
-
WizardPropertyPage
public WizardPropertyPage()
-
-
Method Details
-
getWizard
- Returns:
- the wizard which is wrapped by this page or null if not yet created
-
createWizard
Return a wizard.- Returns:
- an instance of the wizard to be wrapped or null if creation failed
-
applyChanges
protected abstract void applyChanges()Apply the changes made on the property page -
createContents
Creates and returns the SWT control for the customized body of this preference page under the given parent composite.This framework method must be implemented by concrete subclasses. Any subclass returning a
Compositeobject whoseLayouthas default margins (for example, aGridLayout) is expected to set the margins of thisLayoutto 0 pixels.- Specified by:
createContentsin classPreferencePage- Parameters:
parent- the parent composite- Returns:
- the new control
-
performOk
public boolean performOk()Notifies that the OK button of this page's container has been pressed.- Specified by:
performOkin interfaceIPreferencePage- Overrides:
performOkin classPreferencePage- Returns:
falseto abort the container's OK processing andtrueto allow the OK to happen
-
performCancel
public boolean performCancel()The preference page implementation of anIPreferencePagemethod performs special processing when this page's Cancel button has been pressed.This is a framework hook method for subclasses to do special things when the Cancel button has been pressed. The default implementation of this framework method does nothing and returns
true.Note that UI guidelines on different platforms disagree on whether Cancel should revert changes that have been applied with the Apply button. Windows wants applied changes to persist on Cancel, whereas Mac and GTK consider Apply a preview that should not be saved on Cancel. Eclipse applications typically adhere to the Windows guidelines and just override
PreferencePage.performOk()and save preferences there.- Specified by:
performCancelin interfaceIPreferencePage- Overrides:
performCancelin classPreferencePage- Returns:
falseto abort the container's cancel procedure andtrueto allow the cancel to happen- See Also:
-
performApply
protected void performApply()Performs special processing when this page's Apply button has been pressed.This is a framework hook method for subclasses to do special things when the Apply button has been pressed. The default implementation of this framework method simply calls
performOkto simulate the pressing of the page's OK button.- Overrides:
performApplyin classPreferencePage- See Also:
-
performDefaults
protected void performDefaults()Performs special processing when this page's Defaults button has been pressed.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.- Overrides:
performDefaultsin classPreferencePage
-