Package org.openpnp.gui.support

Class AbstractConfigurationWizard

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.openpnp.gui.support.AbstractConfigurationWizard

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, Wizard, Identifiable

Direct Known Subclasses:

AbstractActuatorConfigurationWizard, AbstractAxisConfigurationWizard, AbstractReferenceDriverConfigurationWizard, AbstractReferenceFeederConfigurationWizard, ActuatorInterlockMonitorConfigurationWizard, ActuatorSignalerConfigurationWizard, AutoFocusProviderConfigurationWizard, BacklashCompensationConfigurationWizard, BlindsFeederArrayConfigurationWizard, BlindsFeederConfigurationWizard, BottomVisionSettingsConfigurationWizard, CameraConfigurationWizard, CameraVisionConfigurationWizard, ContactProbeNozzleWizard, FeederConfigurationWizard, FiducialVisionSettingsConfigurationWizard, GcodeAsyncDriverSettings, GcodeDriverConsole, GcodeDriverGcodes, GcodeDriverSettings, GlobalConfigConfigurationWizard, GstreamerCameraConfigurationWizard, ImageCameraConfigurationWizard, MjpgCaptureCameraWizard, Neoden4CameraConfigurationWizard, Neoden4DriverConfigurationWizard, Neoden4SignalerConfigurationWizard, Neoden4SwitcherCameraConfigurationWizard, OnvifIPCameraConfigurationWizard, OpenCvCameraConfigurationWizard, OpenCvVisionProviderConfigurationWizard, OpenPnpCaptureCameraConfigurationWizard, PackageCompositingWizard, PackageNozzleTipsWizard, PackageSettingsWizard, PackageVisionWizard, PartSettingsWizard, ReferenceActuatorProfilesWizard, ReferenceAdvancedMotionPlannerConfigurationWizard, ReferenceAdvancedMotionPlannerDiagnosticsWizard, ReferenceBottomVisionConfigurationWizard, ReferenceCameraCalibrationConfigurationWizard, ReferenceCameraCalibrationWizard, ReferenceCameraPositionConfigurationWizard, ReferenceCameraTransformsConfigurationWizard, ReferenceCameraWhiteBalanceConfigurationWizard, ReferenceFiducialLocatorConfigurationWizard, ReferenceHeadConfigurationWizard, ReferenceHeapFeederConfigurationWizard, ReferenceMachineConfigurationWizard, ReferenceNozzleCameraOffsetWizard, ReferenceNozzleCompatibleNozzleTipsWizard, ReferenceNozzleConfigurationWizard, ReferenceNozzleTipCalibrationWizard, ReferenceNozzleTipConfigurationWizard, ReferenceNozzleTipPartDetectionWizard, ReferenceNozzleTipToolChangerWizard, ReferenceNozzleToolChangerWizard, ReferenceNozzleVacuumWizard, ReferencePnpJobProcessorConfigurationWizard, ReferencePushPullMotionConfigurationWizard, ReferenceRotatedTrayFeederConfigurationWizard, ReferenceSlotAutoFeederConfigurationWizard, ReferenceStripFeederConfigurationWizard, SimulatedUpCameraConfigurationWizard, SimulationModeMachineConfigurationWizard, SlotSchultzFeederConfigurationWizard, SoundSignalerConfigurationWizard, SwitcherCameraConfigurationWizard, ThermistorToLinearSensorActuatorTransforms, WebcamConfigurationWizard

public abstract class AbstractConfigurationWizard
extends javax.swing.JPanel
implements Wizard, Identifiable

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

Fields

Modifier and Type	Field	Description
protected javax.swing.Action	applyAction
protected javax.swing.JPanel	contentPanel
protected java.lang.String	id
protected javax.swing.Action	resetAction
protected WizardContainer	wizardContainer

Fields inherited from class javax.swing.JComponent

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

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

Constructors

Constructor	Description
AbstractConfigurationWizard()

Method Summary

