Package com.inductiveautomation.factorypmi.application.components

Class PMISpinner

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JSpinner

com.inductiveautomation.factorypmi.application.components.PMISpinner

All Implemented Interfaces:

DynamicPropertyProvider, LocaleListener, MutableDynamicPropertyProvider, StyleProvider, ComponentLifecycle, EnabledEx, QualityMonitor, VisionComponent, TouchscreenMouseListener.TouchscreenEnabledComponent, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, ChangeListener

public class PMISpinner
extends JSpinner
implements ChangeListener, MutableDynamicPropertyProvider, StyleProvider, VisionComponent, TouchscreenMouseListener.TouchscreenEnabledComponent, EnabledEx, LocaleListener

See Also:

• Serialized Form

Nested Class Summary

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

JSpinner.AccessibleJSpinner, JSpinner.DateEditor, JSpinner.DefaultEditor, JSpinner.ListEditor, JSpinner.NumberEditor

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 VisionClientContext	context	The current ClientContext that is set on startupComponent()
static final int	DATE_SPINNER
protected String	dateFormat
static final int	DOUBLE_SPINNER
protected Color	editorColor
static final int	INT_SPINNER
protected double	maxValue
protected double	minValue
protected String	numberFormat
protected int	spinnerMode
protected double	stepSize
protected int	touchscreenMode

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 com.inductiveautomation.vision.api.client.components.model.ComponentLifecycle

COMPONENT_RUNNING

Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.EnabledEx

DISABLED_BY_PERMISSIONS

Fields inherited from interface java.awt.image.ImageObserver

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

Fields inherited from interface com.inductiveautomation.ignition.client.model.LocaleListener

LOCAL_CHANGE_EVENT

Fields inherited from interface com.inductiveautomation.vision.api.client.binding.MutableDynamicPropertyProvider

RESERVED_SET_KEY

Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.VisionComponent

COMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS

Constructor Summary

Constructors

Constructor	Description
PMISpinner()

Method Summary

Modifier and Type	Method	Description
protected JComponent	createEditor(SpinnerModel model)
void	evaluateEnabled()
VisionClientContext	getAppContext()
protected Locale	getCurrentLocale()
int	getDataQuality()	For backwards compatibility with scripts.
String	getDateFormat()
long	getDateInMillis()
int	getDateStepSize()	Deprecated.
Date	getDateValue()
double	getDoubleValue()
double	getDoubleValueTS()
TreeMap<String,DynamicPropertyDescriptor>	getDynamicProps()
Color	getEditorColor()
int	getIntValue()
int	getIntValueTS()
double	getMaxValue()
double	getMinValue()
String	getNumberFormat()
DynamicPropertyDescriptor[]	getProperties()
Object	getPropertyValue(String name)
QualityCode	getQuality()	Retrieves the data quality code.
int	getSpinnerMode()
double	getStepSize()
Dataset	getStyles()
String	getToolTipText()
int	getTouchscreenMode()
String	getTouchscreenPropertyName()	The javabeans-style name of the property to modify.
TouchscreenMouseListener.KeyboardStyle	getTouchscreenStyle()
boolean	isComponentEnabled()
boolean	isPropertyDefined(String name)
boolean	isTouchscreenEditAllowed()
void	localeChanged(Locale newLocale)
protected void	paintChildren(Graphics g)
void	setAntialias(boolean ignored)
void	setBackground(Color bg)
void	setComponentEnabled(boolean componentEnabled)
void	setDataQuality(int value)
void	setDateFormat(String dateFormat)
void	setDateInMillis(long date)
void	setDateStepSize(int i)	Deprecated.
void	setDateValue(Date d)
void	setDoubleValue(double d)
void	setDoubleValueTS(double d)
void	setDynamicProps(TreeMap<String,DynamicPropertyDescriptor> map)
void	setEditorColor(Color c)
void	setFont(Font f)
void	setForeground(Color fg)
void	setIntValue(int i)
void	setIntValueTS(int i)
void	setMaxValue(double d)
void	setMinValue(double d)
void	setName(String newName)
void	setNumberFormat(String numberFormat)
void	setPropertyValue(String name, Object value)
void	setQuality(QualityCode value)	Sets the current data quality to the given value
void	setSpinnerMode(int i)
void	setStepSize(double d)
void	setStyles(Dataset styleDS)
void	setToolTipText(String text)
void	setTouchscreenMode(int touchscreenMode)
void	setVisible(boolean visible)
final void	shutdownComponent()	Called when the component is now shown anymore.
final void	startupComponent(VisionClientContext context)	Called when the component is first shown.
void	stateChanged(ChangeEvent e)
void	updateQuality(String propName, QualityCode quality)	Updates the quality for the given property name.

