io.sarl.apputils.eclipseextensions.sreinstall
Class AbstractSREInstallPage
All Superinterfaces:
org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.wizard.IWizardPage
abstract class AbstractSREInstallPage
extends java.lang.Object
Abstract implementation of a page for the SRE installation wizard.
Maven Group Identifier:
io.sarl.apputils
Maven Artifact Identifier:
eclipseextensions
Property Summary
Modifier and type Property and description
org.eclipse.jface.wizard.IWizardPage nextPage
Constructor Summary
Constructor and description
new(String)
Constructs a new page with the given page name.
new(String,String,ImageDescriptor)
Creates a new wizard page with the given name, title, and image.
Action Summary
Modifier and type Action and description
abstract ISREInstall createSelection(String)
Create a SRE install to be edited.
org.eclipse.jface.wizard.IWizardPage getNextPage
abstract void initialize(ISREInstall)
Sets the SRE install to be edited.
boolean performCancel
Called when the SRE install page wizard is closed by selecting the cancel button.
abstract boolean performFinish
Called when the SRE install page wizard is closed by selecting the finish button.
void setExistingNames(String*)
Sets the names of existing SREs, not including the SRE being edited.
protected void setPageStatus(IStatus)
Change the status associated to this page.
protected void updatePageStatus
Updates the status message on the page, based on the status of the SRE and other status provided by the page.
protected org.eclipse.core.runtime.IStatus validateNameAgainstOtherSREs(String)
Replies if the name of the SRE is valid against the names of the other SRE.
Property Details
nextPage
val nextPage : org.eclipse.jface.wizard.IWizardPage

This property is an alias for the action: getNextPage

Constructor Details
new(String)
protected new(String)
Constructs a new page with the given page name.
Parameters:
pageName - the name of the page.
new(String,String,ImageDescriptor)
protected new(String,String,ImageDescriptor)
Creates a new wizard page with the given name, title, and image.
Parameters:
pageName - the name of the page
title - the title for this wizard page, or null if none.
titleImage - the image descriptor for the title of this wizard page, or null if none.
Action Details
createSelection(String)
def createSelection(String) : ISREInstall
Create a SRE install to be edited.
Parameters:
id - the identifier of the new SRE.
Returns:
the created SRE.
getNextPage
def getNextPage : org.eclipse.jface.wizard.IWizardPage
initialize(ISREInstall)
def initialize(ISREInstall)
Sets the SRE install to be edited.
Parameters:
sre - the SRE install to edit
performCancel
def performCancel : boolean
Called when the SRE install page wizard is closed by selecting the cancel button.
Returns:
if the operation was successful. Only when returned true , the wizard will close.
performFinish
def performFinish : boolean
Called when the SRE install page wizard is closed by selecting the finish button. Implementers typically override this method to store the page result (new/changed SRE install returned in getSelection) into its model.
Returns:
if the operation was successful. Only when returned true , the wizard will close.
setExistingNames(String*)
def setExistingNames(String*)
Sets the names of existing SREs, not including the SRE being edited. This method is called by the wizard and clients should not call this method.
Parameters:
names - existing SRE names or an empty array.
setPageStatus(IStatus)
protected def setPageStatus(IStatus)
Change the status associated to this page. Any previous status is overrided by the given value.

You must call updatePageStatus() after invoking this methid.
Parameters:
status - the new status.
updatePageStatus
protected def updatePageStatus
Updates the status message on the page, based on the status of the SRE and other status provided by the page.
validateNameAgainstOtherSREs(String)
protected def validateNameAgainstOtherSREs(String) : org.eclipse.core.runtime.IStatus
Replies if the name of the SRE is valid against the names of the other SRE.
Parameters:
name - the name to validate.
Returns:
the validation status.