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.JLabeljavax.swing.JLabel.AccessibleJLabel
 - 
Nested classes/interfaces inherited from class javax.swing.JComponentjavax.swing.JComponent.AccessibleJComponent
 
- 
 - 
Field SummaryFields 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.JComponentlistenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
 - 
Fields inherited from class java.awt.ComponentaccessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 - 
Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.ComponentLifecycleCOMPONENT_RUNNING
 - 
Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.EnabledExDISABLED_BY_PERMISSIONS
 - 
Fields inherited from interface java.awt.image.ImageObserverABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 - 
Fields inherited from interface com.inductiveautomation.ignition.client.model.LocaleListenerLOCAL_CHANGE_EVENT
 - 
Fields inherited from interface com.inductiveautomation.vision.api.client.binding.MutableDynamicPropertyProviderRESERVED_SET_KEY
 - 
Fields inherited from interface javax.swing.SwingConstantsBOTTOM, 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.VisionComponentCOMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS
 
- 
 - 
Constructor SummaryConstructors Constructor Description PMIImage()
 - 
Method SummaryAll 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.JLabelcheckHorizontalKey, 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.JComponentaddAncestorListener, 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.Containeradd, 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.Componentaction, 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_OFFpublic static final int STRETCH_OFF - See Also:
- Constant Field Values
 
 - 
STRETCH_TO_BOUNDSpublic static final int STRETCH_TO_BOUNDS - See Also:
- Constant Field Values
 
 - 
STRETCH_TO_BOUNDS_PCTpublic static final int STRETCH_TO_BOUNDS_PCT - See Also:
- Constant Field Values
 
 - 
STRETCH_TO_PARAMpublic static final int STRETCH_TO_PARAM - See Also:
- Constant Field Values
 
 - 
cursorCodeprotected int cursorCode 
 - 
contextprotected VisionClientContext context The current ClientContext that is set on startupComponent()
 
- 
 - 
Method Detail- 
imageUpdatepublic boolean imageUpdate(java.awt.Image img, int infoflags, int x, int y, int w, int h)- Specified by:
- imageUpdatein interface- java.awt.image.ImageObserver
- Overrides:
- imageUpdatein class- javax.swing.JLabel
 
 - 
setNamepublic void setName(java.lang.String newName) - Overrides:
- setNamein class- java.awt.Component
 
 - 
setToolTipTextpublic void setToolTipText(java.lang.String text) - Overrides:
- setToolTipTextin class- javax.swing.JComponent
 
 - 
getToolTipTextpublic java.lang.String getToolTipText() - Overrides:
- getToolTipTextin class- javax.swing.JComponent
 
 - 
getCursorCodepublic int getCursorCode() 
 - 
setCursorCodepublic void setCursorCode(int cursorCode) 
 - 
isComponentEnabledpublic boolean isComponentEnabled() - Specified by:
- isComponentEnabledin interface- EnabledEx
 
 - 
setComponentEnabledpublic void setComponentEnabled(boolean componentEnabled) - Specified by:
- setComponentEnabledin interface- EnabledEx
 
 - 
evaluateEnabledpublic void evaluateEnabled() - Specified by:
- evaluateEnabledin interface- EnabledEx
 
 - 
setVisiblepublic void setVisible(boolean visible) - Overrides:
- setVisiblein class- javax.swing.JComponent
 
 - 
addActionListenerpublic void addActionListener(java.awt.event.ActionListener al) 
 - 
getRotationpublic int getRotation() 
 - 
setRotationpublic void setRotation(int i) 
 - 
paintComponentprotected void paintComponent(java.awt.Graphics g) - Overrides:
- paintComponentin class- javax.swing.JComponent
 
 - 
setAntiAlias@Deprecated public void setAntiAlias(boolean b) Deprecated.for backwards compatibility
 - 
getPathpublic java.lang.String getPath() 
 - 
setPathpublic void setPath(java.lang.String newPath) 
 - 
getDisabledPathpublic java.lang.String getDisabledPath() 
 - 
setDisabledPathpublic void setDisabledPath(java.lang.String string) 
 - 
setUseCachepublic void setUseCache(boolean useCache) 
 - 
isUseCachepublic boolean isUseCache() 
 - 
setLoadInBackgroundpublic void setLoadInBackground(boolean loadInBackground) 
 - 
isLoadInBackgroundpublic boolean isLoadInBackground() 
 - 
updateStretchprotected void updateStretch() 
 - 
setStretch@Deprecated public void setStretch(boolean b) Deprecated.For backwards Compatability
 - 
