Package com.inductiveautomation.factorypmi.application.components

Class PMIComboBox

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      class  PMIComboBox.DataSetComboBoxModel  
      class  PMIComboBox.DataSetListCellRenderer  

      • Nested classes/interfaces inherited from class javax.swing.JComboBox

        javax.swing.JComboBox.AccessibleJComboBox, javax.swing.JComboBox.KeySelectionManager

      • 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

    • Constructor Summary

      Constructors 
      Constructor Description
      PMIComboBox()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void contentsChanged​(javax.swing.event.ListDataEvent e)  
      void evaluateEnabled()  
      VisionClientContext getAppContext()  
      int getCursorCode()  
      Dataset getData()  
      int getDataQuality()
      For backwards compatibility with scripts.
      java.util.TreeMap<java.lang.String,​DynamicPropertyDescriptor> getDynamicProps()  
      int getEffectiveRowHeight()
      When the actual row height is -1, an automatic height is chosen from the current font metrics in order to fit the dropdown options.
      java.lang.String getHideTableColumns()  
      int getHorizontalAlignment()  
      int getMaxTableHeight()  
      int getMaxTableWidth()  
      int getMode()  
      java.lang.String getNoSelectionLabel()  
      java.lang.String getNoSelectionString()  
      int getNoSelectionValue()  
      DynamicPropertyDescriptor[] getProperties()  
      java.lang.Object getPropertyValue​(java.lang.String name)  
      QualityCode getQuality()
      Retrieves the data quality code.
      int getRowHeight()  
      com.inductiveautomation.factorypmi.application.components.PMIComboBox.DataSetComboBoxModel.CBSelection getSelectedItem()  
      java.lang.String getSelectedLabel()  
      java.lang.String getSelectedStringValue()  
      java.lang.Integer getSelectedValue()  
      java.awt.Color getSelectionBackground()  
      int getSelectionMode()  
      Dataset getStyles()  
      java.lang.String getToolTipText()  
      Dataset getTranslatedData()  
      int getVerticalAlignment()  
      boolean isAntialias()  
      boolean isComponentEnabled()  
      boolean isOpaque()  
      boolean isPropertyDefined​(java.lang.String name)  
      boolean isShowTableHeader()  
      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 setComponentEnabled​(boolean componentEnabled)  
      void setCursorCode​(int cursorCode)  
      void setData​(Dataset set)  
      void setDataQuality​(int value)  
      void setDynamicProps​(java.util.TreeMap<java.lang.String,​DynamicPropertyDescriptor> map)  
      void setHideTableColumns​(java.lang.String hideTableColumns)  
      void setHorizontalAlignment​(int horizontalAlignment)  
      void setMaxTableHeight​(int maxTableHeight)  
      void setMaxTableWidth​(int maxTableWidth)  
      void setMode​(int mode)  
      void setName​(java.lang.String newName)  
      protected void setNoSelection​(com.inductiveautomation.factorypmi.application.components.PMIComboBox.DataSetComboBoxModel.CBSelection sel)  
      void setNoSelectionLabel​(java.lang.String noSelectionLabel)  
      void setNoSelectionString​(java.lang.String noSelectionString)  
      void setNoSelectionValue​(int noSelectionValue)  
      void setPropertyValue​(java.lang.String name, java.lang.Object value)  
      void setQuality​(QualityCode value)
      Sets the current data quality to the given value
      void setRowHeight​(int rowHeight)  
      void setSelectedItem​(java.lang.Object anObject)  
      void setSelectedLabel​(java.lang.String value)  
      void setSelectedStringValue​(java.lang.String value)  
      void setSelectedValue​(java.lang.Integer value)  
      void setSelectedValue​(java.lang.Number n)  
      void setSelectionBackground​(java.awt.Color selectionColor)  
      void setSelectionMode​(int selectionMode)  
      void setShowTableHeader​(boolean showTableHeader)  
      void setStyles​(Dataset styleDS)  
      void setToolTipText​(java.lang.String text)  
      void setVerticalAlignment​(int verticalAlignment)  
      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.
      protected java.lang.String translateTerm​(java.lang.String term)  
      void updateQuality​(java.lang.String propName, QualityCode quality)
      Updates the quality for the given property name.

      • Methods inherited from class javax.swing.JComboBox

        actionPerformed, actionPropertyChanged, addActionListener, addItem, addItemListener, addPopupMenuListener, configureEditor, configurePropertiesFromAction, createActionPropertyChangeListener, createDefaultKeySelectionManager, fireActionEvent, fireItemStateChanged, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getAction, getActionCommand, getActionListeners, getEditor, getItemAt, getItemCount, getItemListeners, getKeySelectionManager, getMaximumRowCount, getModel, getPopupMenuListeners, getPrototypeDisplayValue, getRenderer, getSelectedIndex, getSelectedObjects, getUI, getUIClassID, hidePopup, insertItemAt, installAncestorListener, intervalAdded, intervalRemoved, isEditable, isLightWeightPopupEnabled, isPopupVisible, paramString, processKeyBinding, processKeyEvent, removeActionListener, removeAllItems, removeItem, removeItemAt, removeItemListener, removePopupMenuListener, selectedItemChanged, selectWithKeyChar, setAction, setActionCommand, setEditable, setEditor, setEnabled, setKeySelectionManager, setLightWeightPopupEnabled, setMaximumRowCount, setModel, setPopupVisible, setPrototypeDisplayValue, setRenderer, setSelectedIndex, setUI, showPopup, 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, 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, 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, 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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • PMIComboBox

        public PMIComboBox()

    • Method Detail

      • translateTerm

        protected java.lang.String translateTerm​(java.lang.String term)

      • 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

      • setSelectedItem

        public void setSelectedItem​(java.lang.Object anObject)
        Overrides:
        setSelectedItem in class javax.swing.JComboBox

      • contentsChanged

        public void contentsChanged​(javax.swing.event.ListDataEvent e)
        Specified by:
        contentsChanged in interface javax.swing.event.ListDataListener
        Overrides:
        contentsChanged in class javax.swing.JComboBox

      • setToolTipText

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

      • getToolTipText

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

      • isAntialias

        public boolean isAntialias()

      • setAntialias

        public void setAntialias​(boolean ignored)

      • getMode

        public int getMode()

      • setMode

        public void setMode​(int mode)

      • setName

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

      • getData

        public Dataset getData()

      • getTranslatedData

        public Dataset getTranslatedData()

      • setData

        public void setData​(Dataset set)

      • getSelectedValue

        public java.lang.Integer getSelectedValue()

      • getSelectedStringValue

        public java.lang.String getSelectedStringValue()

      • getSelectedLabel

        public java.lang.String getSelectedLabel()

      • getSelectedItem

        public com.inductiveautomation.factorypmi.application.components.PMIComboBox.DataSetComboBoxModel.CBSelection getSelectedItem()
        Overrides:
        getSelectedItem in class javax.swing.JComboBox

      • setSelectedValue

        public void setSelectedValue​(java.lang.Integer value)

      • setSelectedStringValue

        public void setSelectedStringValue​(java.lang.String value)

      • setSelectedValue

        public void setSelectedValue​(java.lang.Number n)
                      throws org.python.core.PyIgnoreMethodTag
        Throws:
        org.python.core.PyIgnoreMethodTag

      • setSelectedLabel

        public void setSelectedLabel​(java.lang.String value)

      • isOpaque

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

      • getHorizontalAlignment

        public int getHorizontalAlignment()

      • setHorizontalAlignment

        public void setHorizontalAlignment​(int horizontalAlignment)

      • getVerticalAlignment

        public int getVerticalAlignment()

      • setVerticalAlignment

        public void setVerticalAlignment​(int verticalAlignment)

      • getSelectionBackground

        public java.awt.Color getSelectionBackground()

      • setSelectionBackground

        public void setSelectionBackground​(java.awt.Color selectionColor)

      • setNoSelection

        protected void setNoSelection​(com.inductiveautomation.factorypmi.application.components.PMIComboBox.DataSetComboBoxModel.CBSelection sel)

      • getNoSelectionValue

        public int getNoSelectionValue()

      • setNoSelectionValue

        public void setNoSelectionValue​(int noSelectionValue)

      • getNoSelectionString

        public java.lang.String getNoSelectionString()

      • setNoSelectionString

        public void setNoSelectionString​(java.lang.String noSelectionString)

      • getNoSelectionLabel

        public java.lang.String getNoSelectionLabel()

      • setNoSelectionLabel

        public void setNoSelectionLabel​(java.lang.String noSelectionLabel)

      • isShowTableHeader

        public boolean isShowTableHeader()

      • setShowTableHeader

        public void setShowTableHeader​(boolean showTableHeader)

      • getHideTableColumns

        public java.lang.String getHideTableColumns()

      • setHideTableColumns

        public void setHideTableColumns​(java.lang.String hideTableColumns)

      • getMaxTableWidth

        public int getMaxTableWidth()

      • setMaxTableWidth

        public void setMaxTableWidth​(int maxTableWidth)

      • getMaxTableHeight

        public int getMaxTableHeight()

      • setMaxTableHeight

        public void setMaxTableHeight​(int maxTableHeight)

      • getRowHeight

        public int getRowHeight()

      • getEffectiveRowHeight

        public int getEffectiveRowHeight()
        When the actual row height is -1, an automatic height is chosen from the current font metrics in order to fit the dropdown options. Call this to retrieve the current non-negative row height
        Returns:
        the current row height if >= 0, otherwise the height of the current font metrics

      • setRowHeight

        public void setRowHeight​(int rowHeight)

      • getSelectionMode

        public int getSelectionMode()

      • setSelectionMode

        public void setSelectionMode​(int selectionMode)

      • 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

      • paintComponent

        protected void paintComponent​(java.awt.Graphics g)
        Overrides:
        paintComponent 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