edu.umd.cs.jazz.component
Class ZText

java.lang.Object
  |
  +--edu.umd.cs.jazz.ZSceneGraphObject
        |
        +--edu.umd.cs.jazz.ZVisualComponent
              |
              +--edu.umd.cs.jazz.component.ZText
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable, ZAppearance, ZPenColor, ZPenPaint, ZSerializable

public class ZText
extends ZVisualComponent
implements ZPenColor, ZPenPaint, java.io.Serializable

ZText creates a visual component to support text. Multiple lines can be entered, and basic editing is supported. A caret is drawn, and can be repositioned with mouse clicks. The text object is positioned so that its upper-left corner is at the origin, though this can be changed with the translate methods.

Warning: Serialized and ZSerialized objects of this class will not be compatible with future Jazz releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Jazz. A future release of Jazz will provide support for long term persistence.

See Also:
Serialized Form

Field Summary
protected  java.awt.Color backgroundColor
          Background color for text.
protected  boolean boundsBug
          jdk version <= 1.2.1 has a bug: font.getStringBounds() gives the bounds of a space " " as zero.
protected  java.awt.Color caretColor
          Current caret color.
protected  int caretLine
          Line number of caret - current line.
protected  int caretPos
          Character position of caret within the current line.
protected  java.awt.geom.Line2D caretShape
          Drawn shape of the caret.
protected  double caretX
          X coordinate of caret relative to its coordinate frame.
protected  double caretY
          Y coordinate of caret relative to its coordinate frame.
protected static java.awt.Color DEFAULT_BACKGROUND_COLOR
          Default background color for text.
protected static java.awt.Color DEFAULT_CARET_COLOR
          Default caret color for text.
protected static boolean DEFAULT_EDITABLE
          Default specifying if text is editable.
protected static java.awt.Font DEFAULT_FONT
          Default font for text.
protected static java.lang.String DEFAULT_FONT_NAME
          Default font name of text.
protected static int DEFAULT_FONT_SIZE
          Default font size for text.
protected static int DEFAULT_FONT_STYLE
          Default font style for text.
protected static java.awt.Color DEFAULT_GREEK_COLOR
          Default color of text rendered as 'greek'.
protected static double DEFAULT_GREEK_THRESHOLD
          Below this magnification render text as 'greek'.
protected static java.awt.Color DEFAULT_PEN_COLOR
          Default color for text.
protected static java.lang.String DEFAULT_TEXT
          Default text when new text area is created.
protected  boolean editable
          Specifies if text is editable.
protected  java.awt.Font font
          Current text font.
protected  java.awt.Color greekColor
          Color for greek text.
protected  double greekThreshold
          Below this magnification text is rendered as greek.
protected static java.awt.font.FontRenderContext HIGH_QUALITY_FONT_CONTEXT
          The high quality graphic2D render context: AntiAliased, and uses FractionalMetrics.
protected  java.util.ArrayList lines
          Each vector element is one line of text.
protected static java.awt.font.FontRenderContext LOW_QUALITY_FONT_CONTEXT
          The low quality graphic2D render context: not antiAliased, and does not use FractionalMetrics.
protected  java.awt.Color penColor
          Current pen color.
protected  java.awt.font.FontRenderContext prevFRC
          The previously used font render context (i.e., from the last render).
protected  double translateX
          Translation offset X.
protected  double translateY
          Translation offset Y.
 
Fields inherited from class edu.umd.cs.jazz.ZSceneGraphObject
bounds, inTransaction, invalidBounds, invalidVolatileBounds, listenerList, volatileBounds, volatileBounds_DEFAULT
 
Constructor Summary
ZText()
          Default constructor for ZText.
ZText(java.lang.String str)
          ZText constructor with initial text.
ZText(java.lang.String str, java.awt.Font font)
          ZText constructor with initial text and font.
 
Method Summary
 void addChar(char c)
          Adds a character before the caret position.
 void addEnterChar()
          Creates a new line of text, splitting the current line at the caret position.
protected  void computeBounds()
          Notifies this object that it has changed and that it should update its notion of its bounding box.
 void deleteChar()
          Deletes the character after the caret position.
 void deleteCharBeforeCaret()
          Deletes the character before the caret position.
 void deleteToEndOfLine()
          Deletes from the caret position to the end of line.
