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 TypeClassDescriptionclass
class
Nested classes/interfaces inherited from class javax.swing.JComboBox
JComboBox.AccessibleJComboBox, JComboBox.KeySelectionManager
Nested classes/interfaces inherited from class javax.swing.JComponent
JComponent.AccessibleJComponent
Nested classes/interfaces inherited from class java.awt.Container
Container.AccessibleAWTContainer
Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
protected VisionClientContext
The current ClientContext that is set on startupComponent()protected int
protected Dataset
static final String
static final int
static final int
static final int
static final int
protected PMIComboBox.DataSetComboBoxModel
protected Color
static final int
Fields inherited from class javax.swing.JComboBox
actionCommand, dataModel, editor, isEditable, keySelectionManager, lightWeightPopupEnabled, maximumRowCount, renderer, selectedItemReminder
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 com.inductiveautomation.vision.api.client.components.model.ComponentLifecycle
COMPONENT_RUNNING
Fields inherited from interface com.inductiveautomation.vision.api.client.components.model.EnabledEx
DISABLED_BY_PERMISSIONS
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Fields inherited from interface com.inductiveautomation.ignition.client.model.LocaleListener
LOCAL_CHANGE_EVENT
Fields inherited from interface com.inductiveautomation.vision.api.client.binding.MutableDynamicPropertyProvider
RESERVED_SET_KEY
Fields 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 TypeMethodDescriptionvoid
int
getData()
int
For backwards compatibility with scripts.int
When the actual row height is -1, an automatic height is chosen from the current font metrics in order to fit the dropdown options.int
int
int
int
getMode()
int
getPropertyValue
(String name) Retrieves the data quality code.int
com.inductiveautomation.factorypmi.application.components.PMIComboBox.DataSetComboBoxModel.CBSelection
int
int
boolean
boolean
boolean
isOpaque()
boolean
isPropertyDefined
(String name) boolean
void
localeChanged
(Locale newLocale) protected void
protected void
boolean
selectWithKeyChar
(char keyChar) void
setAntialias
(boolean ignored) void
setComponentEnabled
(boolean componentEnabled) void
setCursorCode
(int cursorCode) void
void
setDataQuality
(int value) void
void
setHideTableColumns
(String hideTableColumns) void
setHorizontalAlignment
(int horizontalAlignment) void
setMaxTableHeight
(int maxTableHeight) void
setMaxTableWidth
(int maxTableWidth) void
setMode
(int mode) void
protected void
setNoSelection
(com.inductiveautomation.factorypmi.application.components.PMIComboBox.DataSetComboBoxModel.CBSelection sel) void
setNoSelectionLabel
(String noSelectionLabel) void
setNoSelectionString
(String noSelectionString) void
setNoSelectionValue
(int noSelectionValue) void
setPropertyValue
(String name, Object value) void
setQuality
(QualityCode value) Sets the current data quality to the given valuevoid
setRowHeight
(int rowHeight) void
setSelectedItem
(Object anObject) void
setSelectedLabel
(String value) void
setSelectedStringValue
(String value) void
setSelectedValue
(Integer value) void
void
setSelectionBackground
(Color selectionColor) void
setSelectionMode
(int selectionMode) void
setShowTableHeader
(boolean showTableHeader) void
void
setToolTipText
(String text) void
setVerticalAlignment
(int verticalAlignment) void
setVisible
(boolean visible) final void
Called when the component is now shown anymore.final void
startupComponent
(VisionClientContext context) Called when the component is first shown.protected String
translateTerm
(String term) void
updateQuality
(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, 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
-
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:
isComponentEnabled
in interfaceEnabledEx
-
setComponentEnabled
public void setComponentEnabled(boolean componentEnabled) - Specified by:
setComponentEnabled
in interfaceEnabledEx
-
evaluateEnabled
public void evaluateEnabled()- Specified by:
evaluateEnabled
in interfaceEnabledEx
-
setVisible
public void setVisible(boolean visible) - Overrides:
setVisible
in classJComponent
-
setSelectedItem
- Overrides:
setSelectedItem
in classJComboBox
-
setToolTipText
- Overrides:
setToolTipText
in classJComponent
-
getToolTipText
- Overrides:
getToolTipText
in 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:
getSelectedItem
in classJComboBox
-
setSelectedValue
-
setSelectedStringValue
-
setSelectedValue
- Throws:
org.python.core.PyIgnoreMethodTag
-
setSelectedLabel
-
localeChanged
- Specified by:
localeChanged
in interfaceLocaleListener
-
isOpaque
public boolean isOpaque()- Overrides:
isOpaque
in 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:
selectWithKeyChar
in classJComboBox
-
getDynamicProps
- Specified by:
getDynamicProps
in interfaceMutableDynamicPropertyProvider
-
setDynamicProps
- Specified by:
setDynamicProps
in interfaceMutableDynamicPropertyProvider
-
setPropertyValue
- Specified by:
setPropertyValue
in interfaceDynamicPropertyProvider
- Throws:
ClassCastException
-
getPropertyValue
- Specified by:
getPropertyValue
in interfaceDynamicPropertyProvider
-
getProperties
- Specified by:
getProperties
in interfaceDynamicPropertyProvider
-
isPropertyDefined
- Specified by:
isPropertyDefined
in interfaceDynamicPropertyProvider
-
getQuality
Description copied from interface:QualityMonitor
Retrieves the data quality code.- Specified by:
getQuality
in interfaceQualityMonitor
-
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 interfaceQualityMonitor
-
setDataQuality
public void setDataQuality(int value) - Specified by:
setDataQuality
in interfaceQualityMonitor
-
setQuality
Description copied from interface:QualityMonitor
Sets the current data quality to the given value- Specified by:
setQuality
in interfaceQualityMonitor
-
updateQuality
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 interfaceQualityMonitor
-
paintChildren
- Overrides:
paintChildren
in classJComponent
-
paintComponent
- Overrides:
paintComponent
in classJComponent
-
getStyles
- Specified by:
getStyles
in interfaceStyleProvider
-
setStyles
- Specified by:
setStyles
in interfaceStyleProvider
-
startupComponent
Description copied from interface:ComponentLifecycle
Called when the component is first shown.- Specified by:
startupComponent
in interfaceComponentLifecycle
-
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 interfaceComponentLifecycle
-
getAppContext
- Specified by:
getAppContext
in interfaceComponentLifecycle
-