IColoredString (squidlib-util 3.0.6 API)

Type Parameters:

T - The type of colors;

All Superinterfaces:

java.lang.Iterable<IColoredString.Bucket<T>>

All Known Implementing Classes:

IColoredString.Impl
```
public interface IColoredString<T>
extends java.lang.Iterable<IColoredString.Bucket<T>>
```
A String divided in chunks of different colors. Use the Iterable interface to get the pieces.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IColoredString.Bucket<T>` A piece of a `IColoredString`: a text and its color.
`static class`	`IColoredString.Impl<T>` A basic implementation of `IColoredString`.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`append(char c)` A convenience alias for `append(c, null)`.
`void`	`append(char c, T color)` Mutates `this` by appending `c` to it.
`void`	`append(IColoredString<T> other)` Mutates `this` by appending `other` to it.
`void`	`append(java.lang.String text)` A convenience alias for `append(text, null)`.
`void`	`append(java.lang.String text, T color)` Mutates `this` by appending `text` to it.
`void`	`appendFloat(float f, T color)` Mutates `this` by appending `f` to it.
`void`	`appendInt(int i, T color)` Mutates `this` by appending `i` to it.
`char`	`charAt(int index)`
`void`	`clear()` Empties `this`.
`T`	`colorAt(int index)`
`java.util.ArrayList<IColoredString.Bucket<T>>`	`getFragments()` Gets the Buckets as an ArrayList, allowing access by index instead of by `Iterable.iterator()`.
`boolean`	`isEmpty()`
`IColoredString<T>`	`justify(int width)` This method does NOT guarantee that the result's length is `width`.
`T`	`lastColor()` This method is typically more efficient than `colorAt(int)`.
`int`	`length()`
`java.lang.String`	`present()`
`java.lang.String`	`presentWithMarkup(IMarkup<T> markup)` Given some way of converting from a T value to an in-line markup tag, returns a string representation of this IColoredString with in-line markup representing colors.
`void`	`replaceColor(T old, T new_)` Replace color `old` by `new_` in all buckets of `this`.
`void`	`setColor(T color)` Set `color` in all buckets.
`void`	`setLength(int len)` Deletes all content after index `len` (if any).
`java.util.List<IColoredString<T>>`	`wrap(int width)`
`java.util.List<IColoredString<T>>`	`wrap(int width, java.util.List<IColoredString<T>> buf)`

Methods inherited from interface java.lang.Iterable
forEach, iterator, spliterator

- Method Detail
  - append
```
void append(char c)
```
    A convenience alias for append(c, null).
    
    Parameters:
    
    c - the char to append
  - append
```
void append(char c,
            T color)
```
    Mutates this by appending c to it.
    
    Parameters:
    
    c - The text to append.
    
    color - text's color. Or null to let the panel decide.
  - append
```
void append(java.lang.String text)
```
    A convenience alias for append(text, null).
    
    Parameters:
    
    text -
  - append
```
void append(java.lang.String text,
            T color)
```
    Mutates this by appending text to it. Does nothing if text is null.
    
    Parameters:
    
    text - The text to append.
    
    color - text's color. Or null to let the panel decide.
  - appendInt
```
void appendInt(int i,
               T color)
```
    Mutates this by appending i to it.
    
    Parameters:
    
    i - The int to append.
    
    color - text's color. Or null to let the panel decide.
  - appendFloat
```
void appendFloat(float f,
                 T color)
```
    Mutates this by appending f to it.
    
    Parameters:
    
    f - The float to append.
    
    color - text's color. Or null to let the panel decide.
  - append
```
void append(IColoredString<T> other)
```
    Mutates this by appending other to it.
    
    Parameters:
    
    other -
  - replaceColor
```
void replaceColor(T old,
                  T new_)
```
    Replace color old by new_ in all buckets of this.
    
    Parameters:
    
    old - The color to replace.
    
    new_ - The replacing color.
  - setColor
```
void setColor(T color)
```
    Set color in all buckets.
    
    Parameters:
    
    color -
  - setLength
```
void setLength(int len)
```
    Deletes all content after index len (if any).
    
    Parameters:
    
    len -
  - isEmpty
```
boolean isEmpty()
```
    Returns:
    
    true if present() is "".
  - wrap
```
java.util.List<IColoredString<T>> wrap(int width)
```
    Parameters:
    
    width - A positive integer
    
    Returns:
    
    this split in pieces that would fit in a display with width columns (if all words in this are smaller or equal in length to width, otherwise wrapping will fail for these words).
  - wrap
```
java.util.List<IColoredString<T>> wrap(int width,
                                       java.util.List<IColoredString<T>> buf)
```
    Parameters:
    
    width - A positive integer
    
    buf - A List of IColoredString with the same T type as this; will have the wrapped contents appended to it. Cannot be null, and if it has existing contents, they will be left as-is.
    
    Returns:
    
    buf containing this split in pieces that would fit in a display with width columns (if all words in this are smaller or equal in length to width, otherwise wrapping will fail for these words).
  - justify
```
IColoredString<T> justify(int width)
```
    This method does NOT guarantee that the result's length is width. It is impossible to do correct justifying if this's length is greater than width or if this has no space character.
    
    Parameters:
    
    width -
    
    Returns:
    
    A variant of this where spaces have been introduced in-between words, so that this's length is as close as possible to width. Or this itself if unaffected.
  - clear
```
void clear()
```
    Empties this.
  - lastColor
```
T lastColor()
```
    This method is typically more efficient than colorAt(int).
    
    Returns:
    
    The color of the last bucket, if any.
  - colorAt
```
T colorAt(int index)
```
    Parameters:
    
    index -
    
    Returns:
    
    The color at index, if any.
    
    Throws:
    
    java.util.NoSuchElementException - If index equals or is greater to length().
  - charAt
```
char charAt(int index)
```
    Parameters:
    
    index -
    
    Returns:
    
    The character at index, if any.
    
    Throws:
    
    java.util.NoSuchElementException - If index equals or is greater to length().
  - length
```
int length()
```
    Returns:
    
    The length of text.
  - present
```
java.lang.String present()
```
    Returns:
    
    The text that this represents.
  - presentWithMarkup
```
java.lang.String presentWithMarkup(IMarkup<T> markup)
```
    Given some way of converting from a T value to an in-line markup tag, returns a string representation of this IColoredString with in-line markup representing colors.
    
    Parameters:
    
    markup - an IMarkup implementation
    
    Returns:
    
    a String with markup inserted inside.
  - getFragments
```
java.util.ArrayList<IColoredString.Bucket<T>> getFragments()
```
    Gets the Buckets as an ArrayList, allowing access by index instead of by Iterable.iterator().
    
    Returns:
    
    the Buckets that would be returned by Iterable.iterator(), but in an ArrayList.

Interface IColoredString<T>

Nested Class Summary

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

append

append

append

append

appendInt

appendFloat

append

replaceColor

setColor

setLength

isEmpty

wrap

wrap

justify

clear

lastColor

colorAt

charAt

length

present

presentWithMarkup

getFragments