Class PMIComboBox
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JComboBox
com.inductiveautomation.factorypmi.application.components.PMIComboBox
- All Implemented Interfaces:
- DynamicPropertyProvider,- LocaleListener,- MutableDynamicPropertyProvider,- StyleProvider,- ComponentLifecycle,- EnabledEx,- QualityMonitor,- VisionComponent,- ActionListener,- ImageObserver,- ItemSelectable,- MenuContainer,- Serializable,- EventListener,- Accessible,- ListDataListener
public class PMIComboBox
extends JComboBox
implements MutableDynamicPropertyProvider, StyleProvider, VisionComponent, EnabledEx, LocaleListener
- See Also:
- 
Nested Class SummaryNested ClassesModifier and TypeClassDescriptionclassclassNested classes/interfaces inherited from class javax.swing.JComboBoxJComboBox.AccessibleJComboBox, JComboBox.KeySelectionManagerNested classes/interfaces inherited from class javax.swing.JComponentJComponent.AccessibleJComponentNested classes/interfaces inherited from class java.awt.ContainerContainer.AccessibleAWTContainerNested classes/interfaces inherited from class java.awt.ComponentComponent.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
- 
Field SummaryFieldsModifier and TypeFieldDescriptionprotected booleanprotected VisionClientContextThe current ClientContext that is set on startupComponent()protected intprotected Datasetstatic final Stringstatic final intstatic final intstatic final intstatic final intprotected PMIComboBox.DataSetComboBoxModelprotected Colorstatic final intFields inherited from class javax.swing.JComboBoxactionCommand, dataModel, editor, isEditable, keySelectionManager, lightWeightPopupEnabled, maximumRowCount, renderer, selectedItemReminderFields inherited from class javax.swing.JComponentlistenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class java.awt.ComponentaccessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface com.inductiveautomation.vision.api.client.components.model.ComponentLifecycleCOMPONENT_RUNNINGFields inherited from interface com.inductiveautomation.vision.api.client.components.model.EnabledExDISABLED_BY_PERMISSIONSFields inherited from interface java.awt.image.ImageObserverABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields inherited from interface com.inductiveautomation.ignition.client.model.LocaleListenerLOCAL_CHANGE_EVENTFields inherited from interface com.inductiveautomation.vision.api.client.binding.MutableDynamicPropertyProviderRESERVED_SET_KEYFields inherited from interface com.inductiveautomation.vision.api.client.components.model.VisionComponentCOMPONENT_LOCKED, COMPONENT_PERMISSIONS, COMPONENT_SECURITY, COMPONENT_TRANSLATIONS
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionvoidintgetData()intFor backwards compatibility with scripts.intWhen the actual row height is -1, an automatic height is chosen from the current font metrics in order to fit the dropdown options.intintintintgetMode()intgetPropertyValue(String name) Retrieves the data quality code.intcom.inductiveautomation.factorypmi.application.components.PMIComboBox.DataSetComboBoxModel.CBSelectionintintbooleanbooleanbooleanisOpaque()booleanisPropertyDefined(String name) booleanvoidlocaleChanged(Locale newLocale) protected voidprotected voidbooleanselectWithKeyChar(char keyChar) voidsetAntialias(boolean ignored) voidsetComponentEnabled(boolean componentEnabled) voidsetCursorCode(int cursorCode) voidvoidsetDataQuality(int value) voidvoidsetHideTableColumns(String hideTableColumns) voidsetHorizontalAlignment(int horizontalAlignment) voidsetMaxTableHeight(int maxTableHeight) voidsetMaxTableWidth(int maxTableWidth) voidsetMode(int mode) voidprotected voidsetNoSelection(com.inductiveautomation.factorypmi.application.components.PMIComboBox.DataSetComboBoxModel.CBSelection sel) voidsetNoSelectionLabel(String noSelectionLabel) voidsetNoSelectionString(String noSelectionString) voidsetNoSelectionValue(int noSelectionValue) voidsetPropertyValue(String name, Object value) voidsetQuality(QualityCode value) Sets the current data quality to the given valuevoidsetRowHeight(int rowHeight) voidsetSelectedItem(Object anObject) voidsetSelectedLabel(String value) voidsetSelectedStringValue(String value) voidsetSelectedValue(Integer value) voidvoidsetSelectionBackground(Color selectionColor) voidsetSelectionMode(int selectionMode) voidsetShowTableHeader(boolean showTableHeader) voidvoidsetToolTipText(String text) voidsetVerticalAlignment(int verticalAlignment) voidsetVisible(boolean visible) final voidCalled when the component is now shown anymore.final voidstartupComponent(VisionClientContext context) Called when the component is first shown.protected StringtranslateTerm(String term) voidupdateQuality(String propName, QualityCode quality) Updates the quality for the given property name.Methods inherited from class javax.swing.JComboBoxactionPerformed, actionPropertyChanged, addActionListener, addItem, addItemListener, addPopupMenuListener, configureEditor, configurePropertiesFromAction, contentsChanged, 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, setAction, setActionCommand, setEditable, setEditor, setEnabled, setKeySelectionManager, setLightWeightPopupEnabled, setMaximumRowCount, setModel, setPopupVisible, setPrototypeDisplayValue, setRenderer, setSelectedIndex, setUI, showPopup, updateUIMethods 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, 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, updateMethods 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, validateTreeMethods 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, 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
- 
Field Details- 
MODE_STRICTpublic static final int MODE_STRICT- See Also:
 