localeChangedpublic void localeChanged(java.util.Locale newLocale) - Specified by:
- localeChangedin interface- LocaleListener
 
 - 
getSwapFromColorpublic java.awt.Color getSwapFromColor() 
 - 
getSwapToColorpublic java.awt.Color getSwapToColor() 
 - 
getTintColorpublic java.awt.Color getTintColor() 
 - 
isUseColorSwappublic boolean isUseColorSwap() 
 - 
isUseTintpublic boolean isUseTint() 
 - 
setSwapFromColorpublic void setSwapFromColor(java.awt.Color color) 
 - 
setSwapToColorpublic void setSwapToColor(java.awt.Color color) 
 - 
getSwapThresholdpublic int getSwapThreshold() 
 - 
setSwapThresholdpublic void setSwapThreshold(int swapThreshold) 
 - 
setTintColorpublic void setTintColor(java.awt.Color color) 
 - 
setUseColorSwappublic void setUseColorSwap(boolean b) 
 - 
setUseTintpublic void setUseTint(boolean b) 
 - 
getStretchHeightpublic int getStretchHeight() 
 - 
setStretchHeightpublic void setStretchHeight(int stretchHeight) 
 - 
getStretchModepublic int getStretchMode() 
 - 
setStretchModepublic void setStretchMode(int stretchMode) 
 - 
getStretchWidthpublic int getStretchWidth() 
 - 
setStretchWidthpublic void setStretchWidth(int stretchWidth) 
 - 
isFlipHorizontalpublic boolean isFlipHorizontal() 
 - 
setFlipHorizontalpublic void setFlipHorizontal(boolean flipHorizontal) 
 - 
isFlipVerticalpublic boolean isFlipVertical() 
 - 
setFlipVerticalpublic void setFlipVertical(boolean flipVertical) 
 - 
getDynamicPropspublic java.util.TreeMap<java.lang.String,DynamicPropertyDescriptor> getDynamicProps() - Specified by:
- getDynamicPropsin interface- MutableDynamicPropertyProvider
 
 - 
setDynamicPropspublic void setDynamicProps(java.util.TreeMap<java.lang.String,DynamicPropertyDescriptor> map) - Specified by:
- setDynamicPropsin interface- MutableDynamicPropertyProvider
 
 - 
setPropertyValuepublic void setPropertyValue(java.lang.String name, java.lang.Object value) throws java.lang.ClassCastException- Specified by:
- setPropertyValuein interface- DynamicPropertyProvider
- Throws:
- java.lang.ClassCastException
 
 - 
getPropertyValuepublic java.lang.Object getPropertyValue(java.lang.String name) - Specified by:
- getPropertyValuein interface- DynamicPropertyProvider
 
 - 
getPropertiespublic DynamicPropertyDescriptor[] getProperties() - Specified by:
- getPropertiesin interface- DynamicPropertyProvider
 
 - 
isPropertyDefinedpublic boolean isPropertyDefined(java.lang.String name) - Specified by:
- isPropertyDefinedin interface- DynamicPropertyProvider
 
 - 
getQualitypublic QualityCode getQuality() Description copied from interface:QualityMonitorRetrieves the data quality code.- Specified by:
- getQualityin interface- QualityMonitor
 
 - 
getDataQualitypublic 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 interface- QualityMonitor
 
 - 
setDataQualitypublic void setDataQuality(int value) - Specified by:
- setDataQualityin interface- QualityMonitor
 
 - 
setQualitypublic void setQuality(QualityCode value) Description copied from interface:QualityMonitorSets the current data quality to the given value- Specified by:
- setQualityin interface- QualityMonitor
 
 - 
updateQualitypublic 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 interface- QualityMonitor
 
 - 
paintChildrenprotected void paintChildren(java.awt.Graphics g) - Overrides:
- paintChildrenin class- javax.swing.JComponent
 
 - 
getStylespublic Dataset getStyles() - Specified by:
- getStylesin interface- StyleProvider
 
 - 
setStylespublic void setStyles(Dataset styleDS) - Specified by:
- setStylesin interface- StyleProvider
 
 - 
startupComponentpublic final void startupComponent(VisionClientContext context) Description copied from interface:ComponentLifecycleCalled when the component is first shown.- Specified by:
- startupComponentin interface- ComponentLifecycle
 
 - 
shutdownComponentpublic 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 interface- ComponentLifecycle
 
 - 
getAppContextpublic VisionClientContext getAppContext() - Specified by:
- getAppContextin interface- ComponentLifecycle
 
 
- 
 
-