com.objectwave.uiWidget
Class ComponentList

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JRootPane
                          |
                          +--com.objectwave.uiWidget.ComponentList

All Implemented Interfaces:

javax.accessibility.Accessible, java.util.EventListener, java.awt.image.ImageObserver, java.awt.MenuContainer, MouseDispatchListener, java.io.Serializable

public class ComponentList

extends javax.swing.JRootPane

implements MouseDispatchListener

A list box of components.

See Also:

Serialized Form

Field Summary

protected boolean	highlight
protected javax.swing.event.ListSelectionListener	selectionListener
protected javax.swing.ListSelectionModel	selectionModel

Fields inherited from class javax.swing.JRootPane

COLOR_CHOOSER_DIALOG, contentPane, defaultButton, defaultPressAction, defaultReleaseAction, ERROR_DIALOG, FILE_CHOOSER_DIALOG, FRAME, glassPane, INFORMATION_DIALOG, layeredPane, menuBar, NONE, PLAIN_DIALOG, QUESTION_DIALOG, WARNING_DIALOG

Fields inherited from class javax.swing.JComponent

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

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

ComponentList()

Method Summary

void	addListSelectionListener(javax.swing.event.ListSelectionListener listener) Add a listener to the list that's notified each time a change to the selection occurs.
protected java.awt.event.MouseListener	createMouseListener() This is a dispatcher.
protected javax.swing.ListSelectionModel	createSelectionModel() Returns an instance of DefaultListSelectionModel.
int	dataContains(java.awt.Component c)
protected void	fireSelectionValueChanged(int firstIndex, int lastIndex, boolean isAdjusting) This method notifies JList ListSelectionListeners that the selection model has changed.
javax.swing.ListSelectionModel	getSelectionModel() Returns the value of the current selection model.
protected void	initDataPanel()
boolean	isAllowedToDispatch(java.awt.event.MouseEvent e)
void	pressedSelection(int row, java.awt.event.MouseEvent e)
void	releasedSelection(java.awt.event.MouseEvent e)
void	removeListSelectionListener(javax.swing.event.ListSelectionListener listener) Remove a listener from the list that's notified each time a change to the selection occurs.
void	setHightlight(boolean value) Do we hightlight selected entries? The default value is true.
void	setListData(java.awt.Component[] comps)
void	setSelectionModel(javax.swing.ListSelectionModel selectionModel) Set the selectionModel for the list to a non-null ListSelectionModel implementation.
void	updateSelected()

Methods inherited from class javax.swing.JRootPane

addImpl, addNotify, createContentPane, createGlassPane, createLayeredPane, createRootLayout, getAccessibleContext, getContentPane, getDefaultButton, getGlassPane, getJMenuBar, getLayeredPane, getMenuBar, getUI, getUIClassID, getWindowDecorationStyle, isOptimizedDrawingEnabled, isValidateRoot, paramString, removeNotify, setContentPane, setDefaultButton, setGlassPane, setJMenuBar, setLayeredPane, setMenuBar, setUI, setWindowDecorationStyle, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

highlight

protected boolean highlight

selectionModel

protected javax.swing.ListSelectionModel selectionModel

selectionListener

protected javax.swing.event.ListSelectionListener selectionListener

Constructor Detail

ComponentList

public ComponentList()

Method Detail

addListSelectionListener

public void addListSelectionListener(javax.swing.event.ListSelectionListener listener)

Add a listener to the list that's notified each time a change to the selection occurs. Listeners added directly to the JList will have their ListSelectionEvent.getSource() == this JList (instead of the ListSelectionModel).

Parameters:

listener - The ListSelectionListener to add.

See Also:

getSelectionModel()

createMouseListener

protected java.awt.event.MouseListener createMouseListener()

This is a dispatcher.

createSelectionModel

protected javax.swing.ListSelectionModel createSelectionModel()

Returns an instance of DefaultListSelectionModel. This method is used by the constructor to initialize the selectionModel property.

Returns:

The ListSelectionModel used by this JList.

See Also:

setSelectionModel(javax.swing.ListSelectionModel), DefaultListSelectionModel

dataContains

public int dataContains(java.awt.Component c)

fireSelectionValueChanged

protected void fireSelectionValueChanged(int firstIndex,
                                         int lastIndex,
                                         boolean isAdjusting)

This method notifies JList ListSelectionListeners that the selection model has changed. It's used to forward ListSelectionEvents from the selectionModel to the ListSelectionListeners added directly to the JList.

See Also:

addListSelectionListener(javax.swing.event.ListSelectionListener), removeListSelectionListener(javax.swing.event.ListSelectionListener), EventListenerList

getSelectionModel

public javax.swing.ListSelectionModel getSelectionModel()

Returns the value of the current selection model. The selection model handles the task of making single selections, selections of contiguous ranges, and non-contiguous selections.

Returns:

the ListSelectionModel that implements list selections

See Also:

setSelectionModel(javax.swing.ListSelectionModel), ListSelectionModel

initDataPanel

protected void initDataPanel()

isAllowedToDispatch

public boolean isAllowedToDispatch(java.awt.event.MouseEvent e)

Specified by:

isAllowedToDispatch in interface MouseDispatchListener

pressedSelection

public void pressedSelection(int row,
                             java.awt.event.MouseEvent e)

releasedSelection

public void releasedSelection(java.awt.event.MouseEvent e)

removeListSelectionListener

public void removeListSelectionListener(javax.swing.event.ListSelectionListener listener)

Remove a listener from the list that's notified each time a change to the selection occurs.

Parameters:

listener - The ListSelectionListener to remove.

See Also:

addListSelectionListener(javax.swing.event.ListSelectionListener), getSelectionModel()

setHightlight

public void setHightlight(boolean value)

Do we hightlight selected entries? The default value is true.

setListData

public void setListData(java.awt.Component[] comps)

setSelectionModel

public void setSelectionModel(javax.swing.ListSelectionModel selectionModel)

Set the selectionModel for the list to a non-null ListSelectionModel implementation. The selection model handles the task of making single selections, selections of contiguous ranges, and non-contiguous selections.

This is a JavaBeans bound property.

Returns:

selectionModel the ListSelectionModel that implements list selections

See Also:

getSelectionModel()

updateSelected

public void updateSelected()