net.sf.jguiraffe.gui.platform.swing.builder.components
Class SwingListBoxHandler

java.lang.Object
  net.sf.jguiraffe.gui.platform.swing.builder.components.SwingComponentHandler
      net.sf.jguiraffe.gui.platform.swing.builder.components.SwingListModelHandler
          net.sf.jguiraffe.gui.platform.swing.builder.components.SwingListBoxHandler

All Implemented Interfaces:

java.util.EventListener, javax.swing.event.ListSelectionListener, ListComponentHandler, ComponentHandler, SwingEventSource

Direct Known Subclasses:

SwingMultiListBoxHandler

 class SwingListBoxHandler
extends SwingListModelHandler
implements javax.swing.event.ListSelectionListener

A specific Swing component handler implementation that deals with single selection lists.

Single selection lists are quite similar to non editable combo boxes. Their data is based on the provided list model.

Version:

$Id: SwingListBoxHandler.java 71 2007-06-16 20:47:48Z oheger $

Author:

Oliver Heger

Constructor Summary

SwingListBoxHandler(javax.swing.JList list, ListModel listModel)
Creates a new instance of SwingListBoxHandler.

Method Summary

java.lang.Object	getData() Returns this component's data.
javax.swing.JList	getList() Returns the managed list.
java.lang.Object	getOuterComponent() Returns the outer most component.
protected void	initComponentModel(SwingListModel model) Initializes the list box with the given list model.
protected void	registerChangeListener() Registers this component handler as a change listener at the managed component.
void	setData(java.lang.Object data) Sets the data of this component.
protected void	unregisterChangeListener() Removes this component handler as change listener from the managed component.
void	valueChanged(javax.swing.event.ListSelectionEvent event) Callback for list selection changes.

Methods inherited from class net.sf.jguiraffe.gui.platform.swing.builder.components.SwingListModelHandler

addItem, createSwingListModel, getListModel, getType, removeItem

Methods inherited from class net.sf.jguiraffe.gui.platform.swing.builder.components.SwingComponentHandler

addActionListener, addChangeListener, addFocusListener, fireChangeEvent, getComponent, getJComponent, isEnabled, removeActionListener, removeChangeListener, removeFocusListener, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.jguiraffe.gui.forms.ComponentHandler

getComponent, isEnabled, setEnabled

Constructor Detail

SwingListBoxHandler

public SwingListBoxHandler(javax.swing.JList list,
                           ListModel listModel)

Creates a new instance of SwingListBoxHandler.

Parameters:

list - the list component

listModel - the list model

Method Detail

getList

public javax.swing.JList getList()

Returns the managed list.

Returns:

the managed list component

valueChanged

public void valueChanged(javax.swing.event.ListSelectionEvent event)

Callback for list selection changes. These events are fired as change events. Adjusting events are ignored.

Specified by:

valueChanged in interface javax.swing.event.ListSelectionListener

Parameters:

event - the change event

registerChangeListener

protected void registerChangeListener()

Registers this component handler as a change listener at the managed component. This implementation registers a list selection listener.

Overrides:

registerChangeListener in class SwingComponentHandler

unregisterChangeListener

protected void unregisterChangeListener()

Removes this component handler as change listener from the managed component.

Overrides:

unregisterChangeListener in class SwingComponentHandler

See Also:

SwingComponentHandler.registerChangeListener()

initComponentModel

protected void initComponentModel(SwingListModel model)

Initializes the list box with the given list model.

Specified by:

initComponentModel in class SwingListModelHandler

Parameters:

model - the list model

getData

public java.lang.Object getData()

Returns this component's data. Based on the selected index an object from the list model will be returned.

Specified by:

getData in interface ComponentHandler

Returns:

the component's data

setData

public void setData(java.lang.Object data)

Sets the data of this component.

Specified by:

setData in interface ComponentHandler

Parameters:

data - the new data (which should be an item of the list model)

getOuterComponent

public java.lang.Object getOuterComponent()

Returns the outer most component. For lists this is a scroll pane.

Specified by:

getOuterComponent in interface ComponentHandler

Overrides:

getOuterComponent in class SwingComponentHandler

Returns:

the outer most component