Modifier and Type	Method	Description
JBindings.WrappedBinding	addWrappedBinding(java.lang.Object source, java.lang.String sourceProperty, java.lang.Object target, java.lang.String targetProperty)
JBindings.WrappedBinding	addWrappedBinding(java.lang.Object source, java.lang.String sourceProperty, java.lang.Object target, java.lang.String targetProperty, org.jdesktop.beansbinding.Converter converter)
JBindings.WrappedBinding	addWrappedBinding(JBindings.WrappedBinding binding)
void	apply()
org.jdesktop.beansbinding.AutoBinding	bind(org.jdesktop.beansbinding.AutoBinding.UpdateStrategy updateStrategy, java.lang.Object source, java.lang.String sourceProperty, java.lang.Object target, java.lang.String targetProperty)
org.jdesktop.beansbinding.AutoBinding	bind(org.jdesktop.beansbinding.AutoBinding.UpdateStrategy updateStrategy, java.lang.Object source, java.lang.String sourceProperty, java.lang.Object target, java.lang.String targetProperty, org.jdesktop.beansbinding.Converter converter)
abstract void	createBindings()
void	dispose()	Override this method if the wizard needs to do any additional cleanup like removing property change listeners that may have been added during the wizard's construction.
protected void	forceApplyResetButtonsVisible()	This method is provided for wizards that do not use wrapped bindings but still want to use the Apply and Reset buttons to save and/or reset the changes.
java.lang.String	getId()
WizardContainer	getWizardContainer()
java.lang.String	getWizardName()
javax.swing.JPanel	getWizardPanel()
java.lang.Boolean	isDirty()
protected void	loadFromModel()	When overriding this method you should call super.loadFromModel() AFTER doing any work that you need to do, not before.
protected void	notifyChange()	This method should be called when the caller wishes to notify the user that there has been a change to the state of the wizard.
void	processCompleted()	Unregisters the wizard as having an active process.
void	processStarting()	Registers the wizard as having an active process.
protected void	saveToModel()	When overriding this method you should call super.loadFromModel() AFTER doing any work that you need to do, not before.
void	setWizardContainer(WizardContainer wizardContainer)
void	validateInput()

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, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, 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, 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, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

wizardContainer

protected WizardContainer wizardContainer

contentPanel

protected javax.swing.JPanel contentPanel

id

protected java.lang.String id

applyAction

protected javax.swing.Action applyAction

resetAction

protected javax.swing.Action resetAction

Constructor Detail

AbstractConfigurationWizard

public AbstractConfigurationWizard()

Method Detail

createBindings

public abstract void createBindings()

validateInput

public void validateInput()
                   throws java.lang.Exception

Throws:

java.lang.Exception

notifyChange

protected void notifyChange()

This method should be called when the caller wishes to notify the user that there has been a change to the state of the wizard. This is done automatically for wrapped bindings but this method is provided for operations that do not use wrapped bindings.

forceApplyResetButtonsVisible

protected void forceApplyResetButtonsVisible()

This method is provided for wizards that do not use wrapped bindings but still want to use the Apply and Reset buttons to save and/or reset the changes. Normally the buttons are only displayed by wizards that use wrapped bindings. Calling this method forces the buttons to be displayed.

loadFromModel

protected void loadFromModel()

When overriding this method you should call super.loadFromModel() AFTER doing any work that you need to do, not before.

saveToModel

protected void saveToModel()

When overriding this method you should call super.loadFromModel() AFTER doing any work that you need to do, not before.

dispose

public void dispose()

Override this method if the wizard needs to do any additional cleanup like removing property change listeners that may have been added during the wizard's construction. Be sure to also call super.dispose() if this method is overridden.

addWrappedBinding

public JBindings.WrappedBinding addWrappedBinding(java.lang.Object source,
                                                  java.lang.String sourceProperty,
                                                  java.lang.Object target,
                                                  java.lang.String targetProperty,
                                                  org.jdesktop.beansbinding.Converter converter)

addWrappedBinding

public JBindings.WrappedBinding addWrappedBinding(java.lang.Object source,
                                                  java.lang.String sourceProperty,
                                                  java.lang.Object target,
                                                  java.lang.String targetProperty)

bind

public org.jdesktop.beansbinding.AutoBinding bind(org.jdesktop.beansbinding.AutoBinding.UpdateStrategy updateStrategy,
                                                  java.lang.Object source,
                                                  java.lang.String sourceProperty,
                                                  java.lang.Object target,
                                                  java.lang.String targetProperty)

bind

public org.jdesktop.beansbinding.AutoBinding bind(org.jdesktop.beansbinding.AutoBinding.UpdateStrategy updateStrategy,
                                                  java.lang.Object source,
                                                  java.lang.String sourceProperty,
                                                  java.lang.Object target,
                                                  java.lang.String targetProperty,
                                                  org.jdesktop.beansbinding.Converter converter)

addWrappedBinding

public JBindings.WrappedBinding addWrappedBinding(JBindings.WrappedBinding binding)

setWizardContainer

public void setWizardContainer(WizardContainer wizardContainer)

Specified by:

setWizardContainer in interface Wizard

getWizardContainer

public WizardContainer getWizardContainer()

getWizardPanel

public javax.swing.JPanel getWizardPanel()

Specified by:

getWizardPanel in interface Wizard

getWizardName

public java.lang.String getWizardName()

Specified by:

getWizardName in interface Wizard

isDirty

public java.lang.Boolean isDirty()

apply

public void apply()

getId

public java.lang.String getId()

Specified by:

getId in interface Identifiable

processStarting

public void processStarting()

Registers the wizard as having an active process.

processCompleted

public void processCompleted()

Unregisters the wizard as having an active process.