org.eclipse.wst.server.ui.wizard
Interface IWizardHandle

All Superinterfaces:

org.eclipse.jface.dialogs.IMessageProvider

public interface IWizardHandle

extends org.eclipse.jface.dialogs.IMessageProvider

Field Summary

Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider

ERROR, INFORMATION, NONE, WARNING

Method Summary

void	run(boolean fork, boolean cancelable, org.eclipse.jface.operation.IRunnableWithProgress runnable) Execute a runnable within the context of the wizard.
void	setDescription(java.lang.String desc) The page's description.
void	setImageDescriptor(org.eclipse.jface.resource.ImageDescriptor image) The page's image descriptor.
void	setMessage(java.lang.String newMessage, int newType) Set an error or warning message.
void	setTitle(java.lang.String title) Sets the title of this wizard page.
void	update() Updates the wizard error messages and buttons.

Methods inherited from interface org.eclipse.jface.dialogs.IMessageProvider

getMessage, getMessageType

Method Detail

update

public void update()

Updates the wizard error messages and buttons.

setTitle

public void setTitle(java.lang.String title)

Sets the title of this wizard page.

Parameters:

title - the title of the wizard page

setDescription

public void setDescription(java.lang.String desc)

The page's description.

Parameters:

desc - the page's description

setImageDescriptor

public void setImageDescriptor(org.eclipse.jface.resource.ImageDescriptor image)

The page's image descriptor.

Parameters:

image - the page's image descriptor

setMessage

public void setMessage(java.lang.String newMessage,
                       int newType)

Set an error or warning message.

Parameters:

newMessage - the new message

newType - the new type, from IStatus

run

public void run(boolean fork,
                boolean cancelable,
                org.eclipse.jface.operation.IRunnableWithProgress runnable)
         throws java.lang.InterruptedException,
                java.lang.reflect.InvocationTargetException

Execute a runnable within the context of the wizard. This will typically disable the wizard while the runnable is running, and provide a progress monitor for the user.

Parameters:

fork - true if a separate thread should be used

cancelable - true if it should be cancelable

runnable - the runnable

Throws:

java.lang.InterruptedException - thrown if it is interrupted

java.lang.reflect.InvocationTargetException - thrown if there is an error