|
NASA World Wind | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectgov.nasa.worldwind.render.MultiLineTextRenderer
public class MultiLineTextRenderer
Multi line, rectangle bound text renderer with (very) minimal html support.
The MultiLineTextRenderer
(MLTR) handles wrapping, measuring and drawing
of multiline text strings using Sun's JOGL TextRenderer
.
A multiline text string is a character string containing new line characters in between lines.
MLTR can handle both regular text with new line seprators and a very minimal implementation of HTML. Each type of text has its own methods though.
Usage:
Instantiation:
The MLTR needs a Font or a TextRenderer to be instanciated. This will be the font used for text drawing, wrapping and measuring. For HTML methods this font will be considered as the document default font.
Font font = Font.decode("Arial-PLAIN-12"); MultiLineTextRenderer mltr = new MultiLineTextRenderer(font);or
TextRenderer tr = new TextRenderer(Font.decode("Arial-PLAIN-10")); MultiLineTextRenderer mltr = new MultiLineTextRenderer(tr);
Drawing regular text:
String text = "Line one.\nLine two.\nLine three..."; int x = 10; // Upper left corner of text rectangle. int y = 200; // Origin at bottom left of screen. int lineHeight = 14; // Line height in pixels. Color color = Color.RED; mltr.setTextColor(color); mltr.getTextRenderer().begin3DRendering(); mltr.draw(text, x, y, lineHeight); mltr.getTextRenderer().end3DRendering();
Wrapping text to fit inside a width and optionaly a height
The MLTR wrap method will insert new line characters inside the text so that it fits a given width in pixels.
If a height dimension above zero is specified too, the text will be truncated if needed, and a continuation string will be appended to the last line. The continuation string can be set with mltr.setContinuationString();
// Fit inside 300 pixels, no height constraint String wrappedText = mltr.wrap(text, new Dimension(300, 0)); // Fit inside 300x400 pixels, text may be truncated String wrappedText = mltr.wrap(text, new Dimension(300, 400));
Measuring text
Rectangle2D textBounds = mltr.getBounds(text);
The textBounds rectangle returned contains the width and height of the text as it would be drawn with the current font.
Note that textBounds.minX is the number of lines found and textBounds.minY is the maximum line height for the font used. This value can be safely used as the lineHeight argument when drawing - or can even be ommited after a getBounds: draw(text, x, y); ...
HTML support
Supported tags are:
See AbstractAnnotation
.drawAnnotation() for more usage details.
Field Summary | |
---|---|
static int |
ALIGN_CENTER
|
static int |
ALIGN_LEFT
|
static int |
ALIGN_RIGHT
|
static java.lang.String |
EFFECT_NONE
|
static java.lang.String |
EFFECT_OUTLINE
|
static java.lang.String |
EFFECT_SHADOW
|
Constructor Summary | |
---|---|
MultiLineTextRenderer(TextRenderer textRenderer)
|
Method Summary | |
---|---|
static boolean |
containsHTML(java.lang.String text)
Return true if the text contains some sgml tags. |
void |
draw(java.lang.String text,
int x,
int y)
Draw a multi-line text string with bounding rectangle top starting at the y position. |
void |
draw(java.lang.String text,
int x,
int y,
int textLineHeight)
Draw a multi-line text string with bounding rectangle top starting at the y position. |
void |
draw(java.lang.String text,
int x,
int y,
int textLineHeight,
java.lang.String effect)
Draw a multi-line text string with bounding rectangle top starting at the y position. |
void |
draw(java.lang.String text,
int x,
int y,
java.lang.String effect)
Draw a multi-line text string with bounding rectangle top starting at the y position. |
void |
drawHTML(java.lang.String text,
int x,
int y,
TextRendererCache renderers)
Draw a multi-line html text string with bounding rectangle top starting at the y position. |
static java.lang.String |
getAttributeFromTagHTML(java.lang.String text,
java.lang.String attributeName)
Extract an attribute value from a HTML tag string. |
java.awt.Color |
getBackColor()
Get the background color used for EFFECT_SHADOW and EFFECT_OUTLINE. |
java.awt.Rectangle |
getBounds(java.lang.String text)
Returns the bounding rectangle for a multi-line string. |
java.awt.geom.Rectangle2D |
getBoundsHTML(java.lang.String text,
TextRendererCache renderers)
Returns the bounding rectangle for a multi-line html string. |
int |
getLineHeight()
Get the current line height in pixels. |
int |
getLineSpacing()
Get the current line spacing height in pixels. |
java.awt.Color |
getLinkColor()
Get the current link color. |
double |
getMaxLineHeight(TextRenderer tr)
Get the maximum line height for the given text renderer. |
int |
getTextAlign()
Get the current text alignment. |
java.awt.Color |
getTextColor()
Get the current text color. |
TextRenderer |
getTextRenderer()
Get the current TextRenderer. |
void |
pick(java.lang.String text,
int x,
int y,
int textLineHeight,
DrawContext dc,
PickSupport pickSupport,
java.lang.Object refObject,
Position refPosition)
Draw text with unique colors word bounding rectangles and add each as a pickable object to the provided PickSupport instance. |
void |
pickHTML(java.lang.String text,
int x,
int y,
TextRendererCache renderers,
DrawContext dc,
PickSupport pickSupport,
java.lang.Object refObject,
Position refPosition)
Draw text with unique colors word bounding rectangles and add each as a pickable object to the provided PickSupport instance. |
static java.lang.String |
processLineBreaksHTML(java.lang.String text)
Remove new line characters then replace BR and P tags with appropriate new lines |
static java.lang.String |
removeTagsHTML(java.lang.String text)
Remove all HTML tags from a text string. |
void |
setBackColor(java.awt.Color color)
Set the background color used for EFFECT_SHADOW and EFFECT_OUTLINE. |
void |
setContinuationString(java.lang.String s)
Set the character string appended at the end of text truncated during a wrap operation when exceeding the given height limit. |
void |
setLineHeight(int height)
Set the current line height in pixels. |
void |
setLineSpacing(int height)
Set the current line spacing height in pixels. |
void |
setLinkColor(java.awt.Color color)
Set the link color. |
void |
setTextAlign(int align)
Set the current text alignment. |
void |
setTextColor(java.awt.Color color)
Set the text renderer color. |
java.lang.String |
wrap(java.lang.String text,
java.awt.Dimension dimension)
Add 'new line' characters inside a string so that it's bounding rectangle tries not to exceed the given dimension width. |
java.lang.String |
wrapHTML(java.lang.String text,
java.awt.Dimension dimension,
TextRendererCache renderers)
Add 'new line' characters inside an html text string so that it's bounding rectangle tries not to exceed the given dimension width. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int ALIGN_CENTER
public static final int ALIGN_LEFT
public static final int ALIGN_RIGHT
public static final java.lang.String EFFECT_NONE
public static final java.lang.String EFFECT_OUTLINE
public static final java.lang.String EFFECT_SHADOW
Constructor Detail |
---|
public MultiLineTextRenderer(TextRenderer textRenderer)
Method Detail |
---|
public static boolean containsHTML(java.lang.String text)
text
- The text string to evaluate.
public void draw(java.lang.String text, int x, int y)
text
- the multi-line text to draw.x
- the x position for top left corner of text rectangle.y
- the y position for top left corner of the text rectangle.public void draw(java.lang.String text, int x, int y, int textLineHeight)
text
- the multi-line text to draw.x
- the x position for top left corner of text rectangle.y
- the y position for top left corner of the text rectangle.textLineHeight
- the line height in pixels.public void draw(java.lang.String text, int x, int y, int textLineHeight, java.lang.String effect)
text
- the multi-line text to draw.x
- the x position for top left corner of text rectangle.y
- the y position for top left corner of the text rectangle.textLineHeight
- the line height in pixels.effect
- the effect to use for the text rendering. Can be one of EFFECT_NONE
,
EFFECT_SHADOW
or EFFECT_OUTLINE
.public void draw(java.lang.String text, int x, int y, java.lang.String effect)
text
- the multi-line text to draw.x
- the x position for top left corner of text rectangle.y
- the y position for top left corner of the text rectangle.effect
- the effect to use for the text rendering. Can be one of EFFECT_NONE
,
EFFECT_SHADOW
or EFFECT_OUTLINE
.public void drawHTML(java.lang.String text, int x, int y, TextRendererCache renderers)
text
- the multi-line text to drawx
- the x position for top left corner of text rectangley
- the y position for top left corner of the text rectanglerenderers
- A HashMap of fonts and shared text renderers.public static java.lang.String getAttributeFromTagHTML(java.lang.String text, java.lang.String attributeName)
text
- the HTML tage string.attributeName
- the attribute name.
public java.awt.Color getBackColor()
public java.awt.Rectangle getBounds(java.lang.String text)
text
- the multi-line text to evaluate.
public java.awt.geom.Rectangle2D getBoundsHTML(java.lang.String text, TextRendererCache renderers)
text
- the multi-line html text to evaluate.renderers
- A HashMap of fonts and shared text renderers.
public int getLineHeight()
public int getLineSpacing()
public java.awt.Color getLinkColor()
public double getMaxLineHeight(TextRenderer tr)
tr
- the TextRenderer.
public int getTextAlign()
ALIGN_LEFT
the default,
ALIGN_CENTER
or ALIGN_RIGHT
.
public java.awt.Color getTextColor()
public TextRenderer getTextRenderer()
public void pick(java.lang.String text, int x, int y, int textLineHeight, DrawContext dc, PickSupport pickSupport, java.lang.Object refObject, Position refPosition)
text
- the multi-line text to draw.x
- the x position for top left corner of text rectangle.y
- the y position for top left corner of the text rectangle.textLineHeight
- the line height in pixels.dc
- the current DrawContext.pickSupport
- the PickSupport instance to be used.refObject
- the user reference object associated with every picked word.refPosition
- the user reference Position associated with every picked word.public void pickHTML(java.lang.String text, int x, int y, TextRendererCache renderers, DrawContext dc, PickSupport pickSupport, java.lang.Object refObject, Position refPosition)
text
- the multi-line text to draw.x
- the x position for top left corner of text rectangle.y
- the y position for top left corner of the text rectangle.renderers
- A HashMap of fonts and shared text renderers.dc
- the current DrawContext.pickSupport
- the PickSupport instance to be used.refObject
- the user reference object associated with every picked word.refPosition
- the user reference Position associated with every picked word.public static java.lang.String processLineBreaksHTML(java.lang.String text)
text
- The html text string to process.
public static java.lang.String removeTagsHTML(java.lang.String text)
text
- the string to filter.
public void setBackColor(java.awt.Color color)
color
- the color to use when drawing shadow or outline.public void setContinuationString(java.lang.String s)
s
- the continuation character string.public void setLineHeight(int height)
height
- the current line height in pixels.public void setLineSpacing(int height)
height
- the line spacing height in pixels.public void setLinkColor(java.awt.Color color)
color
- the color to use when drawing hyperlinks.public void setTextAlign(int align)
ALIGN_LEFT
the default,
ALIGN_CENTER
or ALIGN_RIGHT
.
align
- the current text alignment.public void setTextColor(java.awt.Color color)
color
- the color to use when drawing text.public java.lang.String wrap(java.lang.String text, java.awt.Dimension dimension)
text
- the text string to wrapdimension
- the maximum dimension in pixels
public java.lang.String wrapHTML(java.lang.String text, java.awt.Dimension dimension, TextRendererCache renderers)
text
- the html text string to wrapdimension
- the maximum dimension in pixelsrenderers
- A HashMap of fonts and shared text renderers.
|
NASA World Wind | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |