Package com.inductiveautomation.ignition.designer.gui.opencreate.form

Class ValidatedWorkerComboBox<T>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.jidesoft.swing.DefaultOverlayable

com.inductiveautomation.ignition.designer.gui.opencreate.form.ValidatedWorkerComboBox<T>

Type Parameters:

T - The type of objects that will be returned by the doInBackground() method to populate a DefaultComboBoxModel for the backing JComboBox

All Implemented Interfaces:

ValidatedField, com.jidesoft.swing.Overlayable, ComponentListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, SwingConstants

public abstract class ValidatedWorkerComboBox<T>
extends com.jidesoft.swing.DefaultOverlayable
implements ValidatedField

An abstract class that extends ValidatedComboBox with an abstract doInBackground() method to return a List of the supplied type T.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ValidatedWorkerComboBox.AttentionLevel

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field	Description
protected T	selectedValue

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

Fields inherited from interface com.jidesoft.swing.Overlayable

CLIENT_PROPERTY_OVERLAYABLE

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors

Constructor	Description
ValidatedWorkerComboBox(T selectedValue, String errorBundleGroup, String workerBundleKey, boolean blockingError, ValidatedWorkerComboBox.AttentionLevel attentionLevel)	An abstract class that extends ValidatedComboBox with an abstract doInBackground() method to return a List of the supplied type T.
ValidatedWorkerComboBox(T selectedValue, String errorBundleGroup, String workerBundleKey, boolean blockingError, ValidatedWorkerComboBox.AttentionLevel attentionLevel, boolean showErrorMessage)	An abstract class that extends ValidatedComboBox with an abstract doInBackground() method to return a List of the supplied type T.

Method Summary

Modifier and Type	Method	Description
void	addValidationStateListener(ValidationStateListener validationStateListener)	Adds a ValidationStateListener which is notified upon the changed validity state of the component.
boolean	blockingError()	Whether or not this field is one that should block form submission.
protected abstract List<T>	doInBackground()	Should execute whatever command is required to return the List that will back this combobox.
protected void	done(List<T> values)	Receives the values from the ValidatedWorkerComboBox<T>.com.inductiveautomation.ignition.designer.gui.opencreate.form.ValidatedWorkerComboBox.ListReturningSwingWorker and applies them to the combobox via a DefaultComboBoxModel, sets the selected item in the combobox, and calls doFinally(List) with the values for any remaining work that is required.
protected void	evaluateItem(T item)
T	getCurrentValue()	Get the selected value of the underlying combobox
JComboBox<T>	getInnerComboBox()
boolean	isDataValid()
void	removeValidationStateListener(ValidationStateListener validationStateListener)	Removes a ValidationStateListener.
void	reset()
void	setEnabled(boolean enabled)
protected String	validate(T selectedItem)

Methods inherited from class com.jidesoft.swing.DefaultOverlayable

addOverlayComponent, addOverlayComponent, addOverlayComponent, componentHidden, componentMoved, componentResized, componentShown, getActualComponent, getMinimumSize, getOverlayComponentBounds, getOverlayComponents, getOverlayLocation, getOverlayLocationInsets, getPreferredSize, removeOverlayComponent, setActualComponent, setBounds, setMinimumSize, setOverlayLocation, setOverlayLocationInsets, setOverlayVisible, setPreferredSize

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, getNextFocusableComponent, getPopupLocation, 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, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setNextFocusableComponent, setOpaque, 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, 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 Details

selectedValue

protected T selectedValue

Constructor Details

ValidatedWorkerComboBox

public ValidatedWorkerComboBox(T selectedValue,
 String errorBundleGroup,
 String workerBundleKey,
 boolean blockingError,
 ValidatedWorkerComboBox.AttentionLevel attentionLevel,
 boolean showErrorMessage)

An abstract class that extends ValidatedComboBox with an abstract doInBackground() method to return a List of the supplied type T. that will be used in the DefaultComboBoxModel backing the internal ComboBox.

Parameters:

selectedValue - The currently selected value or previously selected value.

errorBundleGroup - The bundle key for this component see validate(Object)

workerBundleKey - The bundle key used by the worker in the event that there is an error

blockingError - Whether this component should enter an error state or an invalid one when the combobox model fails to have the selected value.

attentionLevel - What attention level the overlay icon should be in the ValidatedComboBox

showErrorMessage - Whether to show error message when the combobox model fails to have the selected value.

ValidatedWorkerComboBox

public ValidatedWorkerComboBox(T selectedValue,
 String errorBundleGroup,
 String workerBundleKey,
 boolean blockingError,
 ValidatedWorkerComboBox.AttentionLevel attentionLevel)

An abstract class that extends ValidatedComboBox with an abstract doInBackground() method to return a List of the supplied type T. that will be used in the DefaultComboBoxModel backing the internal ComboBox.

Parameters:

selectedValue - The currently selected value or previously selected value.

errorBundleGroup - The bundle key for this component see validate(Object)

workerBundleKey - The bundle key used by the worker in the event that there is an error

blockingError - Whether this component should enter an error state or an invalid one when the combobox model fails to have the selected value.

attentionLevel - What attention level the overlay icon should be in the ValidatedComboBox

Method Details

isDataValid

public boolean isDataValid()

doInBackground

protected abstract List<T> doInBackground()
                                   throws Exception

Should execute whatever command is required to return the List that will back this combobox.

Throws:

Exception

evaluateItem

protected void evaluateItem(T item)

validate

protected String validate(T selectedItem)

getInnerComboBox

public JComboBox<T> getInnerComboBox()

getCurrentValue

@Nullable
public T getCurrentValue()

Get the selected value of the underlying combobox

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class JComponent

blockingError

public boolean blockingError()

Description copied from interface: ValidatedField

Whether or not this field is one that should block form submission.

Specified by:

blockingError in interface ValidatedField

addValidationStateListener

public void addValidationStateListener(ValidationStateListener validationStateListener)

Description copied from interface: ValidatedField

Adds a ValidationStateListener which is notified upon the changed validity state of the component.

Specified by:

addValidationStateListener in interface ValidatedField

removeValidationStateListener

public void removeValidationStateListener(ValidationStateListener validationStateListener)

Description copied from interface: ValidatedField

Removes a ValidationStateListener.

Specified by:

removeValidationStateListener in interface ValidatedField

done

protected void done(List<T> values)

Receives the values from the ValidatedWorkerComboBox<T>.com.inductiveautomation.ignition.designer.gui.opencreate.form.ValidatedWorkerComboBox.ListReturningSwingWorker and applies them to the combobox via a DefaultComboBoxModel, sets the selected item in the combobox, and calls doFinally(List) with the values for any remaining work that is required.

reset

public void reset()