Package com.inductiveautomation.ignition.client.util.gui

Class AbstractProfileOptionDropdown

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.inductiveautomation.ignition.client.util.gui.AbstractProfileOptionDropdown

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

AuditProfileComboBox, DatasourceComboBox, IdentityProviderDropdown, SQLTagsProviderComboBox, UserSourceProfileDropdown

public abstract class AbstractProfileOptionDropdown
extends JPanel

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

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

Fields

Modifier and Type	Field	Description
protected boolean	allowNone
protected JComboBox	dropdown
protected boolean	loadInBackground
protected String	noneOptionText
protected String	noSelectionText
protected ReloadIconButton	reloadIconButton

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

Constructor Summary

Constructors

Constructor	Description
AbstractProfileOptionDropdown(boolean initialize)

Method Summary

Modifier and Type	Method	Description
protected void	addAction(Action action)
protected void	addActions()
void	addItemListener(ItemListener listener)
JComboBox	getDropdown()
String	getNoneOptionText()
String	getNoSelectionText()
protected abstract List<String>	getOptions()
String	getSelectedItem()
protected void	handleLoadError(Exception ex)
protected void	initComponents()
boolean	isAllowNone()
protected boolean	isCaseInsensitive()
boolean	isEditable()
boolean	isLoadInBackground()
void	refresh()
void	refresh(boolean selectFirst)
void	removeItemListener(ItemListener listener)
void	setAllowNone(boolean allowNone)
void	setEditable(boolean b)
void	setEnabled(boolean enabled)
void	setFont(Font font)
void	setLoadInBackground(boolean loadInBackground)
void	setNoneOptionText(String noneOptionText)
void	setNoSelectionText(String noSelectionText)
void	setReloadToolTipText(String str)	Updates the tooltiptext for the reload icon.
void	setSelectedItem(String item)
void	setToolTipText(String str)
protected String	toString(String option)	Provides a simple hook to render the option differently.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, 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, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, 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, setName, 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

Field Details

dropdown

protected JComboBox dropdown

noSelectionText

protected String noSelectionText

noneOptionText

protected String noneOptionText

allowNone

protected boolean allowNone

loadInBackground

protected boolean loadInBackground

reloadIconButton

protected ReloadIconButton reloadIconButton

Constructor Details

AbstractProfileOptionDropdown

public AbstractProfileOptionDropdown(boolean initialize)

Method Details

setEnabled

public void setEnabled(boolean enabled)

Overrides:

setEnabled in class JComponent

getSelectedItem

public String getSelectedItem()

setSelectedItem

public void setSelectedItem(@Nullable
 String item)

initComponents

protected void initComponents()

addActions

protected void addActions()

addAction

protected void addAction(Action action)

setToolTipText

public void setToolTipText(String str)

Overrides:

setToolTipText in class JComponent

setReloadToolTipText

public void setReloadToolTipText(String str)

Updates the tooltiptext for the reload icon. Used when the locale changes

Parameters:

str - New tool text

refresh

public void refresh()

refresh

public void refresh(boolean selectFirst)

handleLoadError

protected void handleLoadError(Exception ex)

getOptions

protected abstract List<String> getOptions()
                                    throws Exception

Throws:

Exception

isCaseInsensitive

protected boolean isCaseInsensitive()

toString

protected String toString(String option)

Provides a simple hook to render the option differently. By default replaces "" with "<Default>"

addItemListener

public void addItemListener(ItemListener listener)

removeItemListener

public void removeItemListener(ItemListener listener)

getNoSelectionText

public String getNoSelectionText()

setNoSelectionText

public void setNoSelectionText(String noSelectionText)

isAllowNone

public boolean isAllowNone()

setAllowNone

public void setAllowNone(boolean allowNone)

getNoneOptionText

public String getNoneOptionText()

setNoneOptionText

public void setNoneOptionText(String noneOptionText)

isLoadInBackground

public boolean isLoadInBackground()

setLoadInBackground

public void setLoadInBackground(boolean loadInBackground)

isEditable

public boolean isEditable()

setEditable

public void setEditable(boolean b)

getDropdown

public JComboBox getDropdown()

setFont

public void setFont(Font font)

Overrides:

setFont in class JComponent