chargerlib

Class WrappedText

Object

chargerlib.WrappedText

public class WrappedText
extends Object

Represents a text string processed for word wrapping. Wrapping considers all characters to be of equal width (i.e., think mono-spaced font)

Field Summary

Fields

Modifier and Type	Field and Description
static String	breakCharacters The set of characters that can be used to split lines.
(package private) int	columns the number of columns to wrap.
(package private) boolean	enableWrapping
(package private) Font	font The font in which this text is to be rendered.
(package private) String	s The string being represented, as a single "line"
(package private) ArrayList<String>	textLines the set of lines already wrapped

Constructor Summary

Constructors

Constructor and Description
WrappedText(String s) Create a string to be wrapped, but turns off the wrapping function.
WrappedText(String s, int cols) Create a string to be wrapped at no wider than a certain number of characters.

Method Summary

Modifier and Type	Method and Description
void	drawWrappedText(Graphics2D g, Point2D.Double center) Uses drawString to render the text on a graphics context.
void	drawWrappedText(Graphics2D g, Point2D.Double center, Font font)
int	getColumns()
Font	getFont()
ArrayList<String>	getLines()
int	getNumLines() Get the number of lines needed to render the wrapped text.
Dimension	getSize(FontMetrics fm) Find the size of the box in which the entire wrapped text fits.
Dimension	getSize(Graphics2D g) Find the size of the box in which the entire wrapped text fits.
boolean	isEnableWrapping() Whether to wrap the text or not
void	setColumns(int columns) Sets the number of characters wide to render the text.
void	setEnableWrapping(boolean enableWrapping) Tells the wrapper whether to actually wrap the text or consider it all on one line.
void	setFont(Font font)
ArrayList<String>	stringBreak(String string, String breakchars, int maxChars) Breaks up the string by breaking words at the occurrence of any member of set of break characters.

Methods inherited from class Object

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

Field Detail

breakCharacters

public static String breakCharacters

The set of characters that can be used to split lines. Currently has the value " _-,;:\n\t"

s

String s

The string being represented, as a single "line"

font

Font font

The font in which this text is to be rendered.

textLines

ArrayList<String> textLines

the set of lines already wrapped

columns

int columns

the number of columns to wrap. Note this does not take into account font char widths, etc.

enableWrapping

boolean enableWrapping

Constructor Detail

WrappedText

public WrappedText(String s)

Create a string to be wrapped, but turns off the wrapping function. User may call setColumns() to actually wrap the text.

Parameters:

s -

WrappedText

public WrappedText(String s,
                   int cols)

Create a string to be wrapped at no wider than a certain number of characters. if enabledWrapping is false, then has no effect.

Parameters:

s - the string to be wrapped

cols - the maximum numbers of characters per line.

Method Detail

getColumns

public int getColumns()

setColumns

public void setColumns(int columns)

Sets the number of characters wide to render the text. Refreshes the lines according to the new value.

Parameters:

columns - a number of characters wide for the text. If -1, then no wrapping is performed and exactly one line is produced.

getFont

public Font getFont()

setFont

public void setFont(Font font)

isEnableWrapping

public boolean isEnableWrapping()

Whether to wrap the text or not

Returns:

true if wrapping is enabled; false otherwise

setEnableWrapping

public void setEnableWrapping(boolean enableWrapping)

Tells the wrapper whether to actually wrap the text or consider it all on one line.

Parameters:

enableWrapping -

getNumLines

public int getNumLines()

Get the number of lines needed to render the wrapped text.

Returns:

number of lines needed to render the wrapped text

drawWrappedText

public void drawWrappedText(Graphics2D g,
                            Point2D.Double center)

Uses drawString to render the text on a graphics context. All current font choices, colors, etc. are used. This means that all the text will be in the same font, etc.

Parameters:

g - the graphics context to be used

center - the center point of the ENTIRE text. The method will figure out how best to render the whole thing centered.

drawWrappedText

public void drawWrappedText(Graphics2D g,
                            Point2D.Double center,
                            Font font)

getSize

public Dimension getSize(Graphics2D g)

Find the size of the box in which the entire wrapped text fits.

Parameters:

g - the graphics context which contains the font metrics.

Returns:

the size of the box that encloses the entire displayed text.

getSize

public Dimension getSize(FontMetrics fm)

Find the size of the box in which the entire wrapped text fits.

Parameters:

fm - the font metrics which controls the rendering

Returns:

the size of the box that encloses the entire displayed text.

getLines

public ArrayList<String> getLines()

stringBreak

public ArrayList<String> stringBreak(String string,
                                     String breakchars,
                                     int maxChars)

Breaks up the string by breaking words at the occurrence of any member of set of break characters.

Parameters:

string - the string to wrap

breakchars - the characters from which to determine a break characters

maxChars - maximum number of characters per line when breaking. If -1 then don't break.

Returns:

the list of lines after wrapping has been applied. If no wrapping, consists of a single element.