StyledString (Javadocs: G4P)

java.lang.Object
- g4p_controls.StyledString

All Implemented Interfaces:

java.io.Serializable
```
public final class StyledString
extends java.lang.Object
implements java.io.Serializable
```
This class is used to represent text with attributes.
It means that you don't have to have the same style of font or even the same font face over the whole length of the text.
Most font features can be modified all except the text background which is transparent. There is a feature to highlight part of the string by having a different background colour but this is used for highlighting selected text in GTextField and GTextArea components.
It is also used for all controls that use text.

Author:

Peter Lager

See Also:
Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`StyledString.TextLayoutHitInfo` For multi-line text, the TextHitInfo class is not enough.
`static class`	`StyledString.TextLayoutInfo` Class to hold information about a text layout.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL_METHOD`
`static int`	`CLIP_RUN`
`static int`	`COMBI_MODES`
`static java.lang.String`	`DEFAULT_SLIDER_STYLE`
`static int`	`DRAG_CONTROL`
`static int`	`DRAW_METHOD`
`static int`	`EXCP_IN_HANDLER`
`static int[][]`	`grid`
`static int`	`GROUP_CONTROL_METHOD`
`static int`	`I_CL`
`static int`	`I_COVERED`
`static int`	`I_CR`
`static int`	`I_INSIDE`
`static int`	`I_MODES`
`static int`	`I_NONE`
`static int`	`I_TL`
`static int`	`I_TR`
`static int`	`INVALID_PAPPLET`
`static int`	`INVALID_TYPE`
`static int`	`KEY_METHOD`
`static int`	`MERGE_RUNS`
`static int`	`MISSING`
`static int`	`MOUSE_METHOD`
`static int`	`NONEXISTANT`
`static int`	`OFF_CONTROL`
`static int`	`OVER_CONTROL`
`static java.awt.BasicStroke`	`pen_1_0`
`static java.awt.BasicStroke`	`pen_2_0`
`static java.awt.BasicStroke`	`pen_3_0`
`static java.awt.BasicStroke`	`pen_4_0`
`static int`	`POST_METHOD`
`static int`	`PRE_METHOD`
`static int`	`PRESS_CONTROL`
`static int`	`SCROLLBAR_HORIZONTAL`
`static int`	`SCROLLBAR_VERTICAL`
`static java.lang.String`	`SLIDER_STYLES`
`static int`	`TINT_FOR_ALPHA`
`static int`	`TPAD2`
`static int`	`TPAD4`
`static int`	`TPAD6`
`static int`	`TPAD8`
`static float`	`WHEEL_DELTA`
`static float`	`WHEEL_STICK_FACTOR`
`static int`	`Z_PANEL`
`static int`	`Z_SLIPPY`
`static int`	`Z_SLIPPY_EXPANDS`
`static int`	`Z_STICKY`

Constructor Summary

Constructors
Constructor and Description
`StyledString(java.lang.String startText)` This is assumed to be a single line of text (i.e.
`StyledString(java.lang.String startText, int wrapWidth)` Supports multiple lines of text wrapped on word boundaries.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAttribute(java.text.AttributedCharacterIterator.Attribute type, java.lang.Object value)` Add an attribute that affects the whole length of the string.
`void`	`addAttribute(java.text.AttributedCharacterIterator.Attribute type, java.lang.Object value, int lineNo)` Add a text attribute (style) to an entire display line
`void`	`addAttribute(java.text.AttributedCharacterIterator.Attribute type, java.lang.Object value, int beginIdx, int endIdx)` Set the attribute to be applied to a range of characters starting at beginIdx and ending with endIdx-1.
`void`	`addAttribute(java.text.AttributedCharacterIterator.Attribute type, java.lang.Object value, int lineNo, int charStart, int charEnd)` Add a text attribute (style) to the specifies range of characters
`void`	`clearAttributes()` Removes all styling from the string.
`void`	`clearAttributes(int lineNo)`
`void`	`clearAttributes(int beginIdx, int endIdx)` Remove text attributes (style) to the specified range of characters.
`void`	`clearAttributes(int lineNo, int beginIdx, int endIdx)` Remove text attributes (style) to the specified line and range of characters.
`boolean`	`deleteCharacters(int fromPos, int nbrToRemove)` Remove a number of characters from the string
`java.util.LinkedList<StyledString.TextLayoutInfo>`	`getLines(java.awt.Graphics2D g2d)` Get the text layouts for display if the string has changed since last call to this method regenerate them.
`float`	`getMaxLineHeight()` Get the height of the tallest line
`float`	`getMaxLineLength()` Return the length of the longest line.
`int`	`getNbrLines()` Get the number of lines in the layout
`java.lang.String`	`getPlainText()` Get the plain text as a String.
`java.lang.String`	`getPlainText(int lineNo)` Get a line of text from the plain text.
`java.lang.String`	`getPlainText(int beginIdx, int endIdx)` Get the plain text as a String.
`java.lang.String[]`	`getPlainTextAsArray()` Get the plain text as a String array.
`float`	`getTextAreaHeight()` Return the height of the text line(s)
`int`	`getWrapWidth()` Get the break width used to create the lines.
`int`	`insertCharacters(java.lang.String chars, int insertPos)` Insert 1 or more characters into the string.
`int`	`insertCharacters(java.lang.String chars, int insertPos, boolean startNewLine, boolean endNewLine)` Insert 1 or more characters into the string.
`int`	`insertCharacters(java.lang.String chars, int lineNo, int charStart, boolean startNewLine, boolean endNewLine)` Insert some text into the position indicated.
`boolean`	`insertEOL(int insertPos)` Use this method to insert an EOL character.
`void`	`invalidateText()`
`int`	`length()` Get the number of characters in this styled string
`static StyledString`	`load(processing.core.PApplet papp, java.lang.String fname)` Load and return a StyledString object from the given file.
`static void`	`save(processing.core.PApplet papp, StyledString ss, java.lang.String fname)` Save the named StyleString in the named file.
`void`	`setJustify(boolean justify)` Text can be either left or fully justified.
`void`	`setJustifyRatio(float jRatio)` Justify only if the line has sufficient text to do so.
`void`	`setText(java.lang.String text)` Change the text for single line styled string
`void`	`setText(java.lang.String text, int wrapWidth)` Change the text for single line styled string
`void`	`setWrapWidth(int wrapWidth)` Set the maximum width of a line.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SLIDER_STYLES
```
public static final java.lang.String SLIDER_STYLES
```
    See Also:
    Constant Field Values
  - DEFAULT_SLIDER_STYLE