Methods inherited from class javax.swing.JSpinner

addChangeListener, commitEdit, fireStateChanged, getAccessibleContext, getChangeListeners, getEditor, getModel, getNextValue, getPreviousValue, getUI, getUIClassID, getValue, removeChangeListener, setEditor, setModel, setUI, setValue, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintComponent, paintImmediately, paintImmediately, paramString, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, 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, 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

Methods inherited from interface com.inductiveautomation.vision.api.client.components.touchscreen.TouchscreenMouseListener.TouchscreenEnabledComponent

getKeyboardName

Field Details

INT_SPINNER

public static final int INT_SPINNER

See Also:

• Constant Field Values

DOUBLE_SPINNER

public static final int DOUBLE_SPINNER

See Also:

• Constant Field Values

DATE_SPINNER

public static final int DATE_SPINNER

See Also:

• Constant Field Values

stepSize

protected double stepSize

minValue

protected double minValue

maxValue

protected double maxValue

spinnerMode

protected int spinnerMode

editorColor

protected Color editorColor

numberFormat

protected String numberFormat

dateFormat

protected String dateFormat

touchscreenMode

protected int touchscreenMode

context

protected transient VisionClientContext context

The current ClientContext that is set on startupComponent()

Constructor Details

PMISpinner

public PMISpinner()

Method Details

getCurrentLocale

protected Locale getCurrentLocale()

setName

public void setName(String newName)

Overrides:

setName in class Component

getToolTipText

public String getToolTipText()

Overrides:

getToolTipText in class JComponent

setToolTipText

public void setToolTipText(String text)

Overrides:

setToolTipText in class JComponent

getTouchscreenPropertyName

public String getTouchscreenPropertyName()

Description copied from interface: TouchscreenMouseListener.TouchscreenEnabledComponent

The javabeans-style name of the property to modify. Needs a getter and setter.

Specified by:

getTouchscreenPropertyName in interface TouchscreenMouseListener.TouchscreenEnabledComponent

isTouchscreenEditAllowed

public boolean isTouchscreenEditAllowed()

Specified by:

isTouchscreenEditAllowed in interface TouchscreenMouseListener.TouchscreenEnabledComponent

getTouchscreenStyle

public TouchscreenMouseListener.KeyboardStyle getTouchscreenStyle()

Specified by:

getTouchscreenStyle in interface TouchscreenMouseListener.TouchscreenEnabledComponent

getTouchscreenMode

public int getTouchscreenMode()

Specified by:

getTouchscreenMode in interface TouchscreenMouseListener.TouchscreenEnabledComponent

setTouchscreenMode

public void setTouchscreenMode(int touchscreenMode)

isComponentEnabled

public boolean isComponentEnabled()

Specified by:

isComponentEnabled in interface EnabledEx

setComponentEnabled

public void setComponentEnabled(boolean componentEnabled)

Specified by:

setComponentEnabled in interface EnabledEx

setVisible

public void setVisible(boolean visible)

Overrides:

setVisible in class JComponent

evaluateEnabled

public void evaluateEnabled()

Specified by:

evaluateEnabled in interface EnabledEx

setForeground

public void setForeground(Color fg)

Overrides:

setForeground in class JComponent

setBackground

public void setBackground(Color bg)

Overrides:

setBackground in class JComponent

setEditorColor

public void setEditorColor(Color c)

getEditorColor

public Color getEditorColor()

getIntValueTS

public int getIntValueTS()

getIntValue

public int getIntValue()

getDoubleValueTS

public double getDoubleValueTS()

getDoubleValue

public double getDoubleValue()

getDateValue

public Date getDateValue()

getDateInMillis

public long getDateInMillis()

setDateValue

public void setDateValue(Date d)

setDateInMillis

public void setDateInMillis(long date)

setIntValueTS

public void setIntValueTS(int i)

