org.jhotdraw.draw
Interface TextHolderFigure

All Superinterfaces:

java.lang.Cloneable, Figure, java.io.Serializable

All Known Implementing Classes:

LabelFigure, NodeFigure, SVGTextAreaFigure, SVGTextFigure, TextAreaFigure, TextFigure

@NotNull
public interface TextHolderFigure
extends Figure

The interface of a Figure that has some editable text contents.

Design Patterns

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

Prototype
The text input format creates new text holder figures by cloning a prototype figure object and assigning an image to it, which was read from data input. That's the reason why Figure extends the Cloneable interface.
Prototype: TextHolderFigure; Client: TextInputFormat.

Version:

$Id: TextHolderFigure.java 654 2010-06-25 13:27:08Z rawcoder $

Author:

Werner Randelshofer

Field Summary

Fields inherited from interface org.jhotdraw.draw.Figure

CONNECTABLE_PROPERTY, REMOVABLE_PROPERTY, SELECTABLE_PROPERTY, TRANSFORMABLE_PROPERTY

Method Summary

double	getBaseline() Gets the baseline of the first line of text, relative to the upper left corner of the figure bounds.
java.awt.Color	getFillColor() Returns the fill color to be used by a text editor for editing this Figure.
java.awt.Font	getFont() Returns the font to be used by a text editor for editing this Figure.
float	getFontSize() Gets the font size of the text held by the TextHolderFigure.
Insets2D.Double	getInsets() Returns Insets to be used by the text editor relative to the handle bounds of the figure.
TextHolderFigure	getLabelFor() Sometimes we want to use a TextHolderFigure as a label for another TextHolderFigure.
int	getTabSize() Gets the number of characters used to expand tabs.
java.lang.String	getText() Returns the text held by the Text Holder.
java.awt.Color	getTextColor() Returns the text color to be used by a text editor for editing this Figure.
int	getTextColumns() Gets the number of columns to be overlaid when the figure is edited.
boolean	isEditable() Returns true if the text of the TextHolderFigure can be edited.
boolean	isTextOverflow() Returns true, if the text does not fit into the bounds of the Figure.
void	setFontSize(float size) Sets the font size of the text held by the TextHolderFigure.
void	setText(java.lang.String text) Sets the text of the Text Holder.

Methods inherited from interface org.jhotdraw.draw.Figure

addFigureListener, addNotify, addPropertyChangeListener, changed, clone, contains, createHandles, draw, findCompatibleConnector, findConnector, findFigureInside, get, getActions, getAttributes, getAttributesRestoreData, getBounds, getConnectors, getCursor, getDecomposition, getDrawingArea, getEndPoint, getLayer, getPreferredSize, getStartPoint, getTool, getToolTipText, getTransformRestoreData, handleDrop, handleMouseClick, includes, isConnectable, isRemovable, isSelectable, isTransformable, isVisible, remap, removeFigureListener, removeNotify, removePropertyChangeListener, requestRemove, restoreAttributesTo, restoreTransformTo, set, setBounds, transform, willChange

Method Detail

isEditable

boolean isEditable()

Returns true if the text of the TextHolderFigure can be edited.

getFont

java.awt.Font getFont()

Returns the font to be used by a text editor for editing this Figure.

getTextColor

java.awt.Color getTextColor()

Returns the text color to be used by a text editor for editing this Figure.

getFillColor

java.awt.Color getFillColor()

Returns the fill color to be used by a text editor for editing this Figure.

getLabelFor

TextHolderFigure getLabelFor()

Sometimes we want to use a TextHolderFigure as a label for another TextHolderFigure. Returns the TextHolderFigure that should be really used.

getTabSize

int getTabSize()

Gets the number of characters used to expand tabs.

getText

java.lang.String getText()

Returns the text held by the Text Holder.

setText

void setText(java.lang.String text)

Sets the text of the Text Holder.

Parameters:

text -

getTextColumns

int getTextColumns()

Gets the number of columns to be overlaid when the figure is edited.

setFontSize

void setFontSize(float size)

Sets the font size of the text held by the TextHolderFigure.

getFontSize

float getFontSize()

Gets the font size of the text held by the TextHolderFigure.

getBaseline

double getBaseline()

Gets the baseline of the first line of text, relative to the upper left corner of the figure bounds.

getInsets

Insets2D.Double getInsets()

Returns Insets to be used by the text editor relative to the handle bounds of the figure.

isTextOverflow

boolean isTextOverflow()

Returns true, if the text does not fit into the bounds of the Figure.