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 Summary
Nested ClassesModifier and TypeClassDescriptionclassclassNested classes/interfaces inherited from class javax.swing.JComboBox
JComboBox.AccessibleJComboBox, JComboBox.KeySelectionManagerNested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponentNested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainerNested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy -
Field Summary
FieldsModifier 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.JComboBox
actionCommand, dataModel, editor, isEditable, keySelectionManager, lightWeightPopupEnabled, maximumRowCount, renderer, selectedItemReminderFields inherited from class javax.swing.JComponent
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOWFields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENTFields inherited from interface com.inductiveautomation.vision.api.client.components.model.ComponentLifecycle
COMPONENT_RUNNINGFields inherited from interface com.inductiveautomation.vision.api.client.components.model.EnabledEx
DISABLED_BY_PERMISSIONSFields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTHFields inherited from interface com.inductiveautomation.ignition.client.model.LocaleListener
LOCAL_CHANGE_EVENTFields inherited from interface com.inductiveautomation.vision.api.client.binding.MutableDynamicPropertyProvider
RESERVED_SET_KEYFields 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 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.JComboBox
actionPerformed, 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.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, updateMethods 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, validateTreeMethods 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
-
Field Details
-
MODE_STRICT
public static final int MODE_STRICT- See Also:
-
MODE_LENIENT
public static final int MODE_LENIENT- See Also:
-
MODE_EDITABLE
public static final int MODE_EDITABLE- See Also:
-
LIST
public static final int LIST- See Also:
-
TABLE
public static final int TABLE- See Also:
-
LABEL_FORMAT
- See Also:
-
model
-
selectionBackground
-
data
-
cursorCode
protected int cursorCode -
antialias
protected boolean antialias -
context
The current ClientContext that is set on startupComponent()
-
-
Constructor Details
-
PMIComboBox
public PMIComboBox()
-
-
Method Details
-
translateTerm
-
getCursorCode
public int getCursorCode() -
setCursorCode
public void setCursorCode(int cursorCode) -
isComponentEnabled
public boolean isComponentEnabled()- Specified by:
isComponentEnabledin interfaceEnabledEx
-
setComponentEnabled
public void setComponentEnabled(boolean componentEnabled) - Specified by:
setComponentEnabledin interfaceEnabledEx
-
evaluateEnabled
public void evaluateEnabled()- Specified by:
evaluateEnabledin interfaceEnabledEx
-
setVisible
public void setVisible(boolean visible) - Overrides:
setVisiblein classJComponent
-
setSelectedItem
- Overrides:
setSelectedItemin classJComboBox
-
setToolTipText
- Overrides:
setToolTipTextin classJComponent
-
getToolTipText
- Overrides:
getToolTipTextin classJComponent
-
isAntialias
public boolean isAntialias() -
setAntialias
public void setAntialias(boolean ignored) -
getMode
public int getMode() -
setMode
public void setMode(int mode) -
setName
-
getData
-
getTranslatedData
-
setData
-
getSelectedValue
-
getSelectedStringValue
-
getSelectedLabel
-
getSelectedItem
public com.inductiveautomation.factorypmi.application.components.PMIComboBox.DataSetComboBoxModel.CBSelection getSelectedItem()- Overrides:
getSelectedItemin classJComboBox
-
setSelectedValue
-
setSelectedStringValue
-
setSelectedValue
- Throws:
org.python.core.PyIgnoreMethodTag
-
setSelectedLabel
-
localeChanged
- Specified by:
localeChangedin interfaceLocaleListener
-
isOpaque
public boolean isOpaque()- Overrides:
isOpaquein classJComponent
-
getHorizontalAlignment
public int getHorizontalAlignment() -
setHorizontalAlignment
public void setHorizontalAlignment(int horizontalAlignment) -
getVerticalAlignment
public int getVerticalAlignment() -
setVerticalAlignment
public void setVerticalAlignment(int verticalAlignment) -
getSelectionBackground
-
setSelectionBackground
-
setNoSelection
protected void setNoSelection(com.inductiveautomation.factorypmi.application.components.PMIComboBox.DataSetComboBoxModel.CBSelection sel) -
getNoSelectionValue
public int getNoSelectionValue() -
setNoSelectionValue
public void setNoSelectionValue(int noSelectionValue) -
getNoSelectionString
-
setNoSelectionString
-
getNoSelectionLabel
-
setNoSelectionLabel
-
isShowTableHeader
public boolean isShowTableHeader() -
setShowTableHeader
public void setShowTableHeader(boolean showTableHeader) -
getHideTableColumns
-
setHideTableColumns
-
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) -
selectWithKeyChar
public boolean selectWithKeyChar(char keyChar) - Overrides:
selectWithKeyCharin classJComboBox
-
getDynamicProps
- Specified by:
getDynamicPropsin interfaceMutableDynamicPropertyProvider
-
setDynamicProps
- Specified by:
setDynamicPropsin interfaceMutableDynamicPropertyProvider
-
setPropertyValue
- Specified by:
setPropertyValuein interfaceDynamicPropertyProvider- Throws:
ClassCastException
-
getPropertyValue
- Specified by:
getPropertyValuein interfaceDynamicPropertyProvider
-
getProperties
- Specified by:
getPropertiesin interfaceDynamicPropertyProvider
-
isPropertyDefined
- Specified by:
isPropertyDefinedin interfaceDynamicPropertyProvider
-
getQuality
Description copied from interface:QualityMonitorRetrieves the data quality code.- Specified by:
getQualityin interfaceQualityMonitor
-
getDataQuality
public 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 interfaceQualityMonitor
-
setDataQuality
public void setDataQuality(int value) - Specified by:
setDataQualityin interfaceQualityMonitor
-
setQuality
Description copied from interface:QualityMonitorSets the current data quality to the given value- Specified by:
setQualityin interfaceQualityMonitor
-
updateQuality
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 interfaceQualityMonitor
-
paintChildren
- Overrides:
paintChildrenin classJComponent
-
paintComponent
- Overrides:
paintComponentin classJComponent
-
getStyles
- Specified by:
getStylesin interfaceStyleProvider
-
setStyles
- Specified by:
setStylesin interfaceStyleProvider
-
startupComponent
Description copied from interface:ComponentLifecycleCalled when the component is first shown.- Specified by:
startupComponentin interfaceComponentLifecycle
-
shutdownComponent
public 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 interfaceComponentLifecycle
-
getAppContext
- Specified by:
getAppContextin interfaceComponentLifecycle
-