```
public static final java.lang.String DEFAULT_SLIDER_STYLE
```
    See Also:
    Constant Field Values
  - DRAW_METHOD
```
public static final int DRAW_METHOD
```
    See Also:
    Constant Field Values
  - MOUSE_METHOD
```
public static final int MOUSE_METHOD
```
    See Also:
    Constant Field Values
  - PRE_METHOD
```
public static final int PRE_METHOD
```
    See Also:
    Constant Field Values
  - KEY_METHOD
```
public static final int KEY_METHOD
```
    See Also:
    Constant Field Values
  - POST_METHOD
```
public static final int POST_METHOD
```
    See Also:
    Constant Field Values
  - ALL_METHOD
```
public static final int ALL_METHOD
```
    See Also:
    Constant Field Values
  - GROUP_CONTROL_METHOD
```
public static final int GROUP_CONTROL_METHOD
```
    See Also:
    Constant Field Values
  - MISSING
```
public static final int MISSING
```
    See Also:
    Constant Field Values
  - NONEXISTANT
```
public static final int NONEXISTANT
```
    See Also:
    Constant Field Values
  - INVALID_TYPE
```
public static final int INVALID_TYPE
```
    See Also:
    Constant Field Values
  - INVALID_PAPPLET
```
public static final int INVALID_PAPPLET
```
    See Also:
    Constant Field Values
  - EXCP_IN_HANDLER
```
public static final int EXCP_IN_HANDLER
```
    See Also:
    Constant Field Values
  - OFF_CONTROL
```
public static final int OFF_CONTROL
```
    See Also:
    Constant Field Values
  - OVER_CONTROL
```
public static final int OVER_CONTROL
```
    See Also:
    Constant Field Values
  - PRESS_CONTROL