- 
MODE_LENIENTpublic static final int MODE_LENIENT- See Also:
 
- 
MODE_EDITABLEpublic static final int MODE_EDITABLE- See Also:
 
- 
LISTpublic static final int LIST- See Also:
 
- 
TABLEpublic static final int TABLE- See Also:
 
- 
LABEL_FORMAT- See Also:
 
- 
model
- 
selectionBackground
- 
data
- 
cursorCodeprotected int cursorCode
- 
antialiasprotected boolean antialias
- 
contextThe current ClientContext that is set on startupComponent()
 
- 
- 
Constructor Details- 
PMIComboBoxpublic PMIComboBox()
 
- 
- 
Method Details- 
translateTerm
- 
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- JComponent
 
- 
setSelectedItem- Overrides:
- setSelectedItemin class- JComboBox
 
- 
setToolTipText- Overrides:
- setToolTipTextin class- JComponent
 
- 
getToolTipText- Overrides:
- getToolTipTextin class- JComponent
 
- 
isAntialiaspublic boolean isAntialias()
- 
setAntialiaspublic void setAntialias(boolean ignored) 
- 
getModepublic int getMode()
- 
setModepublic void setMode(int mode) 
- 
setName
- 
getData
- 
getTranslatedData
- 
setData
- 
getSelectedValue
- 
getSelectedStringValue
- 
getSelectedLabel
- 
getSelectedItempublic com.inductiveautomation.factorypmi.application.components.PMIComboBox.DataSetComboBoxModel.CBSelection getSelectedItem()- Overrides:
- getSelectedItemin class- JComboBox
 
- 
setSelectedValue
- 
setSelectedStringValue
- 
setSelectedValue- Throws:
- org.python.core.PyIgnoreMethodTag
 
- 
setSelectedLabel
- 
localeChanged- Specified by:
- localeChangedin interface- LocaleListener
 
- 
isOpaquepublic boolean isOpaque()- Overrides:
- isOpaquein class- JComponent
 
- 
getHorizontalAlignmentpublic int getHorizontalAlignment()
- 
setHorizontalAlignmentpublic void setHorizontalAlignment(int horizontalAlignment) 
- 
getVerticalAlignmentpublic int getVerticalAlignment()
- 
setVerticalAlignmentpublic void setVerticalAlignment(int verticalAlignment) 
- 
getSelectionBackground
- 
setSelectionBackground
- 
setNoSelectionprotected void setNoSelection(com.inductiveautomation.factorypmi.application.components.PMIComboBox.DataSetComboBoxModel.CBSelection sel) 
- 
getNoSelectionValuepublic int getNoSelectionValue()
- 
setNoSelectionValuepublic void setNoSelectionValue(int noSelectionValue) 
- 
getNoSelectionString
- 
setNoSelectionString
- 
getNoSelectionLabel
- 
setNoSelectionLabel
- 
isShowTableHeaderpublic boolean isShowTableHeader()
- 
setShowTableHeaderpublic void setShowTableHeader(boolean showTableHeader) 
- 
getHideTableColumns
- 
setHideTableColumns
- 
getMaxTableWidthpublic int getMaxTableWidth()
- 
setMaxTableWidthpublic void setMaxTableWidth(int maxTableWidth) 
- 
getMaxTableHeightpublic int getMaxTableHeight()
- 
setMaxTableHeightpublic void setMaxTableHeight(int maxTableHeight) 
- 
getRowHeightpublic int getRowHeight()
- 
getEffectiveRowHeightpublic 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
 
- 
setRowHeightpublic void setRowHeight(int rowHeight) 
- 
getSelectionModepublic int getSelectionMode()
- 
setSelectionModepublic void setSelectionMode(int selectionMode) 
- 
selectWithKeyCharpublic boolean selectWithKeyChar(char keyChar) - Overrides:
- selectWithKeyCharin class- JComboBox
 
- 
getDynamicProps- Specified by:
- getDynamicPropsin interface- MutableDynamicPropertyProvider
 
- 
setDynamicProps- Specified by:
- setDynamicPropsin interface- MutableDynamicPropertyProvider
 
- 
setPropertyValue- Specified by:
- setPropertyValuein interface- DynamicPropertyProvider
- Throws:
- ClassCastException
 
- 
getPropertyValue- Specified by:
- getPropertyValuein interface- DynamicPropertyProvider
 
- 
getProperties- Specified by:
- getPropertiesin interface- DynamicPropertyProvider
 
- 
isPropertyDefined- Specified by:
- isPropertyDefinedin interface- DynamicPropertyProvider
 
- 
getQualityDescription 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
 
- 
setQualityDescription copied from interface:QualityMonitorSets the current data quality to the given value- Specified by:
- setQualityin interface- QualityMonitor
 
- 
updateQualityDescription 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
 
- 
paintChildren- Overrides:
- paintChildrenin class- JComponent
 
- 
paintComponent- Overrides:
- paintComponentin class- JComponent
 
- 
getStyles- Specified by:
- getStylesin interface- StyleProvider
 
- 
setStyles- Specified by:
- setStylesin interface- StyleProvider
 
- 
startupComponentDescription 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
 
- 
getAppContext- Specified by:
- getAppContextin interface- ComponentLifecycle
 
 
-