org.openbp.cockpit.generator.wizard
Class WizardResultPage

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.openbp.swing.components.wizard.WizardPage
                      org.openbp.jaspira.gui.wizard.JaspiraWizardPage
                          org.openbp.jaspira.gui.wizard.JaspiraWizardResultPage
                              org.openbp.cockpit.generator.wizard.WizardResultPage

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.lang.Runnable, javax.accessibility.Accessible, WizardListener, WizardValidator

public class WizardResultPage
extends JaspiraWizardResultPage

The wizard result page performs the generation process while giving a visual feedback to the user. The output of the template-based generator is redirected to the console component of the dialog.

Author:

Heiko Erhardt

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static int	MODE_ERROR Mode: Generator errors
static int	MODE_RUN Mode: Generator running
static int	MODE_START Mode: Start panel displayed
static int	MODE_SUCCESS Mode: Generator successful

Fields inherited from class org.openbp.jaspira.gui.wizard.JaspiraWizardResultPage

progressPanel, textPanel

Fields inherited from class org.openbp.swing.components.wizard.WizardPage

canCancel, canFinish, canMoveBackward, canMoveForward

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

WizardResultPage(GeneratorWizard wizard)
Constructor.

Method Summary

javax.swing.JPanel	createModePanel() Creates a panel that contains the generator mode controls.
javax.swing.JPanel	createOutputDirPanel() Creates a panel that contains an output directory edit field.
GeneratorContext	getContext() Gets the generator context.
java.awt.Component	getFocusComponent() Returns the focus component of this plugin, i\.e\. the component that is to initially receive the focus.
Generator	getGenerator() Gets the currently selected generator.
GeneratorSettings	getGeneratorSettings() Gets the generator settings.
void	handleWizardEvent(WizardEvent event) Handles a wizard event caused by this wizard page.
protected void	postProcess(boolean success) Finishes the processing.
protected void	preProcess() Prepares for processing.
protected void	process() Performs the processing.
protected void	processException(java.lang.Throwable t) Processes an exception that was issued during pre processing, processing or post processing.

Methods inherited from class org.openbp.jaspira.gui.wizard.JaspiraWizardResultPage

getConsole, getProgressBar, getProgressCount, getProgressPanel, getProgressText, getTextArea, getTextPanel, internalUpdatePage, run, setProgressCount, setProgressText, setTextHeight, start, updatePage

Methods inherited from class org.openbp.jaspira.gui.wizard.JaspiraWizardPage

getContentPanel, getFramePanel

Methods inherited from class org.openbp.swing.components.wizard.WizardPage

canCancel, canFinish, canMoveBackward, canMoveForward, getBackgroundImage, getDataModel, getDescription, getSequenceManager, getTitle, getWizard, getWizardImage, setBackgroundImage, setDescription, setTitle, setWizard, setWizardImage, updateNavigator

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

MODE_START

public static final int MODE_START

Mode: Start panel displayed

See Also:

Constant Field Values

MODE_RUN

public static final int MODE_RUN

Mode: Generator running

See Also:

Constant Field Values

MODE_SUCCESS

public static final int MODE_SUCCESS

Mode: Generator successful

See Also:

Constant Field Values

MODE_ERROR

public static final int MODE_ERROR

Mode: Generator errors

See Also:

Constant Field Values

Constructor Detail

WizardResultPage

public WizardResultPage(GeneratorWizard wizard)

Constructor.

Parameters:

wizard - Wizard that owns the page

Method Detail

createOutputDirPanel

public javax.swing.JPanel createOutputDirPanel()

Creates a panel that contains an output directory edit field. The default value of the edit field is the model directory. The output directory will be stored in the context (GeneratorContext) of the wizard.

Returns:

The output directory panel

createModePanel

public javax.swing.JPanel createModePanel()

Creates a panel that contains the generator mode controls. By default, this is the merge/overwrite combo box. The overwrite mode will be stored in the context (GeneratorContext) of the wizard.

Returns:

The mode panel

getFocusComponent

public java.awt.Component getFocusComponent()

Returns the focus component of this plugin, i\.e\. the component that is to initially receive the focus.

Overrides:

getFocusComponent in class JaspiraWizardPage

Returns:

The return value defaults to the this page

preProcess

protected void preProcess()
                   throws java.lang.Exception

Prepares for processing. This method is called before the process() method is invoked.

Specified by:

preProcess in class JaspiraWizardResultPage

Throws:

java.lang.Exception

process

protected void process()
                throws java.lang.Exception

Performs the processing. This method is called from inside the Swing worker thread to perform the processing.

Specified by:

process in class JaspiraWizardResultPage

Throws:

java.lang.Exception

postProcess

protected void postProcess(boolean success)
                    throws java.lang.Exception

Finishes the processing. This method is called after the process() method has terminated.

Specified by:

postProcess in class JaspiraWizardResultPage

Parameters:

success - Parameter indicating success or failure of the process

Throws:

java.lang.Exception

processException

protected void processException(java.lang.Throwable t)

Processes an exception that was issued during pre processing, processing or post processing. Default behaviour is to show a popup dialog that displays the exception message.

Overrides:

processException in class JaspiraWizardResultPage

Parameters:

t - Exception to handle

handleWizardEvent

public void handleWizardEvent(WizardEvent event)

Handles a wizard event caused by this wizard page.

Specified by:

handleWizardEvent in interface WizardListener

Overrides:

handleWizardEvent in class JaspiraWizardResultPage

Parameters:

event - Event to handle

getContext

public GeneratorContext getContext()

Gets the generator context.

getGenerator

public Generator getGenerator()

Gets the currently selected generator.

Returns:

The generator or null if no generator has been selected yet

getGeneratorSettings

public GeneratorSettings getGeneratorSettings()

Gets the generator settings.