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
,ImageObserver
,MenuContainer
,Serializable
,Accessible
,SwingConstants
public class PMIImage
extends JLabel
implements MutableDynamicPropertyProvider, StyleProvider, VisionComponent, EnabledEx, LocaleListener
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class javax.swing.JLabel
JLabel.AccessibleJLabel
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
FieldsModifier and TypeFieldDescriptionprotected VisionClientContext
The current ClientContext that is set on startupComponent()protected int
static final int
static final int
static final int
static final int
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 -
Method Summary
Modifier and TypeMethodDescriptionvoid
void
int
int
For backwards compatibility with scripts.getPath()
getPropertyValue
(String name) Retrieves the data quality code.int
int
int
int
int
boolean
imageUpdate
(Image img, int infoflags, int x, int y, int w, int h) boolean
boolean
boolean
boolean
boolean
isPropertyDefined
(String name) boolean
boolean
boolean
void
localeChanged
(Locale newLocale) protected void
protected void
void
setAntiAlias
(boolean b) Deprecated.void
setComponentEnabled
(boolean componentEnabled) void
setCursorCode
(int cursorCode) void
setDataQuality
(int value) void
setDisabledPath
(String string) void
void
setFlipHorizontal
(boolean flipHorizontal) void
setFlipVertical
(boolean flipVertical) void
setLoadInBackground
(boolean loadInBackground) void
void
void
setPropertyValue
(String name, Object value) void
setQuality
(QualityCode value) Sets the current data quality to the given valuevoid
setRotation
(int i) void
setStretch
(boolean b) Deprecated.void
setStretchHeight
(int stretchHeight) void
setStretchMode
(int stretchMode) void
setStretchWidth
(int stretchWidth) void
void
setSwapFromColor
(Color color) void
setSwapThreshold
(int swapThreshold) void
setSwapToColor
(Color color) void
setTintColor
(Color color) void
setToolTipText
(String text) void
setUseCache
(boolean useCache) void
setUseColorSwap
(boolean b) void
setUseTint
(boolean b) void
setVisible
(boolean visible) final void
Called when the component is now shown anymore.final void
startupComponent
(VisionClientContext context) Called when the component is first shown.void
updateQuality
(String propName, QualityCode quality) Updates the quality for the given property name.protected void
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 Details
-
STRETCH_OFF
public static final int STRETCH_OFF- See Also:
-
STRETCH_TO_BOUNDS
public static final int STRETCH_TO_BOUNDS- See Also:
-
STRETCH_TO_BOUNDS_PCT
public static final int STRETCH_TO_BOUNDS_PCT- See Also:
-
STRETCH_TO_PARAM
public static final int STRETCH_TO_PARAM- See Also:
-
cursorCode
protected int cursorCode -
context
The current ClientContext that is set on startupComponent()
-
-
Constructor Details
-
PMIImage
public PMIImage()
-
-
Method Details
-
imageUpdate
- Specified by:
imageUpdate
in interfaceImageObserver
- Overrides:
imageUpdate
in classJLabel
-
setName
-
setToolTipText
- Overrides:
setToolTipText
in classJComponent
-
getToolTipText
- Overrides:
getToolTipText
in classJComponent
-
getCursorCode
public int getCursorCode() -
setCursorCode
public void setCursorCode(int cursorCode) -
isComponentEnabled
public boolean isComponentEnabled()- Specified by:
isComponentEnabled
in interfaceEnabledEx
-
setComponentEnabled
public void setComponentEnabled(boolean componentEnabled) - Specified by:
setComponentEnabled
in interfaceEnabledEx
-
evaluateEnabled
public void evaluateEnabled()- Specified by:
evaluateEnabled
in interfaceEnabledEx
-
setVisible
public void setVisible(boolean visible) - Overrides:
setVisible
in classJComponent
-
addActionListener
-
getRotation
public int getRotation() -
setRotation
public void setRotation(int i) -
paintComponent
- Overrides:
paintComponent
in classJComponent
-
setAntiAlias
Deprecated.for backwards compatibility -
getPath
-
setPath
-
getDisabledPath
-
setDisabledPath
-
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.For backwards Compatability -
localeChanged
- Specified by:
localeChanged
in interfaceLocaleListener
-
getSwapFromColor
-
getSwapToColor
-
getTintColor
-
isUseColorSwap
public boolean isUseColorSwap() -
isUseTint
public boolean isUseTint() -
setSwapFromColor
-
setSwapToColor
-
getSwapThreshold
public int getSwapThreshold() -
setSwapThreshold
public void setSwapThreshold(int swapThreshold) -
setTintColor
-
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
- Specified by:
getDynamicProps
in interfaceMutableDynamicPropertyProvider
-
setDynamicProps
- Specified by:
setDynamicProps
in interfaceMutableDynamicPropertyProvider
-
setPropertyValue
- Specified by:
setPropertyValue
in interfaceDynamicPropertyProvider
- Throws:
ClassCastException
-
getPropertyValue
- Specified by:
getPropertyValue
in interfaceDynamicPropertyProvider
-
getProperties
- Specified by:
getProperties
in interfaceDynamicPropertyProvider
-
isPropertyDefined
- Specified by:
isPropertyDefined
in interfaceDynamicPropertyProvider
-
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
Description copied from interface:QualityMonitor
Sets the current data quality to the given value- Specified by:
setQuality
in interfaceQualityMonitor
-
updateQuality
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
- Overrides:
paintChildren
in classJComponent
-
getStyles
- Specified by:
getStyles
in interfaceStyleProvider
-
setStyles
- Specified by:
setStyles
in interfaceStyleProvider
-
startupComponent
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
- Specified by:
getAppContext
in interfaceComponentLifecycle
-