org.cagrid.installer.steps
Class AbstractPropertiesFileEditorStep

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.pietschy.wizard.PanelWizardStep
                      org.cagrid.installer.steps.AbstractPropertiesFileEditorStep

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, Condition, WizardStep

Direct Known Subclasses:

DeployPropertiesFileEditorStep, IntroduceServicePropertiesFileEditorStep

public abstract class AbstractPropertiesFileEditorStep
extends PanelWizardStep
implements Condition

Author:

Joshua Phillips

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.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected CaGridInstallerModel

model

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 org.pietschy.wizard.WizardStep

_ID_

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

AbstractPropertiesFileEditorStep()

AbstractPropertiesFileEditorStep(java.lang.String name, java.lang.String summary, java.lang.String propertyNameColumnName, java.lang.String propertyValueColumnValue)

AbstractPropertiesFileEditorStep(java.lang.String name, java.lang.String summary, java.lang.String propertyNameColumnName, java.lang.String propertyValueColumnValue, javax.swing.Icon icon)

Method Summary

void	applyState() This method is called whenever the user presses next while this step is active.
protected void	checkComplete()
boolean	evaluate(WizardModel m) Called to determine when the path being added using BranchingPath.addBranch(org.pietschy.wizard.models.Path, org.pietschy.wizard.models.Condition) should be traversed.
protected abstract java.lang.String	getPropertyFilePath()
void	init(WizardModel m) Called to initialize the step.
protected java.util.Properties	loadProperties()
void	prepare() Called to prepare this step to display.
protected void	storeProperties(java.util.Properties props)

Methods inherited from class org.pietschy.wizard.PanelWizardStep

abortBusy, getIcon, getSummary, getView, isBusy, isComplete, setBusy, setComplete, setIcon, setSummary

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, 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, 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

Methods inherited from interface org.pietschy.wizard.WizardStep

addPropertyChangeListener, addPropertyChangeListener, getName, getPreferredSize, removePropertyChangeListener, removePropertyChangeListener

Field Detail

model

protected CaGridInstallerModel model

Constructor Detail

AbstractPropertiesFileEditorStep

public AbstractPropertiesFileEditorStep()

AbstractPropertiesFileEditorStep

public AbstractPropertiesFileEditorStep(java.lang.String name,
                                        java.lang.String summary,
                                        java.lang.String propertyNameColumnName,
                                        java.lang.String propertyValueColumnValue)

Parameters:

arg0 -

arg1 -

AbstractPropertiesFileEditorStep

public AbstractPropertiesFileEditorStep(java.lang.String name,
                                        java.lang.String summary,
                                        java.lang.String propertyNameColumnName,
                                        java.lang.String propertyValueColumnValue,
                                        javax.swing.Icon icon)

Parameters:

arg0 -

arg1 -

arg2 -

Method Detail

init

public void init(WizardModel m)

Description copied from class: PanelWizardStep

Called to initialize the step. This method will be called when the wizard is first initialising.

Specified by:

init in interface WizardStep

Overrides:

init in class PanelWizardStep

Parameters:

m - the model to which the step belongs.

prepare

public void prepare()

Description copied from class: PanelWizardStep

Called to prepare this step to display. Subclasses should query the model and configure their view appropriately.

This method will be called whenever the step is to be displayed, regardless of whether the user pressed next or previous.

Specified by:

prepare in interface WizardStep

Overrides:

prepare in class PanelWizardStep

checkComplete

protected void checkComplete()

getPropertyFilePath

protected abstract java.lang.String getPropertyFilePath()

applyState

public void applyState()
                throws InvalidStateException

Description copied from class: PanelWizardStep

This method is called whenever the user presses next while this step is active.

If this method will take a long time to complete, subclasses should consider executing the work and a separate thread and displaying some kind of progress indicator.

This method will only be called if WizardModel.isNextAvailable() and PanelWizardStep.isComplete() return true.

Specified by:

applyState in interface WizardStep

Overrides:

applyState in class PanelWizardStep

Throws:

InvalidStateException - if an error occurs and the wizard can't progress to the next step. By default the message of this exception will be displayed to the user. If you wish to prevent this behaviour please ensure InvalidStateException.setShowUser(boolean) is called with a value of false.

evaluate

public boolean evaluate(WizardModel m)

Description copied from interface: Condition

Called to determine when the path being added using BranchingPath.addBranch(org.pietschy.wizard.models.Path, org.pietschy.wizard.models.Condition) should be traversed. The selector is passed the current WizardModel to assist with the decision.

Specified by:

evaluate in interface Condition

Parameters:

m - the WizardModel the condition should use.

Returns:

true if the .

loadProperties

protected java.util.Properties loadProperties()

storeProperties

protected void storeProperties(java.util.Properties props)
                        throws InvalidStateException

Throws:

InvalidStateException