```
public static final int PRESS_CONTROL
```
    See Also:
    Constant Field Values
  - DRAG_CONTROL
```
public static final int DRAG_CONTROL
```
    See Also:
    Constant Field Values
  - TINT_FOR_ALPHA
```
public static final int TINT_FOR_ALPHA
```
    See Also:
    Constant Field Values
  - I_NONE
```
public static final int I_NONE
```
    See Also:
    Constant Field Values
  - I_TL
```
public static final int I_TL
```
    See Also:
    Constant Field Values
  - I_TR
```
public static final int I_TR
```
    See Also:
    Constant Field Values
  - I_CL
```
public static final int I_CL
```
    See Also:
    Constant Field Values
  - I_CR
```
public static final int I_CR
```
    See Also:
    Constant Field Values
  - I_INSIDE
```
public static final int I_INSIDE
```
    See Also:
    Constant Field Values
  - I_COVERED
```
public static final int I_COVERED
```
    See Also:
    Constant Field Values
  - I_MODES
```
public static final int I_MODES
```
    See Also:
    Constant Field Values
  - MERGE_RUNS
```
public static final int MERGE_RUNS
```
    See Also:
    Constant Field Values
  - CLIP_RUN
```
public static final int CLIP_RUN
```
    See Also:
    Constant Field Values
  - COMBI_MODES
```
public static final int COMBI_MODES
```
    See Also:
    Constant Field Values
  - grid
```
public static final int[][] grid
```
  - pen_1_0
```
public static final java.awt.BasicStroke pen_1_0
```
  - pen_2_0
```
public static final java.awt.BasicStroke pen_2_0
```
  - pen_3_0
```
public static final java.awt.BasicStroke pen_3_0
```
  - pen_4_0
```
public static final java.awt.BasicStroke pen_4_0
```
  - TPAD2
```
public static final int TPAD2
```
    See Also:
    Constant Field Values
  - TPAD4
```
public static final int TPAD4
```
    See Also:
    Constant Field Values
  - TPAD6
```
public static final int TPAD6
```
    See Also:
    Constant Field Values
  - TPAD8
```
public static final int TPAD8
```
    See Also:
    Constant Field Values
  - SCROLLBAR_VERTICAL
```
public static final int SCROLLBAR_VERTICAL
```
    See Also:
    Constant Field Values
  - SCROLLBAR_HORIZONTAL
```
public static final int SCROLLBAR_HORIZONTAL
```
    See Also:
    Constant Field Values
  - WHEEL_DELTA
```
public static final float WHEEL_DELTA
```
    See Also:
    Constant Field Values
  - WHEEL_STICK_FACTOR
```
public static final float WHEEL_STICK_FACTOR
```
    See Also:
    Constant Field Values
  - Z_STICKY
```
public static final int Z_STICKY
```
    See Also:
    Constant Field Values
  - Z_SLIPPY
```
public static final int Z_SLIPPY
```
    See Also:
    Constant Field Values
  - Z_SLIPPY_EXPANDS
```
public static final int Z_SLIPPY_EXPANDS
```
    See Also:
    Constant Field Values
  - Z_PANEL
```
public static final int Z_PANEL
```
    See Also:
    Constant Field Values
- Constructor Detail
  - StyledString
```
public StyledString(java.lang.String startText)
```
    This is assumed to be a single line of text (i.e. no wrap). EOL characters will be stripped from the text before use.
    
    Parameters:
    startText -
  - StyledString
```
public StyledString(java.lang.String startText,
            int wrapWidth)
```
    Supports multiple lines of text wrapped on word boundaries.
    
    Parameters:
    startText - the text to use
    wrapWidth - the wrap width
- Method Detail
  - setText
```
public void setText(java.lang.String text)
```
    Change the text for single line styled string
    
    Parameters:
    text - the text to use
  - setText
```
public void setText(java.lang.String text,
           int wrapWidth)
```
    Change the text for single line styled string
    
    Parameters:
    text - the text to use
    wrapWidth - the wrap width
  - getPlainText
```
public java.lang.String getPlainText()
```
    Get the plain text as a String. Any line breaks will kept and will be represented by the character 'backslash n'
    
    Returns:
    the associated plain text
  - getPlainText
