Class TextAreaCreationTool

  extended by org.jhotdraw.beans.AbstractBean
      extended by org.jhotdraw.draw.AbstractTool
          extended by org.jhotdraw.draw.CreationTool
              extended by org.jhotdraw.draw.TextAreaCreationTool
All Implemented Interfaces:
java.awt.event.ActionListener, java.awt.event.KeyListener, java.awt.event.MouseListener, java.awt.event.MouseMotionListener,, java.lang.Cloneable, java.util.EventListener, Tool

public class TextAreaCreationTool
extends CreationTool
implements java.awt.event.ActionListener

A tool to create new or edit existing figures that implement the TextHolderFigure interface, such as TextAreaFigure. The figure to be created is specified by a prototype.

To create a figure using the TextAreaCreationTool, the user does the following mouse gestures on a DrawingView:

  1. Press the mouse button over the DrawingView. This defines the start point of the Figure bounds.
  2. Drag the mouse while keeping the mouse button pressed, and then release the mouse button. This defines the end point of the Figure bounds.
When the user has performed these mouse gesture, the TextAreaCreationTool overlays a text area over the drawing where the user can enter the text for the Figure.

To edit an existing text figure using the TextAreaCreationTool, the user does the following mouse gesture on a DrawingView:

  1. Press the mouse button over a Figure on the DrawingView.

The TextAreaCreationTool then uses Figure.findFigureInside to find a Figure that implements the TextHolderFigure interface and that is editable. Then it overlays a text area over the drawing where the user can enter the text for the Figure.

XXX - Maybe this class should be split up into a CreateTextAreaTool and a EditTextAreaTool.

Design Patterns

The text creation and editing tools and the TextHolderFigure interface define together the contracts of a smaller framework inside of the JHotDraw framework for structured drawing editors.
Contract: TextHolderFigure, TextCreationTool, TextAreaCreationTool, TextEditingTool, TextAreaEditingTool, FloatingTextField, FloatingTextArea.

The text creation tools create new figures by cloning a prototype TextHolderFigure object.
Prototype: TextHolderFigure; Client: TextCreationTool, TextAreaCreationTool.

$Id: 527 2009-06-07 14:28:19Z rawcoder $
Werner Randelshofer
See Also:
Serialized Form

Field Summary
private  java.awt.Color rubberbandColor
          Rubberband color of the tool.
private  FloatingTextArea textArea
private  TextHolderFigure typingTarget
Fields inherited from class org.jhotdraw.draw.CreationTool
createdFigure, minimalSize, minimalSizeTreshold, presentationName, prototype, prototypeAttributes
Fields inherited from class org.jhotdraw.draw.AbstractTool
anchor, editor, isWorking, listenerList
Fields inherited from class org.jhotdraw.beans.AbstractBean
Constructor Summary
TextAreaCreationTool(TextHolderFigure prototype)
          Creates a new instance.
TextAreaCreationTool(TextHolderFigure prototype, java.util.Map<AttributeKey,java.lang.Object> attributes)
Method Summary
 void actionPerformed(java.awt.event.ActionEvent event)
protected  void beginEdit(TextHolderFigure textHolder)
protected  void creationFinished(Figure createdFigure)
          This method allows subclasses to do perform additonal user interactions after the new figure has been created.
 void deactivate(DrawingEditor editor)
          Deactivates the tool.
 void draw(java.awt.Graphics2D g)
          Draws the tool.
protected  void endEdit()
private  java.awt.geom.Rectangle2D.Double getFieldBounds(TextHolderFigure figure)
 void mousePressed(java.awt.event.MouseEvent e)
          Creates a new figure at the mouse location.
 void setRubberbandColor(java.awt.Color c)
          Sets the rubberband color for the tool.
Methods inherited from class org.jhotdraw.draw.CreationTool
activate, createFigure, getAddedFigure, getCreatedFigure, getPrototype, isToolDoneAfterCreation, mouseDragged, mouseReleased, setToolDoneAfterCreation, updateCursor
Methods inherited from class org.jhotdraw.draw.AbstractTool
addToolListener, addUndoableEditListener, constrainPoint, constrainPoint, createActionMap, createInputMap, editCopy, editCut, editDelete, editDuplicate, editPaste, fireAreaInvalidated, fireAreaInvalidated, fireToolDone, fireToolStarted, getActionMap, getDrawing, getEditor, getInputMap, getToolTipText, getView, isActive, keyPressed, keyReleased, keyTyped, mouseClicked, mouseEntered, mouseExited, mouseMoved, removeToolListener, removeUndoableEditListener, setActionMap, setInputMap, supportsHandleInteraction, viewToDrawing
Methods inherited from class org.jhotdraw.beans.AbstractBean
addPropertyChangeListener, addPropertyChangeListener, clone, firePropertyChange, firePropertyChange, firePropertyChange, getPropertyChangeListeners, removePropertyChangeListener, removePropertyChangeListener
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail


private FloatingTextArea textArea


private TextHolderFigure typingTarget


private java.awt.Color rubberbandColor
Rubberband color of the tool. When this is null, the tool does not draw a rubberband.

Constructor Detail


public TextAreaCreationTool(TextHolderFigure prototype)
Creates a new instance.


public TextAreaCreationTool(TextHolderFigure prototype,
                            java.util.Map<AttributeKey,java.lang.Object> attributes)
Method Detail


public void setRubberbandColor(java.awt.Color c)
Sets the rubberband color for the tool. Setting this to null, disables the rubberband.

c - Rubberband color or null.


public void deactivate(DrawingEditor editor)
Description copied from interface: Tool
Deactivates the tool. This method is called whenever the user switches to another tool.

Specified by:
deactivate in interface Tool
deactivate in class CreationTool


public void mousePressed(java.awt.event.MouseEvent e)
Creates a new figure at the mouse location. If editing is in progress, this finishes editing.

Specified by:
mousePressed in interface java.awt.event.MouseListener
mousePressed in class CreationTool


protected void creationFinished(Figure createdFigure)
This method allows subclasses to do perform additonal user interactions after the new figure has been created. The implementation of this class just invokes fireToolDone.

creationFinished in class CreationTool


public void draw(java.awt.Graphics2D g)
Description copied from interface: Tool
Draws the tool.

Specified by:
draw in interface Tool
draw in class AbstractTool


protected void beginEdit(TextHolderFigure textHolder)


private java.awt.geom.Rectangle2D.Double getFieldBounds(TextHolderFigure figure)


protected void endEdit()


public void actionPerformed(java.awt.event.ActionEvent event)
Specified by:
actionPerformed in interface java.awt.event.ActionListener