icy.gui.component.sequence

Class SequenceChooser

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JComboBox

icy.gui.component.sequence.SequenceChooser

All Implemented Interfaces:

GlobalSequenceListener, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.ItemSelectable, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.event.ListDataListener

Direct Known Subclasses:

SequenceChooser

public class SequenceChooser
extends javax.swing.JComboBox
implements GlobalSequenceListener

The sequence chooser is a component derived from JComboBox.
The combo auto refresh its content regarding to the sequence opened in ICY.
You can get it with getSequenceSelected()

Author:

Fabrice de Chaumont & Stephane

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SequenceChooser.SequenceChooserListener

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

javax.swing.JComboBox.KeySelectionManager

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

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SEQUENCE_SELECT_CMD

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

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
SequenceChooser() Create a new Sequence chooser component (JComboBox for sequence selection).
SequenceChooser(boolean activeSequenceEntry, java.lang.String nullEntryName) Create a new Sequence chooser component (JComboBox for sequence selection).
SequenceChooser(boolean activeSequenceEntry, java.lang.String nullEntryName, int nameMaxLength) Create a new Sequence chooser component (JComboBox for sequence selection).
SequenceChooser(int nameMaxLength) Deprecated. Use SequenceChooser(boolean, String, int) instead.
SequenceChooser(int maxLength, boolean nullEntry) Deprecated. Use SequenceChooser(boolean, String, int) instead.
SequenceChooser(int maxLength, boolean nullEntry, boolean autoSelectIfNull) Deprecated. Use SequenceChooser(boolean, String, int) instead.
SequenceChooser(int sequenceNameMaxLength, boolean nullEntry, boolean autoSelectIfNull, java.lang.String nullEntryName) Deprecated. Use SequenceChooser(boolean, String, int) instead.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e)
void	addListener(SequenceChooser.SequenceChooserListener listener)
void	addNotify()
AcceptListener	getFilter()
java.util.ArrayList<SequenceChooser.SequenceChooserListener>	getListeners()
Sequence	getSelectedSequence()
void	removeListener(SequenceChooser.SequenceChooserListener listener)
void	removeNotify()
void	sequenceClosed(Sequence sequence) Sequence was just closed (last viewer displaying the sequence just closed)
void	sequenceOpened(Sequence sequence) Sequence was just opened (first viewer displaying the sequence just opened)
void	setActiveSequenceSelected() Select the Active sequence entry if enable.
void	setFilter(AcceptListener filter) Set a filter for sequence display.
void	setSelectedSequence(Sequence sequence)
void	setSequenceSelected(Sequence sequence) Deprecated. use setSelectedSequence(Sequence) instead

Methods inherited from class javax.swing.JComboBox

addActionListener, addItem, addItemListener, addPopupMenuListener, configureEditor, contentsChanged, firePopupMenuCanceled, firePopupMenuWillBecomeInvisible, firePopupMenuWillBecomeVisible, getAccessibleContext, getAction, getActionCommand, getActionListeners, getEditor, getItemAt, getItemCount, getItemListeners, getKeySelectionManager, getMaximumRowCount, getModel, getPopupMenuListeners, getPrototypeDisplayValue, getRenderer, getSelectedIndex, getSelectedItem, getSelectedObjects, getUI, getUIClassID, hidePopup, insertItemAt, intervalAdded, intervalRemoved, isEditable, isLightWeightPopupEnabled, isPopupVisible, processKeyEvent, removeActionListener, removeAllItems, removeItem, removeItemAt, removeItemListener, removePopupMenuListener, selectWithKeyChar, setAction, setActionCommand, setEditable, setEditor, setEnabled, setKeySelectionManager, setLightWeightPopupEnabled, setMaximumRowCount, setModel, setPopupVisible, setPrototypeDisplayValue, setRenderer, setSelectedIndex, setSelectedItem, setUI, showPopup, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, 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, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, 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, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, 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, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SEQUENCE_SELECT_CMD

