Overview  Package    Class   Use  Tree  Deprecated  Index  Help		RSE Release 3.0
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR |  METHOD	DETAIL: FIELD | CONSTR |  METHOD

---

org.eclipse.rse.ui.wizards
Interface ISystemWizard

All Superinterfaces:

INewWizard, ISystemPromptDialog, IWizard, IWorkbenchWizard

All Known Subinterfaces:

ISystemFilterWizard, SystemFilterPoolWizardInterface

All Known Implementing Classes:

AbstractSystemWizard, SystemNewFilterWizard, SystemNewProfileWizard

---

public interface ISystemWizard
extends 
INewWizard, 
ISystemPromptDialog

Suggested interface for wizards launchable via remote system explorer.

---

Method Summary
String	getHelpContextId ()           Return the help Id as set in setHelp(String)
int	getMinimumPageHeight ()
int	getMinimumPageWidth ()
SystemWizardDialog	getSystemWizardDialog ()           Return the result of setSystemWizardDialog
Viewer	getViewer ()           Get the Viewer that called this wizard.
String	getWizardPageTitle ()           Return the page title as set via setWizardPageTitle
void	setHelp ( String id)           Set the help context Id (infoPop) for this wizard.
void	setMinimumPageSize (int width, int height)           Get current selection of viewer, at time wizard launched, as set by setSelection(IStructuredSelection selection)
void	setSystemWizardDialog ( SystemWizardDialog dlg)           Called from SystemWizardDialog when it is used as the hosting dialog
void	setViewer ( Viewer v)           Set the Viewer that called this wizard.
void	setWizardPageTitle ( String pageTitle)           Set the wizard page title.
void	updateSize ()           Exposes this nice new 2.0 capability to the public.

 

Methods inherited from interface org.eclipse.ui. IWorkbenchWizard
init

 

Methods inherited from interface org.eclipse.jface.wizard. IWizard
addPages, canFinish, createPageControls, dispose, getContainer, getDefaultPageImage, getDialogSettings, getNextPage, getPage, getPageCount, getPages, getPreviousPage, getStartingPage, getTitleBarColor, getWindowTitle, isHelpAvailable, needsPreviousAndNextButtons, needsProgressMonitor, performCancel, performFinish, setContainer

 

Methods inherited from interface org.eclipse.rse.ui.dialogs. ISystemPromptDialog
getInputObject, getOutputObject, publicConvertHeightInCharsToPixels, publicConvertWidthInCharsToPixels, setInputObject, setOutputObject, wasCancelled

 

Method Detail

setMinimumPageSize

void setMinimumPageSize(int width,
                        int height)

Get current selection of viewer, at time wizard launched, as set by setSelection(IStructuredSelection selection)

---

getMinimumPageWidth

int getMinimumPageWidth()

---

getMinimumPageHeight

int getMinimumPageHeight()

---

setHelp

void setHelp(
String id)

Set the help context Id (infoPop) for this wizard. This must be fully qualified by plugin ID.

Same as #setHelp(String)

See Also:

#getHelpContextId()

---

getHelpContextId

String getHelpContextId()

Return the help Id as set in setHelp(String)

---

setViewer

void setViewer(
Viewer v)

Set the Viewer that called this wizard. It is good practice for actions to call this so wizard can directly access the originating viewer if needed.

---

getViewer

Viewer getViewer()

Get the Viewer that called this wizard. This will be null unless set by the action that started this wizard.

---

setWizardPageTitle

void setWizardPageTitle(
String pageTitle)

Set the wizard page title. Using this makes it possible to avoid subclassing. The page title goes below the wizard title, and can be unique per page. However, typically the wizard page title is the same for all pages... eg "Filter".

This is not used by default, but can be queried via getPageTitle() when constructing pages.

---

getWizardPageTitle

String getWizardPageTitle()

Return the page title as set via setWizardPageTitle

---

setSystemWizardDialog

void setSystemWizardDialog(
SystemWizardDialog dlg)

Called from SystemWizardDialog when it is used as the hosting dialog

---

getSystemWizardDialog

SystemWizardDialog getSystemWizardDialog()

Return the result of setSystemWizardDialog

---

updateSize

void updateSize()

Exposes this nice new 2.0 capability to the public. Only does anything if being hosted by SystemWizardDialog.

---

Overview  Package    Class   Use  Tree  Deprecated  Index  Help		RSE Release 3.0
PREV CLASS    NEXT CLASS	NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR |  METHOD	DETAIL: FIELD | CONSTR |  METHOD

---

Copyright (c) IBM Corporation and others 2000, 2008. All Rights Reserved.