Package com.inductiveautomation.factorypmi.application.components

Class PMILabel

    • 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

      • Nested classes/interfaces inherited from class java.awt.Container

        java.awt.Container.AccessibleAWTContainer

      • Nested classes/interfaces inherited from class java.awt.Component

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected boolean antialias  
      protected VisionClientContext context
      The current ClientContext that is set on startupComponent()
      protected int cursorCode  
      protected boolean fillBackground  
      protected int rotation  

      • Fields inherited from class javax.swing.JLabel

        labelFor

      • 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 java.awt.image.ImageObserver

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

      • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      PMILabel()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void evaluateEnabled()  
      VisionClientContext getAppContext()  
      int getCursorCode()  
      int getDataQuality()
      For backwards compatibility with scripts.
      java.lang.String getDisabledPath()  
      java.util.TreeMap<java.lang.String,​DynamicPropertyDescriptor> getDynamicProps()  
      java.lang.String getPath()  
      DynamicPropertyDescriptor[] getProperties()  
      java.lang.Object getPropertyValue​(java.lang.String name)  
      QualityCode getQuality()
      Retrieves the data quality code.
      int getRotation()  
      Dataset getStyles()  
      java.lang.String getText()  
      java.lang.String getToolTipText()  
      boolean isAntialias()  
      boolean isComponentEnabled()  
      boolean isFillBackground()  
      boolean isOpaque()  
      boolean isPropertyDefined​(java.lang.String name)  
      void localeChanged​(java.util.Locale newLocale)  
      protected void paintChildren​(java.awt.Graphics g)  
      protected void paintComponent​(java.awt.Graphics g)  
      void setAntialias​(boolean ignored)  
      void setBackground​(java.awt.Color bg)  
      void setComponentEnabled​(boolean componentEnabled)  
      void setCursorCode​(int cursorCode)  
      void setDataQuality​(int value)  
      void setDisabledPath​(java.lang.String string)  
      void setDynamicProps​(java.util.TreeMap<java.lang.String,​DynamicPropertyDescriptor> map)  
      void setFillBackground​(boolean fillBackground)  
      void setForeground​(java.awt.Color fg)  
      void setName​(java.lang.String newName)  
      void setPath​(java.lang.String string)  
      void setPropertyValue​(java.lang.String name, java.lang.Object value)  
      void setQuality​(QualityCode value)
      Sets the current data quality to the given value
      void setRotation​(int rotation)  
      void setStyles​(Dataset styleDS)  
      void setToolTipText​(java.lang.String text)  
      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.
      java.lang.String toString()  
      void updateQuality​(java.lang.String propName, QualityCode quality)
      Updates the quality for the given property name.

      • Methods inherited from class javax.swing.JLabel

        checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, 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, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, 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, transferFocus, transferFocusBackward, transferFocusUpCycle

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • rotation

        protected int rotation

      • antialias

        protected boolean antialias

      • cursorCode

        protected int cursorCode

      • fillBackground

        protected boolean fillBackground

      • context

        protected VisionClientContext context
        The current ClientContext that is set on startupComponent()

    • Constructor Detail

      • PMILabel

        public PMILabel()

    • Method Detail

      • setName

        public void setName​(java.lang.String newName)
        Overrides:
        setName in class java.awt.Component

      • getToolTipText

        public java.lang.String getToolTipText()
        Overrides:
        getToolTipText in class javax.swing.JComponent

      • setToolTipText

        public void setToolTipText​(java.lang.String text)
        Overrides:
        setToolTipText in class javax.swing.JComponent

      • getCursorCode

        public int getCursorCode()

      • setCursorCode

        public void setCursorCode​(int cursorCode)

      • setComponentEnabled

        public void setComponentEnabled​(boolean componentEnabled)
        Specified by:
        setComponentEnabled in interface EnabledEx

      • setVisible

        public void setVisible​(boolean visible)
        Overrides:
        setVisible in class javax.swing.JComponent

      • getPath

        public java.lang.String getPath()

      • paintComponent

        protected void paintComponent​(java.awt.Graphics g)
        Overrides:
        paintComponent in class javax.swing.JComponent

      • setPath

        public void setPath​(java.lang.String string)

      • getDisabledPath

        public java.lang.String getDisabledPath()

      • setDisabledPath

        public void setDisabledPath​(java.lang.String string)

      • isFillBackground

        public boolean isFillBackground()

      • setFillBackground

        public void setFillBackground​(boolean fillBackground)

      • isOpaque

        public boolean isOpaque()
        Overrides:
        isOpaque in class javax.swing.JComponent

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.awt.Component

      • setBackground

        public void setBackground​(java.awt.Color bg)
        Overrides:
        setBackground in class javax.swing.JComponent

      • setForeground

        public void setForeground​(java.awt.Color fg)
        Overrides:
        setForeground in class javax.swing.JComponent

      • getRotation

        public int getRotation()

      • setRotation

        public void setRotation​(int rotation)

      • isAntialias

        public boolean isAntialias()

      • setAntialias

        public void setAntialias​(boolean ignored)

      • setPropertyValue

        public void setPropertyValue​(java.lang.String name,
                             java.lang.Object value)
                      throws java.lang.ClassCastException
        Specified by:
        setPropertyValue in interface DynamicPropertyProvider
        Throws:
        java.lang.ClassCastException

      • 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

      • 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 interface QualityMonitor

      • paintChildren

        protected void paintChildren​(java.awt.Graphics g)
        Overrides:
        paintChildren in class javax.swing.JComponent

      • 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

      • getText

        public java.lang.String getText()
        Overrides:
        getText in class javax.swing.JLabel