Package com.intellij.ui.wizard

Class WizardDialog<T extends WizardModel>

java.lang.Object

com.intellij.openapi.ui.DialogWrapper

com.intellij.ui.wizard.WizardDialog<T>

public class WizardDialog<T extends WizardModel>
extends DialogWrapper

Nested Class Summary

Nested classes/interfaces inherited from class com.intellij.openapi.ui.DialogWrapper

DialogWrapper.CancelAction, DialogWrapper.DialogStyle, DialogWrapper.DialogWrapperAction, DialogWrapper.DialogWrapperExitAction, DialogWrapper.DoNotAskOption, DialogWrapper.IdeModalityType, DialogWrapper.OkAction

Field Summary

Fields

Modifier and Type	Field and Description
static com.intellij.ui.wizard.WizardCallback	EMPTY
protected T	myModel

Fields inherited from class com.intellij.openapi.ui.DialogWrapper

CANCEL_EXIT_CODE, CLOSE_EXIT_CODE, DEFAULT_ACTION, DIALOG_CONTENT_PANEL_PROPERTY, ERROR_FOREGROUND_COLOR, FOCUSED_ACTION, IS_VISUAL_PADDING_COMPENSATED_ON_COMPONENT_LEVEL_KEY, myCancelAction, myCheckBoxDoNotShowDialog, myDisposable, myHelpAction, myOKAction, myPerformAction, myPreferredFocusedComponent, NEXT_USER_EXIT_CODE, OK_EXIT_CODE

Constructor Summary

Constructors

Constructor and Description
WizardDialog(boolean canBeParent, boolean tryApplicationModal, T model)
WizardDialog(boolean canBeParent, T model)
WizardDialog(java.awt.Component parent, boolean canBeParent, T model)
WizardDialog(Project project, boolean canBeParent, T model)

Method Summary

Modifier and Type	Method and Description
protected javax.swing.JComponent	createCenterPanel() Factory method.
protected javax.swing.JComponent	createSouthPanel() Creates panel located at the south of the content pane.
javax.swing.JComponent	getPreferredFocusedComponent()
protected java.awt.Dimension	getWindowPreferredSize()
protected void	init()
boolean	isWizardGoalAchieved()
void	onStepChanged()
void	onWizardGoalAchieved()
void	onWizardGoalDropped()

Methods inherited from class com.intellij.openapi.ui.DialogWrapper

addKeyListener, addMouseListener, addMouseListener, canRecordDialogId, centerRelativeToParent, cleanupRootPane, cleanupWindowListeners, clickDefaultButton, close, close, createActions, createButtonsPanel, createCancelAction, createContentPane, createContentPaneBorder, createDefaultActions, createDefaultBorder, createDoNotAskCheckbox, createHelpButton, createJButtonForAction, createJButtonForAction, createLeftSideActions, createNorthPanel, createPeer, createPeer, createPeer, createPeer, createPeer, createPeer, createRootLayout, createSouthAdditionalPanel, createTitlePane, dispose, disposeIfNeeded, doCancelAction, doCancelAction, doHelpAction, doOKAction, doValidate, doValidateAll, extractMnemonic, findInstance, findInstanceFromFocus, getButton, getCancelAction, getContentPane, getContentPanel, getDimensionKey, getDimensionServiceKey, getDisposable, getDoNotShowMessage, getErrorTextAlignment, getExitCode, getHelpAction, getHelpId, getHorizontalStretch, getInitialLocation, getLocation, getOKAction, getOwner, getPeer, getPreferredSize, getRootPane, getSize, getStyle, getTitle, getTypeAheadTimeoutMs, getValidationThreadToUse, getVerticalStretch, getWindow, hasErrors, initValidation, isAutoAdjustable, isCenterStrictedToPreferredSize, isDisposed, isModal, isModalProgress, isMoveHelpButtonLeft, isNorthStrictedToPreferredSize, isOK, isOKActionEnabled, isProgressDialog, isResizable, isShowing, isSouthStrictedToPreferredSize, isToDispatchTypeAhead, isTypeAheadEnabled, isVisible, layoutButtonsPanel, pack, postponeValidation, processDoNotAskOnOk, repaint, setAutoAdjustable, setButtonsAlignment, setButtonsMargin, setCancelButtonIcon, setCancelButtonText, setCrossClosesWindow, setDoNotAskOption, setErrorInfoAll, setErrorText, setErrorText, setHelpTooltip, setHorizontalStretch, setInitialLocationCallback, setLocation, setLocation, setModal, setOKActionEnabled, setOKButtonIcon, setOKButtonMnemonic, setOKButtonText, setOKButtonTooltip, setResizable, setSize, setTitle, setUndecorated, setValidationDelay, setVerticalStretch, shouldAddErrorNearButtons, shouldCloseOnCross, show, showAndGet, showAndGetOk, startTrackingValidation, toBack, toBeShown, toFront, unregisterKeyboardActions, updateErrorInfo, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

myModel

protected final T extends WizardModel myModel

EMPTY

public static final com.intellij.ui.wizard.WizardCallback EMPTY

Constructor Detail

WizardDialog

public WizardDialog(Project project,
                    boolean canBeParent,
                    T model)

WizardDialog

public WizardDialog(boolean canBeParent,
                    T model)

WizardDialog

public WizardDialog(boolean canBeParent,
                    boolean tryApplicationModal,
                    T model)

WizardDialog

public WizardDialog(java.awt.Component parent,
                    boolean canBeParent,
                    T model)

Method Detail

createCenterPanel

protected javax.swing.JComponent createCenterPanel()

Description copied from class: DialogWrapper

Factory method. It creates panel with dialog options. Options panel is located at the center of the dialog's content pane. The implementation can return null value. In this case there will be no options panel.

Specified by:

createCenterPanel in class DialogWrapper

init

protected void init()

Overrides:

init in class DialogWrapper

createSouthPanel

protected javax.swing.JComponent createSouthPanel()

Description copied from class: DialogWrapper

Creates panel located at the south of the content pane. By default that panel contains dialog's buttons. This default implementation uses createActions() and createJButtonForAction(Action) methods to construct the panel.

Overrides:

createSouthPanel in class DialogWrapper

Returns:

south panel

onStepChanged

public void onStepChanged()

onWizardGoalDropped

public void onWizardGoalDropped()

onWizardGoalAchieved

public void onWizardGoalAchieved()

isWizardGoalAchieved

public boolean isWizardGoalAchieved()

getWindowPreferredSize

protected java.awt.Dimension getWindowPreferredSize()

getPreferredFocusedComponent

public javax.swing.JComponent getPreferredFocusedComponent()

Overrides:

getPreferredFocusedComponent in class DialogWrapper

Returns:

component which should be focused when the dialog appears on the screen.