```
public java.lang.String getPlainText(int beginIdx,
                            int endIdx)
```
    Get the plain text as a String. Any line breaks will kept and will be represented by the character 'backslash n'
    
    Parameters:
    beginIdx - the beginning index inclusive
    endIdx - the ending index exclusive
    
    Returns:
    the substring starting at beginIdx to endIdx-1
  - getPlainText
```
public java.lang.String getPlainText(int lineNo)
```
    Get a line of text from the plain text. Lines are separated by End-of-line (EOL) characters.
    
    Parameters:
    lineNo - the line number we want the text for
    
    Returns:
    the line of text or an empty string if the line number is invalid.
  - getPlainTextAsArray
```
public java.lang.String[] getPlainTextAsArray()
```
    Get the plain text as a String array. (splitting on line breaks)
    
    Returns:
    the associated plain text as a String array split on line breaks
  - length
```
public int length()
```
    Get the number of characters in this styled string
  - setJustify
```
public void setJustify(boolean justify)
```
    Text can be either left or fully justified.
    
    Parameters:
    justify - true for full justification
  - setJustifyRatio
```
public void setJustifyRatio(float jRatio)
```
    Justify only if the line has sufficient text to do so.
    
    Parameters:
    jRatio - ratio of text length to visibleWidth
  - addAttribute
```
public void addAttribute(java.text.AttributedCharacterIterator.Attribute type,
                java.lang.Object value)
```
    Add an attribute that affects the whole length of the string.
    
    Parameters:
    type - attribute type
    value - attribute value
  - addAttribute
```
public void addAttribute(java.text.AttributedCharacterIterator.Attribute type,
                java.lang.Object value,
                int lineNo,
                int charStart,
                int charEnd)
```
    Add a text attribute (style) to the specifies range of characters
    
    Parameters:
    type - attribute type
    value - attribute value
    lineNo - the line of test affected
    charStart - the first character affected
    charEnd - the character position after the last character affected.
  - addAttribute
```
public void addAttribute(java.text.AttributedCharacterIterator.Attribute type,
                java.lang.Object value,
                int lineNo)
```
    Add a text attribute (style) to an entire display line
    
    Parameters:
    type - attribute type
    value - attribute value
    lineNo - the line of test affected
  - addAttribute
```
public void addAttribute(java.text.AttributedCharacterIterator.Attribute type,
                java.lang.Object value,
                int beginIdx,
                int endIdx)
```
    Set the attribute to be applied to a range of characters starting at beginIdx and ending with endIdx-1.
    
    Parameters:
    type - attribute type
    value - attribute value
    beginIdx - the index of the first character (inclusive)
    endIdx - the index of the last character (exclusive)
  - clearAttributes
```
public void clearAttributes(int lineNo,
                   int beginIdx,
                   int endIdx)
```
    Remove text attributes (style) to the specified line and range of characters.
    
    Parameters:
    lineNo - the line of test affected
    beginIdx - the index of the first character (inclusive)
    endIdx - the index of the last character (exclusive)
  - clearAttributes
```
public void clearAttributes(int lineNo)
```
    Parameters:
    lineNo -
  - clearAttributes
```
public void clearAttributes(int beginIdx,
                   int endIdx)
```
    Remove text attributes (style) to the specified range of characters.
    
    Parameters:
    beginIdx - the index of the first character (inclusive)
    endIdx - the index of the last character (exclusive)
  - clearAttributes
```
public void clearAttributes()
```
    Removes all styling from the string.
  - insertCharacters
```
public int insertCharacters(java.lang.String chars,
                   int lineNo,
                   int charStart,
                   boolean startNewLine,
                   boolean endNewLine)
```
    Insert some text into the position indicated.
    
    Parameters:
    lineNo - a valid line number
    charStart - the position in the line >= 0
    chars - the characters to insert
    startNewLine - prefix the chars with a EOL
    endNewLine - postfix the chars with a EOL
    
    Returns:
    the number of characters inserted
  - insertCharacters
```
public int insertCharacters(java.lang.String chars,
                   int insertPos)
```
    Insert 1 or more characters into the string. The inserted text will first be made safe by removing any inappropriate EOL characters.
    Do not use this method to insert EOL characters, use the
