org.das2.util

Class GrannyTextRenderer

java.lang.Object

org.das2.util.GrannyTextRenderer

public class GrannyTextRenderer
extends java.lang.Object

Utility class for rendering "Granny" strings, which use the codes identified by Grandle and Nystrom in their 1980 paper to provide rich formatting such as new lines and superscripts. This has been extended significantly to include some html support, and extensions which paint arbitrary graphics. Granny are strings like "E=mc!e2" where the "!e" indicates the pen should be moved to the exponent position before drawing. This supports sequences including:

 !A  shift up one half line
 !B  shift down one half line  (e.g.  !A3!n-!B4!n is 3/4).
 !C  newline 
 !D  subscript 0.62 of old font size.
 !U  superscript of 0.62 of old font size.
 !E  superscript 0.44 of old font size.
 !I  subscript 0.44 of old font size.
 !N  return to the original font size.
 !R  restore position to last saved position
 !S  save the current position.
 !K  reduce the font size. (Not in IDL's set.)
 !!  the exclamation point (!)
 !(ext;args) where ext can be:
 !(color;saddleBrown)  switch to color.
 !(painter;codeId;codeArg1)  Plug-in Java code for painting regions.
 !(bold) switch to bold
 !(italic) switch to italic
 !(unbold) switch off bold by switching to plain
 !(unitalic) switch off italic by switching to plain
 !(underline) switch to underline
 !(ununderline) switch to underline
 

For Greek and math symbols, Unicode characters should be used like so: ☎ (☎ phone symbol), or symbols like Ω and ω The GrannyTextRenderer object is created and then the method setString is called and layout is performed, in Jython:

 def paint(g):
    gtr= GrannyTextRenderer()
    gtr.setString( g, 'E=mc!e2' )
    gtr.draw( g, 0, g.getFont().getHeight() )
 

See Also:

https://github.com/das-developers/das2java/wiki/Granny-Text-Strings, java.awt.font.TextLayout, which may do some of the same things., org.das2.graph.GrannyTextLabeller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GrannyTextRenderer.Painter

Field Summary

Fields

Modifier and Type	Field and Description
static float	CENTER_ALIGNMENT
static float	LEFT_ALIGNMENT
static java.lang.String	PROP_GLOW
static float	RIGHT_ALIGNMENT

Constructor Summary

Constructors

Constructor and Description
GrannyTextRenderer()

Method Summary

Modifier and Type	Method and Description
void	addPainter(java.lang.String id, GrannyTextRenderer.Painter p) add a painter for the grannyTextRenderer.
void	clearPainters() remove all the painters
void	draw(java.awt.Graphics ig, float ix, float iy) draw the current string.
float	getAlignment() returns the current alignment, by default LEFT_ALIGNMENT.
double	getAscent() return the amount that the bounding box will go above the baseline.
java.awt.Rectangle	getBounds() returns the bounds of the current string.
java.awt.geom.Rectangle2D	getBounds2D() return a rectangle backed by floating point numbers.
double	getDescent() return the amount that the bounding box will go below the baseline.
double	getHeight() returns the hieght of the calculated bounding box.
double	getLineOneWidth() returns the width in pixels of the first line.
java.lang.String	getString() return the string.
double	getWidth() returns the width of the bounding box, in pixels.
boolean	isGlow()
static int	lineCount(java.lang.String s) count the number of lines in the string, breaking on "!c" or "<br>", ignoring empty lines at the beginning.
void	removePainter(java.lang.String id) remove the painter with the given id.
void	setAlignment(float a) set the alignment for rendering, one of LEFT_ALIGNMENT CENTER_ALIGNMENT or RIGHT_ALIGNMENT.
void	setGlow(boolean glow)
void	setString(java.awt.Component c, java.lang.String str) Deprecated. use setString( Graphics g, String str ) instead.
void	setString(java.awt.Font font, java.lang.String label) reset the current string for the GTR to draw, calculating the boundaries of the string.
void	setString(java.awt.Graphics g, java.lang.String str) reset the current string for the GTR to draw, calculating the boundaries of the string.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LEFT_ALIGNMENT

public static final float LEFT_ALIGNMENT

See Also:

Constant Field Values

CENTER_ALIGNMENT

public static final float CENTER_ALIGNMENT

See Also:

Constant Field Values

RIGHT_ALIGNMENT

public static final float RIGHT_ALIGNMENT

See Also:

Constant Field Values

PROP_GLOW

public static final java.lang.String PROP_GLOW

See Also:

Constant Field Values

Constructor Detail

GrannyTextRenderer

public GrannyTextRenderer()

Method Detail

addPainter

public void addPainter(java.lang.String id,
                       GrannyTextRenderer.Painter p)

add a painter for the grannyTextRenderer. This is done by associating a Painter code with an id, and the id is used within the annotation string.

Parameters:

id - id for the painter, where the id is found in the granny text string

p - the painter code which draws on a graphics context.

removePainter

public void removePainter(java.lang.String id)

remove the painter with the given id.

Parameters:

id - id for the painter, where the id is found in the granny text string

clearPainters

public void clearPainters()

remove all the painters

getBounds

public java.awt.Rectangle getBounds()

returns the bounds of the current string. The lower-left corner of the first character will be roughly (0,0), to be compatible with FontMetrics.getStringBounds().

Returns:

a Rectangle indicating the text boundaries.

Throws:

java.lang.IllegalArgumentException - if the string has not been set.

getBounds2D

public java.awt.geom.Rectangle2D getBounds2D()

return a rectangle backed by floating point numbers.

Returns:

Rectangle2D.Double

getWidth

public double getWidth()

returns the width of the bounding box, in pixels.

Returns:

the width of the bounding box, in pixels.

Throws:

java.lang.IllegalArgumentException - if the string has not been set.

getLineOneWidth

public double getLineOneWidth()

returns the width in pixels of the first line.

Returns:

the width in pixels of the first line.

Throws:

java.lang.IllegalArgumentException - if the string has not been set.

getHeight

public double getHeight()

returns the hieght of the calculated bounding box.

Returns:

the height of the bounding box, in pixels.

Throws:

java.lang.IllegalArgumentException - if the string has not been set.

getAscent

public double getAscent()

return the amount that the bounding box will go above the baseline. This is also the height of the first line.

Returns:

the amount that the bounding box will go above the baseline.

Throws:

java.lang.IllegalArgumentException - if the string has not been set.

getDescent

public double getDescent()

return the amount that the bounding box will go below the baseline.

Returns:

the amount that the bounding box will go below the baseline.

Throws:

java.lang.IllegalArgumentException - if the string has not been set.

setString

public void setString(java.awt.Component c,
                      java.lang.String str)

Deprecated. use setString( Graphics g, String str ) instead.

reset the current string for the GTR to draw, calculating the boundaries of the string. For greek and math symbols, unicode characters should be used. (See www.unicode.org). See the documentation for this class for a description of symbols.

Parameters:

c - the component which will provide the graphics.

str - the granny string, such as "E=mc!e2"

setString

public void setString(java.awt.Graphics g,
                      java.lang.String str)

reset the current string for the GTR to draw, calculating the boundaries of the string. For greek and math symbols, unicode characters should be used. (See www.unicode.org).

Parameters:

g - the graphics context which will supply the FontMetrics.

str - the granny string, such as "E=mc!e2"

setString

public void setString(java.awt.Font font,
                      java.lang.String label)

reset the current string for the GTR to draw, calculating the boundaries of the string. For greek and math symbols, unicode characters should be used. (See www.unicode.org).

Parameters:

font - the font. This should be consistent with the Font used when drawing.

label - the granny string, such as "E=mc!e2"

getString

public java.lang.String getString()

return the string.

Returns:

getAlignment

public float getAlignment()

returns the current alignment, by default LEFT_ALIGNMENT.

Returns:

the current alignment.

setAlignment

public void setAlignment(float a)

set the alignment for rendering, one of LEFT_ALIGNMENT CENTER_ALIGNMENT or RIGHT_ALIGNMENT.

Parameters:

a - the alignment, one of LEFT_ALIGNMENT CENTER_ALIGNMENT or RIGHT_ALIGNMENT.

isGlow

public boolean isGlow()

setGlow

public void setGlow(boolean glow)

draw

public void draw(java.awt.Graphics ig,
                 float ix,
                 float iy)

draw the current string. Note the first line will be above iy, and following lines will be below iy. This is to be consistent with Graphics2D.drawString.

Parameters:

ig - Graphic object to use to render the text.

ix - The x position of the first character of text.

iy - The y position of the baseline of the first line of text.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

lineCount

public static int lineCount(java.lang.String s)

count the number of lines in the string, breaking on "!c" or "<br>", ignoring empty lines at the beginning.

Parameters:

s - the string

Returns:

the number of lines