org.hps.monitoring.application

Class DataSourceComboBox

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JComboBox<DataSourceComboBox.DataSourceItem>

org.hps.monitoring.application.DataSourceComboBox

All Implemented Interfaces:

ActionListener, ImageObserver, ItemSelectable, MenuContainer, PropertyChangeListener, Serializable, EventListener, Accessible, ListDataListener

final class DataSourceComboBox
extends JComboBox<DataSourceComboBox.DataSourceItem>
implements PropertyChangeListener, ActionListener

This is a combo box that shows the current data source such as an LCIO file, EVIO file or ET ring. It can also be used to select a data source for the next monitoring session.

This component is not directly connected to an event loop, so it must catch changes to the configuration via property change events and then update its state accordingly.

Only a single "global" ET item is kept in the list, and it is updated as changes are made to the configuration model.

Author:

Jeremy McCormick

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	DataSourceComboBox.DataSourceItem This class represents a data source item in the combo box, which has a name for display, a full path to the file, and an implicit type (EVIO, LCIO or ET).

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

Fields

Modifier and Type	Field and Description
private ConfigurationModel	configurationModel The backing configuration model.
private static int	PREFERRED_WIDTH The preferred width of this component in pixels.

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 java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
DataSourceComboBox(ConfigurationModel configurationModel, ConnectionStatusModel connectionModel) Create a new data source combo box.

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent evt) Handle action events.
(package private) DataSourceComboBox.DataSourceItem	addDataSourceItem(String path, DataSourceType type) Add a data source item with a specific type and path.
void	addItem(DataSourceComboBox.DataSourceItem item) Add a data source item.
(package private) boolean	containsItem(DataSourceComboBox.DataSourceItem item) Return true if the (exact) given item exists in the combo box model.
(package private) DataSourceComboBox.DataSourceItem	findEtItem() Find the single data source item for the ET configuration in the items.
(package private) DataSourceComboBox.DataSourceItem	findItem(String path) Find an item by its path.
void	propertyChange(PropertyChangeEvent evt) Handle property change events which is used to update the GUI from changes to the global configuration model.
void	setSelectedItem(Object object) Set the currently selected item.
(package private) void	updateEtItem() Update the path value of the current ET item from the current global configuration.

Methods inherited from class javax.swing.JComboBox

actionPropertyChanged, addActionListener, 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, getSelectedItem, 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, 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, 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, setToolTipText, 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, getPeer, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, 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 Detail

PREFERRED_WIDTH

private static final int PREFERRED_WIDTH

The preferred width of this component in pixels.

See Also:

Constant Field Values

configurationModel

private ConfigurationModel configurationModel

The backing configuration model.

Constructor Detail

DataSourceComboBox

DataSourceComboBox(ConfigurationModel configurationModel,
                   ConnectionStatusModel connectionModel)

Create a new data source combo box.

Parameters:

configurationModel - the underlying configuration data model

connectionModel - the underlying connection status data model

Method Detail

actionPerformed

public void actionPerformed(ActionEvent evt)

Handle action events.

Specified by:

actionPerformed in interface ActionListener

Overrides:

actionPerformed in class JComboBox<DataSourceComboBox.DataSourceItem>

Parameters:

evt - the ActionEvent to handle

addDataSourceItem

DataSourceComboBox.DataSourceItem addDataSourceItem(String path,
                                                    DataSourceType type)

Add a data source item with a specific type and path.

Parameters:

path - the data source path

type - the data source type

Returns:

the new data source item

addItem

public void addItem(DataSourceComboBox.DataSourceItem item)

Add a data source item. Attempting to add an item that already exists will be ignored.

Overrides:

addItem in class JComboBox<DataSourceComboBox.DataSourceItem>

containsItem

boolean containsItem(DataSourceComboBox.DataSourceItem item)

Return true if the (exact) given item exists in the combo box model.

Parameters:

item - the data source item

Returns:

true if data source item exists in the model

findEtItem

DataSourceComboBox.DataSourceItem findEtItem()

Find the single data source item for the ET configuration in the items.

Returns:

the data source item for the ET configuration or null if does not exist

findItem

DataSourceComboBox.DataSourceItem findItem(String path)

Find an item by its path.

Parameters:

path - the path of the item

Returns:

the item or null if does not exist

propertyChange

public void propertyChange(PropertyChangeEvent evt)

Handle property change events which is used to update the GUI from changes to the global configuration model.

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

evt - the property change event

setSelectedItem

public void setSelectedItem(Object object)

Set the currently selected item.

Overrides:

setSelectedItem in class JComboBox<DataSourceComboBox.DataSourceItem>

Parameters:

object - the currently selected item (should be an instance of this class)

updateEtItem

void updateEtItem()

Update the path value of the current ET item from the current global configuration. There is only one ET item present in the list at one time so property changes to ET configuration will trigger this method.