| javax.swing.JComponent javax.swing.JPanel org.pietschy.wizard.Wizard
Method Summary | |
public void | addWizardListener(WizardListener l) Adds a
WizardListener to this wizard. | public void | cancel() Cancels this wizard. | public void | close() Closes this wizard. | protected boolean | confirmAbort() This method is called when the user cancels the wizard while the
Wizard.activeStep is
WizardStep.isBusy busy . | protected ButtonBar | createButtonBar() Called by the constructor to create the button bar. | protected JComponent | createTitleComponent() Called by the constructor to create the wizards title component. | public Action | getCancelAction() Returns the action that is bound to the cancel button. | public Action | getCloseAction() Returns the action that is bound to the close button. | public int | getDefaultExitMode() | public Action | getFinishAction() Returns the action that is bound to the showCloseButton button. | public Action | getHelpAction() Returns the action that is bound to the close button. | public HelpBroker | getHelpBroker() | public Action | getLastAction() Returns the action that is bound to the last button. | public WizardModel | getModel() Gets the models this wizard is using. | public Action | getNextAction() Returns the action that is bound to the next button. | public Action | getPreviousAction() Returns the action that is bound to the previous button. | public JComponent | getTitleComponent() Gets the component being used to render the wizards title. | public boolean | isOverviewVisible() Checks the visibily of the overview panel that is displayed on the wizards left
panel. | protected boolean | isResizable() Checks the ability of the wizard to be resized. | public void | removeWizardListener(WizardListener l) Removes a
WizardListener from this wizard. | public void | reset() Resets the wizard. | public void | setDefaultExitMode(int defaultExitMode) Set the time when the wizard exits. | public void | setHelpBroker(HelpBroker broker) | public void | setOverviewVisible(boolean overviewVisible) Configures the visibily of the overview panel that is displayed on the wizards left
panel. | protected void | showCloseButton() Marks this wizard as finished. | public void | showInDialog(String title, Component parent, boolean modal) Displays the wizard in a new
JDialog with the specified title. | public void | showInFrame(String title) Displays the wizard in a new
JFrame with the specified title. | public void | showInFrame(String title, Image windowIcon) Displays the wizard in a new
JFrame with the specified title. | public void | showInFrame(String title, Component relativeTo) Displays the wizard in a new
JFrame with the specified title. | public void | showInFrame(String title, Image windowIcon, Component relativeTo) Displays the wizard in a new
JFrame with the specified title. | public void | showInInternalFrame(String title, Icon frameIcon, JDesktopPane desktopPane) Displays the wizard in a new
JFrame with the specified title. | public void | showInInternalFrame(String title, Icon frameIcon, boolean resizable, boolean closable, boolean maximizable, boolean iconifiable, JDesktopPane desktopPane) Displays the wizard in a new
JFrame with the specified title. | public boolean | wasCanceled() Checks if the wizard was canceled. |
BORDER_WIDTH | final protected static int BORDER_WIDTH(Code) | | |
EXIT_ON_CLOSE | final public static int EXIT_ON_CLOSE(Code) | | When specified as the
Wizard.setDefaultExitMode(int) defaultExitMode , this
causes the wizard to continue displaying the final step after finished has been pressed. The
wizard is closed when the user presses the close button. This allows the wizard to display a
final confirmation screen.
See Also: Wizard.EXIT_ON_FINISH |
Wizard | public Wizard(WizardModel model)(Code) | | Creates a new Wizard that uses the specified
WizardModel .
Parameters: model - the model that the wizard is to use. |
confirmAbort | protected boolean confirmAbort()(Code) | | This method is called when the user cancels the wizard while the
Wizard.activeStep is
WizardStep.isBusy busy . This method displays a
JOptionPane asking if the
user wants to abort the wizard.
true if the user confirms the abort, false otherwise. |
createButtonBar | protected ButtonBar createButtonBar()(Code) | | Called by the constructor to create the button bar. Subclasses may override to provide a custom
ButtonBar implementation.
the wizards ButtonBar. |
createTitleComponent | protected JComponent createTitleComponent()(Code) | | Called by the constructor to create the wizards title component. The default component will be an instance of
DefaultTitleComponent but subclasses may override to provide a custom implementation. Typically the
title component listens to the wizard model and updates its appearance accordingly.
the wizards title component. See Also: Wizard.getTitleComponent() |
getCancelAction | public Action getCancelAction()(Code) | | Returns the action that is bound to the cancel button.
|
getCloseAction | public Action getCloseAction()(Code) | | Returns the action that is bound to the close button.
|
getFinishAction | public Action getFinishAction()(Code) | | Returns the action that is bound to the showCloseButton button.
|
getHelpAction | public Action getHelpAction()(Code) | | Returns the action that is bound to the close button.
|
getLastAction | public Action getLastAction()(Code) | | Returns the action that is bound to the last button.
|
getModel | public WizardModel getModel()(Code) | | Gets the models this wizard is using.
the wizard models. |
getNextAction | public Action getNextAction()(Code) | | Returns the action that is bound to the next button.
|
getPreviousAction | public Action getPreviousAction()(Code) | | Returns the action that is bound to the previous button.
|
getTitleComponent | public JComponent getTitleComponent()(Code) | | Gets the component being used to render the wizards title. By default this will be an instance of
DefaultTitleComponent . Subclasses can change the default by overriding
Wizard.createTitleComponent() .
For example, to activate the gradient background on the default title component you can call.
((DefaultTitleComponent) wizard.getTitleComponent()).setGradientBackground(true);
the wizards title component. |
isOverviewVisible | public boolean isOverviewVisible()(Code) | | Checks the visibily of the overview panel that is displayed on the wizards left
panel. The overview panel will only be displayed if this property is true and
the current
WizardModel implements
OverviewProvider .
|
isResizable | protected boolean isResizable()(Code) | | Checks the ability of the wizard to be resized. The wizard is resizable if
this method returns true, otherwise it cannot be resized.
|
setOverviewVisible | public void setOverviewVisible(boolean overviewVisible)(Code) | | Configures the visibily of the overview panel that is displayed on the wizards left
panel. This method will only have an effect if the current
WizardModel implements
OverviewProvider .
Parameters: overviewVisible - true to display the overview, false otherwise. |
showCloseButton | protected void showCloseButton()(Code) | | Marks this wizard as finished. This will cause the button bar to only display
the close button.
|
showInDialog | public void showInDialog(String title, Component parent, boolean modal)(Code) | | Displays the wizard in a new
JDialog with the specified title. The dialog will
be automatically closed when the wizard is completed or canceled. This method will
block if the dialog is modal.
Parameters: title - the dialog title. Parameters: parent - the component that will own the dialog. Parameters: modal - true to make the dialog modal, false otherwise. See Also: Wizard.addWizardListener See Also: Wizard.removeWizardListener |
showInInternalFrame | public void showInInternalFrame(String title, Icon frameIcon, JDesktopPane desktopPane)(Code) | | Displays the wizard in a new
JFrame with the specified title. The frame will
be automatically closed when the wizard is completed or canceled. This method will
not block.
Parameters: title - the title of the frame. Parameters: desktopPane - the desktop in which to display the wizard. See Also: Wizard.addWizardListener See Also: Wizard.removeWizardListener |
showInInternalFrame | public void showInInternalFrame(String title, Icon frameIcon, boolean resizable, boolean closable, boolean maximizable, boolean iconifiable, JDesktopPane desktopPane)(Code) | | Displays the wizard in a new
JFrame with the specified title. The frame will
be automatically closed when the wizard is completed or canceled. This method will
not block.
Parameters: title - the title of the frame. Parameters: resizable - if true , the internal frame can be resized Parameters: closable - if true , the internal frame can be closed Parameters: maximizable - if true , the internal frame can be maximised Parameters: iconifiable - if true , the internal frame can be iconified Parameters: desktopPane - the desktop in which to display the wizard. See Also: Wizard.addWizardListener See Also: Wizard.removeWizardListener |
wasCanceled | public boolean wasCanceled()(Code) | | Checks if the wizard was canceled. This method will return false unless the user
canceled the wizard.
true if the user canceled the wizard, false otherwise. |
Methods inherited from javax.swing.JComponent | public void addAncestorListener(AncestorListener listener)(Code)(Java Doc) public void addNotify()(Code)(Java Doc) public synchronized void addVetoableChangeListener(VetoableChangeListener listener)(Code)(Java Doc) public void computeVisibleRect(Rectangle visibleRect)(Code)(Java Doc) public boolean contains(int x, int y)(Code)(Java Doc) public JToolTip createToolTip()(Code)(Java Doc) public void disable()(Code)(Java Doc) public void enable()(Code)(Java Doc) public void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)(Code)(Java Doc) public void firePropertyChange(String propertyName, int oldValue, int newValue)(Code)(Java Doc) public void firePropertyChange(String propertyName, char oldValue, char newValue)(Code)(Java Doc) protected void fireVetoableChange(String propertyName, Object oldValue, Object newValue) throws java.beans.PropertyVetoException(Code)(Java Doc) public AccessibleContext getAccessibleContext()(Code)(Java Doc) public ActionListener getActionForKeyStroke(KeyStroke aKeyStroke)(Code)(Java Doc) final public ActionMap getActionMap()(Code)(Java Doc) public float getAlignmentX()(Code)(Java Doc) public float getAlignmentY()(Code)(Java Doc) public AncestorListener[] getAncestorListeners()(Code)(Java Doc) public boolean getAutoscrolls()(Code)(Java Doc) public int getBaseline(int width, int height)(Code)(Java Doc) public BaselineResizeBehavior getBaselineResizeBehavior()(Code)(Java Doc) public Border getBorder()(Code)(Java Doc) public Rectangle getBounds(Rectangle rv)(Code)(Java Doc) final public Object getClientProperty(Object key)(Code)(Java Doc) protected Graphics getComponentGraphics(Graphics g)(Code)(Java Doc) public JPopupMenu getComponentPopupMenu()(Code)(Java Doc) public int getConditionForKeyStroke(KeyStroke aKeyStroke)(Code)(Java Doc) public int getDebugGraphicsOptions()(Code)(Java Doc) public static Locale getDefaultLocale()(Code)(Java Doc) public FontMetrics getFontMetrics(Font font)(Code)(Java Doc) public Graphics getGraphics()(Code)(Java Doc) public int getHeight()(Code)(Java Doc) public boolean getInheritsPopupMenu()(Code)(Java Doc) final public InputMap getInputMap(int condition)(Code)(Java Doc) final public InputMap getInputMap()(Code)(Java Doc) public InputVerifier getInputVerifier()(Code)(Java Doc) public Insets getInsets()(Code)(Java Doc) public Insets getInsets(Insets insets)(Code)(Java Doc) public T[] getListeners(Class<T> listenerType)(Code)(Java Doc) public Point getLocation(Point rv)(Code)(Java Doc) public Dimension getMaximumSize()(Code)(Java Doc) public Dimension getMinimumSize()(Code)(Java Doc) public Component getNextFocusableComponent()(Code)(Java Doc) public Point getPopupLocation(MouseEvent event)(Code)(Java Doc) public Dimension getPreferredSize()(Code)(Java Doc) public KeyStroke[] getRegisteredKeyStrokes()(Code)(Java Doc) public JRootPane getRootPane()(Code)(Java Doc) public Dimension getSize(Dimension rv)(Code)(Java Doc) public Point getToolTipLocation(MouseEvent event)(Code)(Java Doc) public String getToolTipText()(Code)(Java Doc) public String getToolTipText(MouseEvent event)(Code)(Java Doc) public Container getTopLevelAncestor()(Code)(Java Doc) public TransferHandler getTransferHandler()(Code)(Java Doc) public String getUIClassID()(Code)(Java Doc) public boolean getVerifyInputWhenFocusTarget()(Code)(Java Doc) public synchronized VetoableChangeListener[] getVetoableChangeListeners()(Code)(Java Doc) public Rectangle getVisibleRect()(Code)(Java Doc) public int getWidth()(Code)(Java Doc) public int getX()(Code)(Java Doc) public int getY()(Code)(Java Doc) public void grabFocus()(Code)(Java Doc) public boolean isDoubleBuffered()(Code)(Java Doc) public static boolean isLightweightComponent(Component c)(Code)(Java Doc) public boolean isManagingFocus()(Code)(Java Doc) public boolean isOpaque()(Code)(Java Doc) public boolean isOptimizedDrawingEnabled()(Code)(Java Doc) final public boolean isPaintingForPrint()(Code)(Java Doc) public boolean isPaintingTile()(Code)(Java Doc) public boolean isRequestFocusEnabled()(Code)(Java Doc) public boolean isValidateRoot()(Code)(Java Doc) public void paint(Graphics g)(Code)(Java Doc) protected void paintBorder(Graphics g)(Code)(Java Doc) protected void paintChildren(Graphics g)(Code)(Java Doc) protected void paintComponent(Graphics g)(Code)(Java Doc) public void paintImmediately(int x, int y, int w, int h)(Code)(Java Doc) public void paintImmediately(Rectangle r)(Code)(Java Doc) protected String paramString()(Code)(Java Doc) public void print(Graphics g)(Code)(Java Doc) public void printAll(Graphics g)(Code)(Java Doc) protected void printBorder(Graphics g)(Code)(Java Doc) protected void printChildren(Graphics g)(Code)(Java Doc) protected void printComponent(Graphics g)(Code)(Java Doc) protected void processComponentKeyEvent(KeyEvent e)(Code)(Java Doc) protected boolean processKeyBinding(KeyStroke ks, KeyEvent e, int condition, boolean pressed)(Code)(Java Doc) protected void processKeyEvent(KeyEvent e)(Code)(Java Doc) protected void processMouseEvent(MouseEvent e)(Code)(Java Doc) protected void processMouseMotionEvent(MouseEvent e)(Code)(Java Doc) final public void putClientProperty(Object key, Object value)(Code)(Java Doc) public void registerKeyboardAction(ActionListener anAction, String aCommand, KeyStroke aKeyStroke, int aCondition)(Code)(Java Doc) public void registerKeyboardAction(ActionListener anAction, KeyStroke aKeyStroke, int aCondition)(Code)(Java Doc) public void removeAncestorListener(AncestorListener listener)(Code)(Java Doc) public void removeNotify()(Code)(Java Doc) public synchronized void removeVetoableChangeListener(VetoableChangeListener listener)(Code)(Java Doc) public void repaint(long tm, int x, int y, int width, int height)(Code)(Java Doc) public void repaint(Rectangle r)(Code)(Java Doc) public boolean requestDefaultFocus()(Code)(Java Doc) public void requestFocus()(Code)(Java Doc) public boolean requestFocus(boolean temporary)(Code)(Java Doc) public boolean requestFocusInWindow()(Code)(Java Doc) protected boolean requestFocusInWindow(boolean temporary)(Code)(Java Doc) public void resetKeyboardActions()(Code)(Java Doc) public void reshape(int x, int y, int w, int h)(Code)(Java Doc) public void revalidate()(Code)(Java Doc) public void scrollRectToVisible(Rectangle aRect)(Code)(Java Doc) final public void setActionMap(ActionMap am)(Code)(Java Doc) public void setAlignmentX(float alignmentX)(Code)(Java Doc) public void setAlignmentY(float alignmentY)(Code)(Java Doc) public void setAutoscrolls(boolean autoscrolls)(Code)(Java Doc) public void setBackground(Color bg)(Code)(Java Doc) public void setBorder(Border border)(Code)(Java Doc) public void setComponentPopupMenu(JPopupMenu popup)(Code)(Java Doc) public void setDebugGraphicsOptions(int debugOptions)(Code)(Java Doc) public static void setDefaultLocale(Locale l)(Code)(Java Doc) public void setDoubleBuffered(boolean aFlag)(Code)(Java Doc) public void setEnabled(boolean enabled)(Code)(Java Doc) public void setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes)(Code)(Java Doc) public void setFont(Font font)(Code)(Java Doc) public void setForeground(Color fg)(Code)(Java Doc) public void setInheritsPopupMenu(boolean value)(Code)(Java Doc) final public void setInputMap(int condition, InputMap map)(Code)(Java Doc) public void setInputVerifier(InputVerifier inputVerifier)(Code)(Java Doc) public void setMaximumSize(Dimension maximumSize)(Code)(Java Doc) public void setMinimumSize(Dimension minimumSize)(Code)(Java Doc) public void setNextFocusableComponent(Component aComponent)(Code)(Java Doc) public void setOpaque(boolean isOpaque)(Code)(Java Doc) public void setPreferredSize(Dimension preferredSize)(Code)(Java Doc) public void setRequestFocusEnabled(boolean requestFocusEnabled)(Code)(Java Doc) public void setToolTipText(String text)(Code)(Java Doc) public void setTransferHandler(TransferHandler newHandler)(Code)(Java Doc) protected void setUI(ComponentUI newUI)(Code)(Java Doc) public void setVerifyInputWhenFocusTarget(boolean verifyInputWhenFocusTarget)(Code)(Java Doc) public void setVisible(boolean aFlag)(Code)(Java Doc) public void unregisterKeyboardAction(KeyStroke aKeyStroke)(Code)(Java Doc) public void update(Graphics g)(Code)(Java Doc) public void updateUI()(Code)(Java Doc)
|
|
|