|
Eclipse JDT Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.dialogs.DialogPage
org.eclipse.jface.wizard.WizardPage
org.eclipse.jdt.debug.ui.launchConfigurations.AbstractVMInstallPage
public abstract class AbstractVMInstallPage
A wizard page used to edit the attributes of an installed JRE. A page is provided by JDT to edit standard JREs, but clients may contribute a custom page for a VM install type if required.
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.
| Field Summary |
|---|
| Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider |
|---|
ERROR, INFORMATION, NONE, WARNING |
| Constructor Summary | |
|---|---|
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. |
| Method Summary | |
|---|---|
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. |
| Methods inherited from class org.eclipse.jface.wizard.WizardPage |
|---|
canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setErrorMessage, setImageDescriptor, setMessage, setPageComplete, setPreviousPage, setTitle, setWizard, toString |
| Methods inherited from class org.eclipse.jface.dialogs.DialogPage |
|---|
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl, setMessage, setVisible |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage |
|---|
createControl, dispose, getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp, setVisible |
| Constructor Detail |
|---|
protected AbstractVMInstallPage(String pageName)
pageName - the name of the page
protected 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 none| Method Detail |
|---|
public 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 IWizardPagegetNextPage in class WizardPageprotected void setStatusMessage(IStatus status)
status - status with message and severityprotected IStatus getNameStatus()
protected void updatePageStatus()
protected abstract IStatus[] getVMStatus()
|
Eclipse JDT Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) 2000, 2010 IBM Corporation and others. All rights reserved.