Package docking.widgets.list

Class ListPanel<T>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

docking.widgets.list.ListPanel<T>

Type Parameters:

T - The type for the items in this list

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class ListPanel<T>
extends JPanel

This class provides a panel that contains a JList component.

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 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
ListPanel()	Constructs a new ListPanel.

Method Summary

Modifier and Type	Method	Description
void	addListSelectionListener(ListSelectionListener listener)	Adds a ListSelectionListener
void	ensureIndexIsVisible(int index)	Scroll viewport such that the index is visible.
JList<T>	getList()	Return the JList component.
ListModel<T>	getListModel()	Get the list model for the list.
int	getSelectedIndex()	Get the index of the selected item in the list.
T	getSelectedValue()	Returns the first selected value in the list or null if nothing is selected.
List<T>	getSelectedValues()	Returns an array of all the selected items.
boolean	isSelectionEmpty()	Returns true if no list items are selected.
void	issueWarning()	Displays a standard warning message about no selected objects in the list.
void	issueWarning(String msg, String title)	Displays any warning message.
static void	main(String[] args)	Simple test for ListPanel class.
void	refreshList(T[] dataList)	replaces the list contents with the new list.
void	removeListSelectionListener(ListSelectionListener listener)	Removes a ListSelectionListener
void	setCellRenderer(ListCellRenderer<T> r)	Get the cell renderer for the list.
final void	setDoubleClickActionListener(ActionListener listener)	Sets the listener to be notified whenever a list item is doubleClicked.
void	setKeyListener(KeyListener l)
void	setListData(T[] data)	Sets the list data
void	setListModel(ListModel<T> listModel)	Sets a list model for the internal list to use.
void	setListSelectionListener(ListSelectionListener listener)	Sets the listener to be notified when the selection changes.
void	setListTitle(String listTitle)	Places a title just above the scrolling list.
void	setMouseListener(MouseListener l)	Set the mouse listener for the list.
void	setSelectedIndex(int i)	Select the item at the given index.
void	setSelectedValue(T item)	Selects the item.
void	setSelectionMode(int selectionMode)	Sets the selection mode for the list.

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, setEnabled, 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, 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

Constructor Details

ListPanel

public ListPanel()

Constructs a new ListPanel.

Method Details

setSelectionMode

public void setSelectionMode(int selectionMode)

Sets the selection mode for the list. See JList for allowed Selection modes

Parameters:

selectionMode - the selectionMode to use.

setListTitle

public void setListTitle(String listTitle)

Places a title just above the scrolling list.

Parameters:

listTitle - the title to use.

addListSelectionListener

public void addListSelectionListener(ListSelectionListener listener)

Adds a ListSelectionListener

Parameters:

listener - the listener to add

removeListSelectionListener

public void removeListSelectionListener(ListSelectionListener listener)

Removes a ListSelectionListener

Parameters:

listener - the listener to remove

isSelectionEmpty

public boolean isSelectionEmpty()

Returns true if no list items are selected.

Returns:

true if no list items are selected.

getSelectedValue

public T getSelectedValue()

Returns the first selected value in the list or null if nothing is selected.

Returns:

the first selected value in the list or null if nothing is selected.

getSelectedIndex

public int getSelectedIndex()

Get the index of the selected item in the list.

Returns:

the index of the selected item in the list.

setSelectedIndex

public void setSelectedIndex(int i)

Select the item at the given index.

Parameters:

i - the index at which to get the item.

setSelectedValue

public void setSelectedValue(T item)

Selects the item.

Parameters:

item - the item to select

getSelectedValues

public List<T> getSelectedValues()

Returns an array of all the selected items.

Returns:

an array of all the selected items.

refreshList

public void refreshList(T[] dataList)

replaces the list contents with the new list.

Parameters:

dataList - the new list for the contents.

setListData

public void setListData(T[] data)

Sets the list data

Parameters:

data - the data

setListModel

public void setListModel(ListModel<T> listModel)

Sets a list model for the internal list to use.

Parameters:

listModel - the list model to use.

getListModel

public ListModel<T> getListModel()

Get the list model for the list.

Returns:

the list model for the list.

getList

public JList<T> getList()

Return the JList component.

Returns:

the JList component.

setCellRenderer

public void setCellRenderer(ListCellRenderer<T> r)

Get the cell renderer for the list.

Parameters:

r - the cell renderer to use.

setListSelectionListener

public void setListSelectionListener(ListSelectionListener listener)

Sets the listener to be notified when the selection changes.

Parameters:

listener - the Listener to be notified. If listener can be null, which means no one is to be notified.

setDoubleClickActionListener

public final void setDoubleClickActionListener(ActionListener listener)

Sets the listener to be notified whenever a list item is doubleClicked.

Parameters:

listener - the Listener to be notified. If listener can be null, which means no one is to be notified.

setMouseListener

public void setMouseListener(MouseListener l)

Set the mouse listener for the list.

Parameters:

l - the mouse listener to set.

setKeyListener

public void setKeyListener(KeyListener l)

issueWarning

public void issueWarning()

Displays a standard warning message about no selected objects in the list.

issueWarning

public void issueWarning(String msg,
 String title)

Displays any warning message.

Parameters:

msg - the warning message to display.

title - the title of the dialog to display.

ensureIndexIsVisible

public void ensureIndexIsVisible(int index)

Scroll viewport such that the index is visible.

Parameters:

index - the index of the item in the list to make visible.

main

public static void main(String[] args)

Simple test for ListPanel class.

Parameters:

args - test args not used