protected  java.lang.Object duplicateObject()
          Returns a clone of this object.
 java.awt.Color getBackgroundColor()
          Returns the current background color.
 java.awt.Color getCaretColor()
          Returns the current caret color.
 int getCaretLine()
          Returns the current line.
 int getCaretPos()
          Returns the character position of the caret, within the current line.
 boolean getEditable()
          Determines if this text is editable.
 java.awt.Font getFont()
          Returns the current font.
 double getGreekThreshold()
          Returns the current greek threshold.
 java.awt.Color getPenColor()
          Returns the current pen color.
 java.awt.Paint getPenPaint()
          Returns the current pen paint.
 java.lang.String getText()
          Return the text within this text component.
 double getTranslateX()
          Get the X offset translation.
 double getTranslateY()
          Get the Y offset translation.
 java.awt.geom.Point2D getTranslation()
          Get the text translation offset.
 void keyPressed(java.awt.event.KeyEvent e)
          Processes keyboard events.
 void paintAsGreek(ZRenderContext renderContext)
          Paints this object as greek.
 void paintAsText(ZRenderContext renderContext)
          Paints this object normally (show it's text).
 void render(ZRenderContext renderContext)
          Renders the text object
 void setBackgroundColor(java.awt.Color color)
          Sets the current background color.
 void setCaretColor(java.awt.Color color)
          Sets the current caret color.
 void setCaretLine(int line)
          Sets the caretLine to line, if it exists.
 void setCaretPos(int cp)
          Set the caret this character position in the current line.
 void setCaretPos(java.awt.geom.Point2D pt)
          Set caret position to character closest to specified point (in object coords)
 void setEditable(boolean editable)
          Specifies whether this text is editable.
 void setFont(java.awt.Font aFont)
          Sets the font for the text.
 void setGreekThreshold(double threshold)
          Sets the current greek threshold.
 void setPenColor(java.awt.Color color)
          Sets the current pen color.
 void setPenPaint(java.awt.Paint aPaint)
          Sets the current pen paint.
 void setState(java.lang.String fieldType, java.lang.String fieldName, java.lang.Object fieldValue)
          Set some state of this object as it gets read back in.
 void setText(java.lang.String str)
          Sets the text of this visual component to str.
 void setTranslateX(double x)
          Set text translation offset X.
 void setTranslateY(double y)
          Set text translation offset Y.
 void setTranslation(double x, double y)
          Set the text translation offset to the specified position.
 void setTranslation(java.awt.geom.Point2D p)
          Set the text translation offset to point p.
 void writeObject(ZObjectOutputStream out)
          Write out all of this object's state.
 
Methods inherited from class edu.umd.cs.jazz.ZVisualComponent
addParent, getNumParents, getParents, getParentsReference, getRoot, paint, pick, pickBounds, removeParent, repaint, repaint, trimToSize, updateBounds, updateObjectReferences, updateVolatility, writeObjectRecurse
 
Methods inherited from class edu.umd.cs.jazz.ZSceneGraphObject
addClientProperty, addMouseListener, addMouseMotionListener, clone, computeVolatileBounds, dump, endTransaction, fireEvent, fireMouseEvent, getBounds, getBoundsReference, getClientProperty, getHandles, getListenerList, getVolatileBounds, hasLisenerOfType, hasListenerOfType, hasMouseListener, markInTransaction, markNotInTransaction, processMouseEvent, putClientProperty, removeEventListener, removeMouseListener, removeMouseMotionListener, reshape, setBounds, setVolatileBounds, startTransaction
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOW_QUALITY_FONT_CONTEXT

protected static final java.awt.font.FontRenderContext LOW_QUALITY_FONT_CONTEXT
The low quality graphic2D render context: not antiAliased, and does not use FractionalMetrics.


HIGH_QUALITY_FONT_CONTEXT

protected static final java.awt.font.FontRenderContext HIGH_QUALITY_FONT_CONTEXT
The high quality graphic2D render context: AntiAliased, and uses FractionalMetrics.


DEFAULT_GREEK_THRESHOLD

protected static final double DEFAULT_GREEK_THRESHOLD
Below this magnification render text as 'greek'.

See Also:
Constant Field Values

DEFAULT_GREEK_COLOR

protected static final java.awt.Color DEFAULT_GREEK_COLOR
Default color of text rendered as 'greek'.


DEFAULT_FONT_NAME

protected static final java.lang.String DEFAULT_FONT_NAME
Default font name of text.

See Also:
Constant Field Values

DEFAULT_FONT_STYLE

protected static final int DEFAULT_FONT_STYLE
Default font style for text.

See Also:
Constant Field Values

DEFAULT_FONT_SIZE

protected static final int DEFAULT_FONT_SIZE
Default font size for text.

See Also:
Constant Field Values

DEFAULT_FONT

protected static final java.awt.Font DEFAULT_FONT
Default font for text.


DEFAULT_PEN_COLOR

protected static final java.awt.Color DEFAULT_PEN_COLOR
Default color for text.


DEFAULT_BACKGROUND_COLOR

protected static final java.awt.Color DEFAULT_BACKGROUND_COLOR
Default background color for text.


DEFAULT_CARET_COLOR

protected static final java.awt.Color DEFAULT_CARET_COLOR
Default caret color for text.


DEFAULT_EDITABLE

protected static final boolean DEFAULT_EDITABLE
Default specifying if text is editable.

See Also:
Constant Field Values

DEFAULT_TEXT

protected static final java.lang.String DEFAULT_TEXT
Default text when new text area is created.

See Also:
Constant Field Values

greekThreshold

protected double greekThreshold
Below this magnification text is rendered as greek.


greekColor

protected java.awt.Color greekColor
Color for greek text.


penColor

protected java.awt.Color penColor
Current pen color.


backgroundColor

protected java.awt.Color backgroundColor
Background color for text.


caretColor

protected java.awt.Color caretColor
Current caret color.


caretPos

protected int caretPos
Character position of caret within the current line.


caretLine

protected int caretLine
Line number of caret - current line.


caretX

protected double caretX
X coordinate of caret relative to its coordinate frame.


caretY

protected double caretY
Y coordinate of caret relative to its coordinate frame.


caretShape

protected transient java.awt.geom.Line2D caretShape
Drawn shape of the caret.


font

protected java.awt.Font font
Current text font.


lines

protected java.util.ArrayList lines
Each vector element is one line of text.


editable

protected boolean editable
Specifies if text is editable.


prevFRC

protected transient java.awt.font.FontRenderContext prevFRC
The previously used font render context (i.e., from the last render).


boundsBug

protected boolean boundsBug
jdk version <= 1.2.1 has a bug: font.getStringBounds() gives the bounds of a space " " as zero.


translateX

protected double translateX
Translation offset X.


translateY

protected double translateY
Translation offset Y.

Constructor Detail

ZText

public ZText()
Default constructor for ZText.


ZText

public ZText(java.lang.String str)
ZText constructor with initial text.


ZText

public ZText(java.lang.String str,
             java.awt.Font font)
ZText constructor with initial text and font.

Method Detail

duplicateObject

protected java.lang.Object duplicateObject()
Returns a clone of this object.

Overrides:
duplicateObject in class ZVisualComponent
See Also:
ZSceneGraphObject.duplicateObject()

getPenColor

public java.awt.Color getPenColor()
Returns the current pen color.

Specified by:
getPenColor in interface ZPenColor
Returns:
the pen color, or null if none.

setPenColor

public void setPenColor(java.awt.Color color)
Sets the current pen color.

Specified by:
setPenColor in interface ZPenColor
Parameters:
color - the pen color, or null if none.

getPenPaint

public java.awt.Paint getPenPaint()
Returns the current pen paint.

Specified by:
getPenPaint in interface ZPenPaint
Returns:
the pen paint, or null if none.

setPenPaint

public void setPenPaint(java.awt.Paint aPaint)
Sets the current pen paint.

Specified by:
setPenPaint in interface ZPenPaint
Parameters:
aPaint - the pen paint, or null if none.

getBackgroundColor

public java.awt.Color getBackgroundColor()
Returns the current background color.


setBackgroundColor

public void setBackgroundColor(java.awt.Color color)
Sets the current background color.


getCaretColor

public java.awt.Color getCaretColor()
Returns the current caret color.


setCaretColor

public void setCaretColor(java.awt.Color color)
Sets the current caret color.


getGreekThreshold

public double getGreekThreshold()
Returns the current greek threshold. Below this magnification text is rendered as 'greek'.


setGreekThreshold

public void setGreekThreshold(double threshold)
Sets the current greek threshold. Below this magnification text is rendered as 'greek'.


getEditable

public boolean getEditable()
Determines if this text is editable.


setEditable

public void setEditable(boolean editable)
Specifies whether this text is editable.


getFont

public java.awt.Font getFont()
Returns the current font.


getText

public java.lang.String getText()
Return the text within this text component. Multline text is returned as a single string where each line is separated by a newline character. Single line text does not have any newline characters.


getCaretPos

public int getCaretPos()
Returns the character position of the caret, within the current line.


getCaretLine

public int getCaretLine()
Returns the current line.


setFont

public void setFont(java.awt.Font aFont)
Sets the font for the text.

Warning: Java has a serious bug in that it does not support very small fonts. In particular, fonts that are less than about a pixel high just don't work. Since in Jazz, it is common to create objects of arbitrary sizes, and then scale them, an application can easily create a text object with a very small font by accident. The workaround for this bug is to create a larger font for the text object, and then scale the node down correspondingly.


setText

public void setText(java.lang.String str)
Sets the text of this visual component to str. Multiple lines of text are separated by a newline character.


addChar

public void addChar(char c)
Adds a character before the caret position.


addEnterChar

public void addEnterChar()
Creates a new line of text, splitting the current line at the caret position.


deleteChar

public void deleteChar()
Deletes the character after the caret position.


deleteCharBeforeCaret

public void deleteCharBeforeCaret()
Deletes the character before the caret position.


deleteToEndOfLine

public void deleteToEndOfLine()
Deletes from the caret position to the end of line. If caret is at the end of the line, joins current line to the next.


setCaretLine

public void setCaretLine(int line)
Sets the caretLine to line, if it exists.


setCaretPos

public void setCaretPos(int cp)
Set the caret this character position in the current line.


setCaretPos

public void setCaretPos(java.awt.geom.Point2D pt)
Set caret position to character closest to specified point (in object coords)


setTranslateX

public void setTranslateX(double x)
Set text translation offset X.

Parameters:
x - the X translation.

getTranslateX

public double getTranslateX()
Get the X offset translation.

Returns:
the X translation.

setTranslateY

public void setTranslateY(double y)
Set text translation offset Y.

Parameters:
y - the Y translation.

getTranslateY

public double getTranslateY()
Get the Y offset translation.

Returns:
the Y translation.

setTranslation

public void setTranslation(double x,
                           double y)
Set the text translation offset to the specified position.

Parameters:
x - the X-coord of translation
y - the Y-coord of translation

setTranslation

public void setTranslation(java.awt.geom.Point2D p)
Set the text translation offset to point p.

Parameters:
p - The translation offset.

getTranslation

public java.awt.geom.Point2D getTranslation()
Get the text translation offset.

Returns:
The translation offset.

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)
Processes keyboard events. Implements basic text editing and cursor movement.


