Class PMIImage
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- javax.swing.JLabel
-
- com.inductiveautomation.factorypmi.application.components.PMIImage
-
- All Implemented Interfaces:
DynamicPropertyProvider,LocaleListener,MutableDynamicPropertyProvider,StyleProvider,ComponentLifecycle,EnabledEx,QualityMonitor,VisionComponent,java.awt.image.ImageObserver,java.awt.MenuContainer,java.io.Serializable,javax.accessibility.Accessible,javax.swing.SwingConstants
public class PMIImage extends javax.swing.JLabel implements MutableDynamicPropertyProvider, StyleProvider, VisionComponent, EnabledEx, LocaleListener
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class javax.swing.JLabel
javax.swing.JLabel.AccessibleJLabel
-
Nested classes/interfaces inherited from class javax.swing.JComponent
javax.swing.JComponent.AccessibleJComponent
-
-
Field Summary
Fields Modifier and Type Field Description protected VisionClientContextcontextThe current ClientContext that is set on startupComponent()protected intcursorCodestatic intSTRETCH_OFFstatic intSTRETCH_TO_BOUNDSstatic intSTRETCH_TO_BOUNDS_PCTstatic intSTRETCH_TO_PARAM-
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 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
-
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 PMIImage()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddActionListener(java.awt.event.ActionListener al)voidevaluateEnabled()VisionClientContextgetAppContext()intgetCursorCode()intgetDataQuality()For backwards compatibility with scripts.java.lang.StringgetDisabledPath()java.util.TreeMap<java.lang.String,DynamicPropertyDescriptor>getDynamicProps()java.lang.StringgetPath()DynamicPropertyDescriptor[]getProperties()java.lang.ObjectgetPropertyValue(java.lang.String name)QualityCodegetQuality()Retrieves the data quality code.intgetRotation()intgetStretchHeight()intgetStretchMode()intgetStretchWidth()DatasetgetStyles()java.awt.ColorgetSwapFromColor()intgetSwapThreshold()java.awt.ColorgetSwapToColor()java.awt.ColorgetTintColor()java.lang.StringgetToolTipText()booleanimageUpdate(java.awt.Image img, int infoflags, int x, int y, int w, int h)booleanisComponentEnabled()booleanisFlipHorizontal()booleanisFlipVertical()booleanisLoadInBackground()booleanisPropertyDefined(java.lang.String name)booleanisUseCache()booleanisUseColorSwap()booleanisUseTint()voidlocaleChanged(java.util.Locale newLocale)protected voidpaintChildren(java.awt.Graphics g)protected voidpaintComponent(java.awt.Graphics g)voidsetAntiAlias(boolean b)Deprecated.voidsetComponentEnabled(boolean componentEnabled)voidsetCursorCode(int cursorCode)voidsetDataQuality(int value)voidsetDisabledPath(java.lang.String string)voidsetDynamicProps(java.util.TreeMap<java.lang.String,DynamicPropertyDescriptor> map)voidsetFlipHorizontal(boolean flipHorizontal)voidsetFlipVertical(boolean flipVertical)voidsetLoadInBackground(boolean loadInBackground)voidsetName(java.lang.String newName)voidsetPath(java.lang.String newPath)voidsetPropertyValue(java.lang.String name, java.lang.Object value)voidsetQuality(QualityCode value)Sets the current data quality to the given valuevoidsetRotation(int i)voidsetStretch(boolean b)Deprecated.voidsetStretchHeight(int stretchHeight)voidsetStretchMode(int stretchMode)voidsetStretchWidth(int stretchWidth)voidsetStyles(Dataset styleDS)voidsetSwapFromColor(java.awt.Color color)voidsetSwapThreshold(int swapThreshold)voidsetSwapToColor(java.awt.Color color)voidsetTintColor(java.awt.Color color)voidsetToolTipText(java.lang.String text)voidsetUseCache(boolean useCache)voidsetUseColorSwap(boolean b)voidsetUseTint(boolean b)voidsetVisible(boolean visible)voidshutdownComponent()Called when the component is now shown anymore.voidstartupComponent(VisionClientContext context)Called when the component is first shown.voidupdateQuality(java.lang.String propName, QualityCode quality)Updates the quality for the given property name.protected voidupdateStretch()-
Methods inherited from class javax.swing.JLabel
checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPosition, 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, 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, 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, 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
-
STRETCH_OFF
public static final int STRETCH_OFF
- See Also:
- Constant Field Values
-
STRETCH_TO_BOUNDS
public static final int STRETCH_TO_BOUNDS
- See Also:
- Constant Field Values
-
STRETCH_TO_BOUNDS_PCT
public static final int STRETCH_TO_BOUNDS_PCT
- See Also:
- Constant Field Values
-
STRETCH_TO_PARAM
public static final int STRETCH_TO_PARAM
- See Also:
- Constant Field Values
-
cursorCode
protected int cursorCode
-
context
protected VisionClientContext context
The current ClientContext that is set on startupComponent()
-
-
Method Detail
-
imageUpdate
public boolean imageUpdate(java.awt.Image img, int infoflags, int x, int y, int w, int h)- Specified by:
imageUpdatein interfacejava.awt.image.ImageObserver- Overrides:
imageUpdatein classjavax.swing.JLabel
-
setName
public void setName(java.lang.String newName)
- Overrides:
setNamein classjava.awt.Component
-
setToolTipText
public void setToolTipText(java.lang.String text)
- Overrides:
setToolTipTextin classjavax.swing.JComponent
-
getToolTipText
public java.lang.String getToolTipText()
- Overrides:
getToolTipTextin classjavax.swing.JComponent
-
getCursorCode
public int getCursorCode()
-
setCursorCode
public void setCursorCode(int cursorCode)
-
isComponentEnabled
public boolean isComponentEnabled()
- Specified by:
isComponentEnabledin interfaceEnabledEx
-
setComponentEnabled
public void setComponentEnabled(boolean componentEnabled)
- Specified by:
setComponentEnabledin interfaceEnabledEx
-
evaluateEnabled
public void evaluateEnabled()
- Specified by:
evaluateEnabledin interfaceEnabledEx
-
setVisible
public void setVisible(boolean visible)
- Overrides:
setVisiblein classjavax.swing.JComponent
-
addActionListener
public void addActionListener(java.awt.event.ActionListener al)
-
getRotation
public int getRotation()
-
setRotation
public void setRotation(int i)
-
paintComponent
protected void paintComponent(java.awt.Graphics g)
- Overrides:
paintComponentin classjavax.swing.JComponent
-
setAntiAlias
@Deprecated public void setAntiAlias(boolean b)
Deprecated.for backwards compatibility
-
getPath
public java.lang.String getPath()
-
setPath
public void setPath(java.lang.String newPath)
-
getDisabledPath
public java.lang.String getDisabledPath()
-
setDisabledPath
public void setDisabledPath(java.lang.String string)
-
setUseCache
public void setUseCache(boolean useCache)
-
isUseCache
public boolean isUseCache()
-
setLoadInBackground
public void setLoadInBackground(boolean loadInBackground)
-
isLoadInBackground
public boolean isLoadInBackground()
-
updateStretch
protected void updateStretch()
-
setStretch
@Deprecated public void setStretch(boolean b)
Deprecated.For backwards Compatability
-
localeChanged
public void localeChanged(java.util.Locale newLocale)
- Specified by:
localeChangedin interfaceLocaleListener
-
getSwapFromColor
public java.awt.Color getSwapFromColor()
-
getSwapToColor
public java.awt.Color getSwapToColor()
-
getTintColor
public java.awt.Color getTintColor()
-
isUseColorSwap
public boolean isUseColorSwap()
-
isUseTint
public boolean isUseTint()
-
setSwapFromColor
public void setSwapFromColor(java.awt.Color color)
-
setSwapToColor
public void setSwapToColor(java.awt.Color color)
-
getSwapThreshold
public int getSwapThreshold()
-
setSwapThreshold
public void setSwapThreshold(int swapThreshold)
-
setTintColor
public void setTintColor(java.awt.Color color)
-
setUseColorSwap
public void setUseColorSwap(boolean b)
-
setUseTint
public void setUseTint(boolean b)
-
getStretchHeight
public int getStretchHeight()
-
setStretchHeight
public void setStretchHeight(int stretchHeight)
-
getStretchMode
public int getStretchMode()
-
setStretchMode
public void setStretchMode(int stretchMode)
-
getStretchWidth
public int getStretchWidth()
-
setStretchWidth
public void setStretchWidth(int stretchWidth)
-
isFlipHorizontal
public boolean isFlipHorizontal()
-
setFlipHorizontal
public void setFlipHorizontal(boolean flipHorizontal)
-
isFlipVertical
public boolean isFlipVertical()
-
setFlipVertical
public void setFlipVertical(boolean flipVertical)
-
getDynamicProps
public java.util.TreeMap<java.lang.String,DynamicPropertyDescriptor> getDynamicProps()
- Specified by:
getDynamicPropsin interfaceMutableDynamicPropertyProvider
-
setDynamicProps
public void setDynamicProps(java.util.TreeMap<java.lang.String,DynamicPropertyDescriptor> map)
- Specified by:
setDynamicPropsin interfaceMutableDynamicPropertyProvider
-
setPropertyValue
public void setPropertyValue(java.lang.String name, java.lang.Object value) throws java.lang.ClassCastException- Specified by:
setPropertyValuein interfaceDynamicPropertyProvider- Throws:
java.lang.ClassCastException
-
getPropertyValue
public java.lang.Object getPropertyValue(java.lang.String name)
- Specified by:
getPropertyValuein interfaceDynamicPropertyProvider
-
getProperties
public DynamicPropertyDescriptor[] getProperties()
- Specified by:
getPropertiesin interfaceDynamicPropertyProvider
-
isPropertyDefined
public boolean isPropertyDefined(java.lang.String name)
- Specified by:
isPropertyDefinedin interfaceDynamicPropertyProvider
-
getQuality
public QualityCode getQuality()
Description copied from interface:QualityMonitorRetrieves the data quality code.- Specified by:
getQualityin interfaceQualityMonitor
-
getDataQuality
public int getDataQuality()
Description copied from interface:QualityMonitorFor 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:
getDataQualityin interfaceQualityMonitor
-
setDataQuality
public void setDataQuality(int value)
- Specified by:
setDataQualityin interfaceQualityMonitor
-
setQuality
public void setQuality(QualityCode value)
Description copied from interface:QualityMonitorSets the current data quality to the given value- Specified by:
setQualityin interfaceQualityMonitor
-
updateQuality
public void updateQuality(java.lang.String propName, QualityCode quality)Description copied from interface:QualityMonitorUpdates 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:
updateQualityin interfaceQualityMonitor
-
paintChildren
protected void paintChildren(java.awt.Graphics g)
- Overrides:
paintChildrenin classjavax.swing.JComponent
-
getStyles
public Dataset getStyles()
- Specified by:
getStylesin interfaceStyleProvider
-
setStyles
public void setStyles(Dataset styleDS)
- Specified by:
setStylesin interfaceStyleProvider
-
startupComponent
public final void startupComponent(VisionClientContext context)
Description copied from interface:ComponentLifecycleCalled when the component is first shown.- Specified by:
startupComponentin interfaceComponentLifecycle
-
shutdownComponent
public final void shutdownComponent()
Description copied from interface:ComponentLifecycleCalled when the component is now shown anymore. Any long-running processes should be stopped. All bindings will have also been shutdown.- Specified by:
shutdownComponentin interfaceComponentLifecycle
-
getAppContext
public VisionClientContext getAppContext()
- Specified by:
getAppContextin interfaceComponentLifecycle
-
-