public abstract class AbstractVMInstallPage extends WizardPage
A VM install page is contributed via the vmInstallPages
extension
point. Following is an example definition of a VM install page.
<extension point="org.eclipse.jdt.debug.ui.vmInstallPages"> <vmInstallPage vmInstallType="org.eclipse.jdt.launching.EEVMType" class="org.eclipse.jdt.internal.debug.ui.jres.EEVMPage"> </vmInstallPage> </extension>The attributes are specified as follows:
vmInstallType
Specifies the VM install type this wizard page is to be used for.
Unique identifier corresponding to an IVMInstallType
's id.class
Wizard page implementation. Must be a subclass of
org.eclipse.jdt.debug.ui.launchConfigurations.AbstractVMInstallPage
.
Clients contributing a custom VM install page via the vmInstallPages
extension point must subclass this class.
ERROR, INFORMATION, NONE, WARNING
Modifier | Constructor and Description |
---|---|
protected |
AbstractVMInstallPage(String pageName)
Constructs a new page with the given page name.
|
protected |
AbstractVMInstallPage(String pageName,
String title,
ImageDescriptor titleImage)
Creates a new wizard page with the given name, title, and image.
|
Modifier and Type | Method and Description |
---|---|
abstract boolean |
finish()
Called when the VM install page wizard is closed by selecting
the finish button.
|
protected IStatus |
getNameStatus()
Returns the current status of the name being used for the VM.
|
IWizardPage |
getNextPage() |
abstract VMStandin |
getSelection()
Returns the edited or created VM install.
|
protected abstract IStatus[] |
getVMStatus()
Returns a collection of status messages pertaining to the current edit
status of the VM on this page.
|
protected void |
nameChanged(String newName)
Updates the name status based on the new name.
|
void |
setExistingNames(String[] names)
Sets the names of existing VMs, not including the VM being edited.
|
void |
setSelection(VMStandin vm)
Sets the VM install to be edited.
|
protected void |
setStatusMessage(IStatus status)
Sets this page's message based on the status severity.
|
protected void |
updatePageStatus()
Updates the status message on the page, based on the status of the VM and other
status provided by the page.
|
canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage, setVisible
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
createControl, dispose, getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp, setVisible
protected AbstractVMInstallPage(String pageName)
pageName
- the name of the pageprotected AbstractVMInstallPage(String pageName, String title, ImageDescriptor titleImage)
pageName
- the name of the pagetitle
- the title for this wizard page,
or null
if nonetitleImage
- the image descriptor for the title of this wizard page,
or null
if nonepublic abstract boolean finish()
true
, the wizard will close.public abstract VMStandin getSelection()
null
if no VM install exists.public void setSelection(VMStandin vm)
vm
- the VM install to editprotected void nameChanged(String newName)
newName
- new name of VMpublic void setExistingNames(String[] names)
names
- existing VM names or an empty arraypublic IWizardPage getNextPage()
getNextPage
in interface IWizardPage
getNextPage
in class WizardPage
protected void setStatusMessage(IStatus status)
status
- status with message and severityprotected IStatus getNameStatus()
protected void updatePageStatus()
protected abstract IStatus[] getVMStatus()
Copyright (c) 2000, 2015 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.