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

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

All Implemented Interfaces:

java.util.EventListener, javax.swing.event.DocumentListener, ComponentHandler, SwingEventSource

Direct Known Subclasses:

SwingTextAreaHandler

 class SwingTextHandler
extends SwingComponentHandler
implements javax.swing.event.DocumentListener

A specific Swing component handler implementation that deals with text components.

This component handler deals with single and multi line text fields. Data type is String in both cases. Change events are mapped to edit events like insert and remove. Action events are not supported.

Version:

$Id: SwingTextHandler.java 67 2007-06-09 19:11:01Z oheger $

Author:

Oliver Heger

Constructor Summary

SwingTextHandler(javax.swing.text.JTextComponent text)
Creates a new instance of SwingTextHandler.

Method Summary

void	changedUpdate(javax.swing.event.DocumentEvent event) Event listener callback for text change events.
java.lang.Object	getData() Returns the data of the managed text field.
javax.swing.text.JTextComponent	getTextComponent() Returns the managed text component.
java.lang.Class	getType() Returns this handler's data type.
void	insertUpdate(javax.swing.event.DocumentEvent event) Event listener callback for text insert events.
protected void	registerChangeListener() Registers this handler as change listener at the managed text component.
void	removeUpdate(javax.swing.event.DocumentEvent event) Event listener callback for text remove events.
void	setData(java.lang.Object data) Sets the text field's data.
protected void	unregisterChangeListener() Unregisters this handler as change listener at the managed text component.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SwingTextHandler

public SwingTextHandler(javax.swing.text.JTextComponent text)

Creates a new instance of SwingTextHandler.

Parameters:

text - the managed text component

Method Detail

getTextComponent

public javax.swing.text.JTextComponent getTextComponent()

Returns the managed text component.

Returns:

the text component

getData

public java.lang.Object getData()

Returns the data of the managed text field. This is of type string.

Specified by:

getData in interface ComponentHandler

Returns:

the text field's data

setData

public void setData(java.lang.Object data)

Sets the text field's data.

Specified by:

setData in interface ComponentHandler

Parameters:

data - the data, may be null

getType

public java.lang.Class getType()

Returns this handler's data type. This is String.

Specified by:

getType in interface ComponentHandler

Returns:

the handler's data type

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent event)

Event listener callback for text change events.

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener

Parameters:

event - the event

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent event)

Event listener callback for text insert events.

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

Parameters:

event - the event

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent event)

Event listener callback for text remove events.

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

Parameters:

event - the event

registerChangeListener

protected void registerChangeListener()

Registers this handler as change listener at the managed text component. Incoming text update notifications will then be broadcasted as change events.

Overrides:

registerChangeListener in class SwingComponentHandler

unregisterChangeListener

protected void unregisterChangeListener()

Unregisters this handler as change listener at the managed text component.

Overrides:

unregisterChangeListener in class SwingComponentHandler

See Also:

SwingComponentHandler.registerChangeListener()