```
insertEOL(int)
```
    method instead.
    Parameters:
    insertPos - position in string to insert characters
    chars - the characters to insert
    
    Returns:
    the number of characters inserted
  - insertCharacters
```
public int insertCharacters(java.lang.String chars,
                   int insertPos,
                   boolean startNewLine,
                   boolean endNewLine)
```
    Insert 1 or more characters into the string. The inserted text will first be made safe by removing any inappropriate EOL characters.
    Do not use this method to insert EOL characters, use the
```
insertEOL(int)
```
    method instead.
    Parameters:
    insertPos - position in string to insert characters
    chars - the characters to insert
    startNewLine - if true insert onto a new line
    
    Returns:
    the number of characters inserted
  - insertEOL
```
public boolean insertEOL(int insertPos)
```
    Use this method to insert an EOL character.
    
    Parameters:
    insertPos - index position to insert EOL
    
    Returns:
    true if an EOL was inserted into the string
  - deleteCharacters
```
public boolean deleteCharacters(int fromPos,
                       int nbrToRemove)
```
    Remove a number of characters from the string
    
    Parameters:
    nbrToRemove - number of characters to remove
    fromPos - start location for removal
    
    Returns:
    true if the deletion was successful else false
  - invalidateText
```
public void invalidateText()
```
  - getLines
```
public java.util.LinkedList<StyledString.TextLayoutInfo> getLines(java.awt.Graphics2D g2d)
```
    Get the text layouts for display if the string has changed since last call to this method regenerate them.
    
    Parameters:
    g2d - Graphics2D display context
    
    Returns:
    a list of text layouts for rendering
  - getNbrLines
```
public int getNbrLines()
```
    Get the number of lines in the layout
  - getTextAreaHeight
```
public float getTextAreaHeight()
```
    Return the height of the text line(s)
  - getMaxLineLength
```
public float getMaxLineLength()
```
    Return the length of the longest line.
  - getMaxLineHeight
```
public float getMaxLineHeight()
```
    Get the height of the tallest line
  - getWrapWidth
```
public int getWrapWidth()
```
    Get the break width used to create the lines.
  - setWrapWidth
```
public void setWrapWidth(int wrapWidth)
```
    Set the maximum width of a line.
    
    Parameters:
    wrapWidth -
  - save
```
public static void save(processing.core.PApplet papp,
        StyledString ss,
        java.lang.String fname)
```
    Save the named StyleString in the named file.
    
    Parameters:
    papp -
    ss - the styled string
    fname -
  - load
```
public static StyledString load(processing.core.PApplet papp,
                java.lang.String fname)
```
    Load and return a StyledString object from the given file.
    
    Parameters:
    papp -
    fname - the filename of the StyledString

Class StyledString

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SLIDER_STYLES

DEFAULT_SLIDER_STYLE

DRAW_METHOD

MOUSE_METHOD

PRE_METHOD

KEY_METHOD

POST_METHOD

ALL_METHOD

GROUP_CONTROL_METHOD

MISSING

NONEXISTANT

INVALID_TYPE

INVALID_PAPPLET

EXCP_IN_HANDLER

OFF_CONTROL

OVER_CONTROL

PRESS_CONTROL

DRAG_CONTROL

TINT_FOR_ALPHA

I_NONE

I_TL

I_TR

I_CL

I_CR

I_INSIDE

I_COVERED

I_MODES

MERGE_RUNS

CLIP_RUN

COMBI_MODES

grid

pen_1_0

pen_2_0

pen_3_0

pen_4_0

TPAD2

TPAD4

TPAD6

TPAD8

SCROLLBAR_VERTICAL

SCROLLBAR_HORIZONTAL

WHEEL_DELTA

WHEEL_STICK_FACTOR

Z_STICKY

Z_SLIPPY

Z_SLIPPY_EXPANDS

Z_PANEL

Constructor Detail

StyledString

StyledString

Method Detail

setText

setText

getPlainText

getPlainText

getPlainText

getPlainTextAsArray

length

setJustify

setJustifyRatio

addAttribute

addAttribute

addAttribute

addAttribute

clearAttributes

clearAttributes

clearAttributes

clearAttributes

insertCharacters

insertCharacters

insertCharacters

insertEOL

deleteCharacters