setIntValue

public void setIntValue(int i)

setDoubleValueTS

public void setDoubleValueTS(double d)

setDoubleValue

public void setDoubleValue(double d)

setFont

public void setFont(Font f)

Overrides:

setFont in class JComponent

getMaxValue

public double getMaxValue()

getMinValue

public double getMinValue()

getSpinnerMode

public int getSpinnerMode()

getStepSize

public double getStepSize()

setMaxValue

public void setMaxValue(double d)

setMinValue

public void setMinValue(double d)

setSpinnerMode

public void setSpinnerMode(int i)

setAntialias

public void setAntialias(boolean ignored)

createEditor

protected JComponent createEditor(SpinnerModel model)

Overrides:

createEditor in class JSpinner

setStepSize

public void setStepSize(double d)

getDateStepSize

@Deprecated
public int getDateStepSize()

Deprecated.

setDateStepSize

@Deprecated
public void setDateStepSize(int i)

Deprecated.

stateChanged

public void stateChanged(ChangeEvent e)

Specified by:

stateChanged in interface ChangeListener

getNumberFormat

public String getNumberFormat()

setNumberFormat

public void setNumberFormat(String numberFormat)

getDateFormat

public String getDateFormat()

setDateFormat

public void setDateFormat(String dateFormat)

getDynamicProps

public TreeMap<String,DynamicPropertyDescriptor> getDynamicProps()

Specified by:

getDynamicProps in interface MutableDynamicPropertyProvider

setDynamicProps

public void setDynamicProps(TreeMap<String,DynamicPropertyDescriptor> map)

Specified by:

setDynamicProps in interface MutableDynamicPropertyProvider

setPropertyValue

public void setPropertyValue(String name,
 Object value)
                      throws ClassCastException

Specified by:

setPropertyValue in interface DynamicPropertyProvider

Throws:

ClassCastException

getPropertyValue

public Object getPropertyValue(String name)

Specified by:

getPropertyValue in interface DynamicPropertyProvider

getProperties

public DynamicPropertyDescriptor[] getProperties()

Specified by:

getProperties in interface DynamicPropertyProvider

isPropertyDefined

public boolean isPropertyDefined(String name)

Specified by:

isPropertyDefined in interface DynamicPropertyProvider

getQuality

public QualityCode getQuality()

Description copied from interface: QualityMonitor

Retrieves the data quality code.

Specified by:

getQuality in interface QualityMonitor

getDataQuality

public int getDataQuality()

Description copied from interface: QualityMonitor

For backwards compatibility with scripts. Would be awesome if this could just be a default method, but there's a bug (JDK-8071693) that makes that not work with property introspection.

Specified by:

getDataQuality in interface QualityMonitor

setDataQuality

public void setDataQuality(int value)

Specified by:

setDataQuality in interface QualityMonitor

setQuality

public void setQuality(QualityCode value)

Description copied from interface: QualityMonitor

Sets the current data quality to the given value

Specified by:

setQuality in interface QualityMonitor

updateQuality

public void updateQuality(String propName,
 QualityCode quality)

Description copied from interface: QualityMonitor

Updates the quality for the given property name. The monitor will then evaluate a new quality based on the quality of its other properties. Overall, the worst quality is chosen.

Specified by:

updateQuality in interface QualityMonitor

paintChildren

protected void paintChildren(Graphics g)

Overrides:

paintChildren in class JComponent

getStyles

public Dataset getStyles()

Specified by:

getStyles in interface StyleProvider

setStyles

public void setStyles(Dataset styleDS)

Specified by:

setStyles in interface StyleProvider

startupComponent

public final void startupComponent(VisionClientContext context)

Description copied from interface: ComponentLifecycle

Called when the component is first shown.

Specified by:

startupComponent in interface ComponentLifecycle

shutdownComponent

public final void shutdownComponent()

Description copied from interface: ComponentLifecycle

Called when the component is now shown anymore. Any long-running processes should be stopped. All bindings will have also been shutdown.

Specified by:

shutdownComponent in interface ComponentLifecycle

getAppContext

public VisionClientContext getAppContext()

Specified by:

getAppContext in interface ComponentLifecycle

localeChanged

public void localeChanged(Locale newLocale)

Specified by:

localeChanged in interface LocaleListener