public static final java.lang.String SEQUENCE_SELECT_CMD

See Also:

Constant Field Values

Constructor Detail

SequenceChooser

public SequenceChooser(boolean activeSequenceEntry,
               java.lang.String nullEntryName,
               int nameMaxLength)

Create a new Sequence chooser component (JComboBox for sequence selection).

Parameters:

activeSequenceEntry - If true the combobox will display an Active Sequence entry so when we select it the getSelectedSequence() method returns the current active sequence.

nullEntryName - If this parameter is not null the combobox will display an extra entry with the given string to define null sequence selection so when this entry will be selected the getSelectedSequence() will return null.

nameMaxLength - Maximum authorized length for the sequence name display in the combobox (extra characters are truncated).
That prevent the combobox to be resized to very large width.

SequenceChooser

@Deprecated
public SequenceChooser(int sequenceNameMaxLength,
                          boolean nullEntry,
                          boolean autoSelectIfNull,
                          java.lang.String nullEntryName)

Deprecated. Use SequenceChooser(boolean, String, int) instead.

SequenceChooser

@Deprecated
public SequenceChooser(int maxLength,
                          boolean nullEntry,
                          boolean autoSelectIfNull)

Deprecated. Use SequenceChooser(boolean, String, int) instead.

SequenceChooser

@Deprecated
public SequenceChooser(int maxLength,
                          boolean nullEntry)

Deprecated. Use SequenceChooser(boolean, String, int) instead.

SequenceChooser

public SequenceChooser(boolean activeSequenceEntry,
               java.lang.String nullEntryName)

Create a new Sequence chooser component (JComboBox for sequence selection).

Parameters:

activeSequenceEntry - If true the combobox will display an Active Sequence entry so when we select it the getSelectedSequence() method returns the current active sequence.

nullEntryName - If this parameter is not null the combobox will display an extra entry with the given string to define null sequence selection so when this entry will be selected the getSelectedSequence() will return null.

SequenceChooser

@Deprecated
public SequenceChooser(int nameMaxLength)

Deprecated. Use SequenceChooser(boolean, String, int) instead.

SequenceChooser

public SequenceChooser()

Create a new Sequence chooser component (JComboBox for sequence selection).

Method Detail

addNotify

public void addNotify()

Overrides:

addNotify in class javax.swing.JComponent

removeNotify

public void removeNotify()

Overrides:

removeNotify in class javax.swing.JComponent

getFilter

public AcceptListener getFilter()

Returns:

the filter

setFilter

public void setFilter(AcceptListener filter)

Set a filter for sequence display.
Only Sequence accepted by the filter will appear in the combobox.

getSelectedSequence

public Sequence getSelectedSequence()

Returns:

current selected sequence.

setActiveSequenceSelected

public void setActiveSequenceSelected()

Select the Active sequence entry if enable.

setSelectedSequence

public void setSelectedSequence(Sequence sequence)

Parameters:

sequence - The sequence to select in the combo box

setSequenceSelected

@Deprecated
public void setSequenceSelected(Sequence sequence)

Deprecated. use setSelectedSequence(Sequence) instead

getListeners

public java.util.ArrayList<SequenceChooser.SequenceChooserListener> getListeners()

addListener

public void addListener(SequenceChooser.SequenceChooserListener listener)

removeListener

public void removeListener(SequenceChooser.SequenceChooserListener listener)

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class javax.swing.JComboBox

sequenceOpened

public void sequenceOpened(Sequence sequence)

Description copied from interface: GlobalSequenceListener

Sequence was just opened (first viewer displaying the sequence just opened)

Specified by:

sequenceOpened in interface GlobalSequenceListener

sequenceClosed

public void sequenceClosed(Sequence sequence)

Description copied from interface: GlobalSequenceListener

Sequence was just closed (last viewer displaying the sequence just closed)

Specified by:

sequenceClosed in interface GlobalSequenceListener