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
,java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,java.util.EventListener
,javax.accessibility.Accessible
,javax.swing.event.ChangeListener
public class PMISpinner extends javax.swing.JSpinner implements javax.swing.event.ChangeListener, MutableDynamicPropertyProvider, StyleProvider, VisionComponent, TouchscreenMouseListener.TouchscreenEnabledComponent, EnabledEx, LocaleListener
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.JSpinner
javax.swing.JSpinner.AccessibleJSpinner, javax.swing.JSpinner.DateEditor, javax.swing.JSpinner.DefaultEditor, javax.swing.JSpinner.ListEditor, javax.swing.JSpinner.NumberEditor
-
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
-
-
Field Summary
Fields Modifier and Type Field Description protected VisionClientContext
context
The current ClientContext that is set on startupComponent()static int
DATE_SPINNER
protected java.lang.String
dateFormat
static int
DOUBLE_SPINNER
protected java.awt.Color
editorColor
static int
INT_SPINNER
protected double
maxValue
protected double
minValue
protected java.lang.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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected javax.swing.JComponent
createEditor(javax.swing.SpinnerModel model)
void
evaluateEnabled()
VisionClientContext
getAppContext()
protected java.util.Locale
getCurrentLocale()
int
getDataQuality()
For backwards compatibility with scripts.java.lang.String
getDateFormat()
long
getDateInMillis()
int
getDateStepSize()
Deprecated.java.util.Date
getDateValue()
double
getDoubleValue()
double
getDoubleValueTS()
java.util.TreeMap<java.lang.String,DynamicPropertyDescriptor>
getDynamicProps()
java.awt.Color
getEditorColor()
int
getIntValue()
int
getIntValueTS()
double
getMaxValue()
double
getMinValue()
java.lang.String
getNumberFormat()
DynamicPropertyDescriptor[]
getProperties()
java.lang.Object
getPropertyValue(java.lang.String name)
QualityCode
getQuality()
Retrieves the data quality code.int
getSpinnerMode()
double
getStepSize()
Dataset
getStyles()
java.lang.String
getToolTipText()
int
getTouchscreenMode()
java.lang.String
getTouchscreenPropertyName()
The javabeans-style name of the property to modify.TouchscreenMouseListener.KeyboardStyle
getTouchscreenStyle()
boolean
isComponentEnabled()
boolean
isPropertyDefined(java.lang.String name)
boolean
isTouchscreenEditAllowed()
void
localeChanged(java.util.Locale newLocale)
protected void
paintChildren(java.awt.Graphics g)
void
setAntialias(boolean ignored)
void
setBackground(java.awt.Color bg)
void
setComponentEnabled(boolean componentEnabled)
void
setDataQuality(int value)
void
setDateFormat(java.lang.String dateFormat)
void
setDateInMillis(long date)
void
setDateStepSize(int i)
Deprecated.void
setDateValue(java.util.Date d)
void
setDoubleValue(double d)
void
setDoubleValueTS(double d)
void
setDynamicProps(java.util.TreeMap<java.lang.String,DynamicPropertyDescriptor> map)
void
setEditorColor(java.awt.Color c)
void
setFont(java.awt.Font f)
void
setForeground(java.awt.Color fg)
void
setIntValue(int i)
void
setIntValueTS(int i)
void
setMaxValue(double d)
void
setMinValue(double d)
void
setName(java.lang.String newName)
void
setNumberFormat(java.lang.String numberFormat)
void
setPropertyValue(java.lang.String name, java.lang.Object value)
void
setQuality(QualityCode value)
Sets the current data quality to the given valuevoid
setSpinnerMode(int i)
void
setStepSize(double d)
void
setStyles(Dataset styleDS)
void
setToolTipText(java.lang.String text)
void
setTouchscreenMode(int touchscreenMode)
void
setVisible(boolean visible)
void
shutdownComponent()
Called when the component is now shown anymore.void
startupComponent(VisionClientContext context)
Called when the component is first shown.void
stateChanged(javax.swing.event.ChangeEvent e)
void
updateQuality(java.lang.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
-
-
-
-
Field Detail
-
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 java.awt.Color editorColor
-
numberFormat
protected java.lang.String numberFormat
-
dateFormat
protected java.lang.String dateFormat
-
touchscreenMode
protected int touchscreenMode
-
context
protected transient VisionClientContext context
The current ClientContext that is set on startupComponent()
-
-
Method Detail
-
getCurrentLocale
protected java.util.Locale getCurrentLocale()
-
setName
public void setName(java.lang.String newName)
- Overrides:
setName
in classjava.awt.Component
-
getToolTipText
public java.lang.String getToolTipText()
- Overrides:
getToolTipText
in classjavax.swing.JComponent
-
setToolTipText
public void setToolTipText(java.lang.String text)
- Overrides:
setToolTipText
in classjavax.swing.JComponent
-
getTouchscreenPropertyName
public java.lang.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 interfaceTouchscreenMouseListener.TouchscreenEnabledComponent
-
isTouchscreenEditAllowed
public boolean isTouchscreenEditAllowed()
- Specified by:
isTouchscreenEditAllowed
in interfaceTouchscreenMouseListener.TouchscreenEnabledComponent
-
getTouchscreenStyle
public TouchscreenMouseListener.KeyboardStyle getTouchscreenStyle()
- Specified by:
getTouchscreenStyle
in interfaceTouchscreenMouseListener.TouchscreenEnabledComponent
-
getTouchscreenMode
public int getTouchscreenMode()
- Specified by:
getTouchscreenMode
in interfaceTouchscreenMouseListener.TouchscreenEnabledComponent
-
setTouchscreenMode
public void setTouchscreenMode(int touchscreenMode)
-
isComponentEnabled
public boolean isComponentEnabled()
- Specified by:
isComponentEnabled
in interfaceEnabledEx
-
setComponentEnabled
public void setComponentEnabled(boolean componentEnabled)
- Specified by:
setComponentEnabled
in interfaceEnabledEx
-
setVisible
public void setVisible(boolean visible)
- Overrides:
setVisible
in classjavax.swing.JComponent
-
evaluateEnabled
public void evaluateEnabled()
- Specified by:
evaluateEnabled
in interfaceEnabledEx
-
setForeground
public void setForeground(java.awt.Color fg)
- Overrides:
setForeground
in classjavax.swing.JComponent
-
setBackground
public void setBackground(java.awt.Color bg)
- Overrides:
setBackground
in classjavax.swing.JComponent
-
setEditorColor
public void setEditorColor(java.awt.Color c)
-
getEditorColor
public java.awt.Color getEditorColor()
-
getIntValueTS
public int getIntValueTS()
-
getIntValue
public int getIntValue()
-
getDoubleValueTS
public double getDoubleValueTS()
-
getDoubleValue
public double getDoubleValue()
-
getDateValue
public java.util.Date getDateValue()
-
getDateInMillis
public long getDateInMillis()
-
setDateValue
public void setDateValue(java.util.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(java.awt.Font f)
- Overrides:
setFont
in classjavax.swing.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 javax.swing.JComponent createEditor(javax.swing.SpinnerModel model)
- Overrides:
createEditor
in classjavax.swing.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(javax.swing.event.ChangeEvent e)
- Specified by:
stateChanged
in interfacejavax.swing.event.ChangeListener
-
getNumberFormat
public java.lang.String getNumberFormat()
-
setNumberFormat
public void setNumberFormat(java.lang.String numberFormat)
-
getDateFormat
public java.lang.String getDateFormat()
-
setDateFormat
public void setDateFormat(java.lang.String dateFormat)
-
getDynamicProps
public java.util.TreeMap<java.lang.String,DynamicPropertyDescriptor> getDynamicProps()
- Specified by:
getDynamicProps
in interfaceMutableDynamicPropertyProvider
-
setDynamicProps
public void setDynamicProps(java.util.TreeMap<java.lang.String,DynamicPropertyDescriptor> map)
- Specified by:
setDynamicProps
in interfaceMutableDynamicPropertyProvider
-
setPropertyValue
public void setPropertyValue(java.lang.String name, java.lang.Object value) throws java.lang.ClassCastException
- Specified by:
setPropertyValue
in interfaceDynamicPropertyProvider
- Throws:
java.lang.ClassCastException
-
getPropertyValue
public java.lang.Object getPropertyValue(java.lang.String name)
- Specified by:
getPropertyValue
in interfaceDynamicPropertyProvider
-
getProperties
public DynamicPropertyDescriptor[] getProperties()
- Specified by:
getProperties
in interfaceDynamicPropertyProvider
-
isPropertyDefined
public boolean isPropertyDefined(java.lang.String name)
- Specified by:
isPropertyDefined
in interfaceDynamicPropertyProvider
-
getQuality
public QualityCode getQuality()
Description copied from interface:QualityMonitor
Retrieves the data quality code.- Specified by:
getQuality
in interfaceQualityMonitor
-
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 interfaceQualityMonitor
-
setDataQuality
public void setDataQuality(int value)
- Specified by:
setDataQuality
in interfaceQualityMonitor
-
setQuality
public void setQuality(QualityCode value)
Description copied from interface:QualityMonitor
Sets the current data quality to the given value- Specified by:
setQuality
in interfaceQualityMonitor
-
updateQuality
public void updateQuality(java.lang.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 interfaceQualityMonitor
-
paintChildren
protected void paintChildren(java.awt.Graphics g)
- Overrides:
paintChildren
in classjavax.swing.JComponent
-
getStyles
public Dataset getStyles()
- Specified by:
getStyles
in interfaceStyleProvider
-
setStyles
public void setStyles(Dataset styleDS)
- Specified by:
setStyles
in interfaceStyleProvider
-
startupComponent
public final void startupComponent(VisionClientContext context)
Description copied from interface:ComponentLifecycle
Called when the component is first shown.- Specified by:
startupComponent
in interfaceComponentLifecycle
-
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 interfaceComponentLifecycle
-
getAppContext
public VisionClientContext getAppContext()
- Specified by:
getAppContext
in interfaceComponentLifecycle
-
localeChanged
public void localeChanged(java.util.Locale newLocale)
- Specified by:
localeChanged
in interfaceLocaleListener
-
-