render

public void render(ZRenderContext renderContext)
Renders the text object

The transform, clip, and composite will be set appropriately when this object is rendered. It is up to this object to restore the transform, clip, and composite of the Graphics2D if this node changes any of them. However, the color, font, and stroke are unspecified by Jazz. This object should set those things if they are used, but they do not need to be restored.

Overrides:
render in class ZVisualComponent
Parameters:
renderContext - The graphics context to use for rendering.
See Also:
ZVisualComponent.paint(Graphics2D)

paintAsGreek

public void paintAsGreek(ZRenderContext renderContext)
Paints this object as greek.


paintAsText

public void paintAsText(ZRenderContext renderContext)
Paints this object normally (show it's text). Note that the entire text gets rendered so that it's upper left corner appears at the origin of this local object.


computeBounds

protected void computeBounds()
Notifies this object that it has changed and that it should update its notion of its bounding box.

Overrides:
computeBounds in class ZSceneGraphObject

setState

public void setState(java.lang.String fieldType,
                     java.lang.String fieldName,
                     java.lang.Object fieldValue)
Set some state of this object as it gets read back in. After the object is created with its default no-arg constructor, this method will be called on the object once for each bit of state that was written out through calls to ZObjectOutputStream.writeState() within the writeObject method.

Specified by:
setState in interface ZSerializable
Overrides:
setState in class ZVisualComponent
Parameters:
fieldType - The fully qualified type of the field
fieldName - The name of the field
fieldValue - The value of the field

writeObject

public void writeObject(ZObjectOutputStream out)
                 throws java.io.IOException
Write out all of this object's state.

Specified by:
writeObject in interface ZSerializable
Overrides:
writeObject in class ZVisualComponent
Parameters:
out - The stream that this object writes into
java.io.IOException


Copyright 2003 by University of Maryland, College Park, MD 20742, USA All rights reserved.