Package squidpony.panel

Class IColoredString.Impl<T>

java.lang.Object

squidpony.panel.IColoredString.Impl<T>

Type Parameters:

T - The type of colors

All Implemented Interfaces:

Iterable<IColoredString.Bucket<T>>, IColoredString<T>

Enclosing interface:

IColoredString<T>

public static class IColoredString.Impl<T>
extends Object
implements IColoredString<T>

A basic implementation of IColoredString.

Author:

smelC

Nested Class Summary

Nested classes/interfaces inherited from interface squidpony.panel.IColoredString

IColoredString.Bucket<T>, IColoredString.Impl<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrayList<IColoredString.Bucket<T>>	fragments

Constructor Summary

Constructors

Constructor	Description
Impl()	An empty instance.
Impl(String text, T color)	An instance initially containing text (with color).

Method Summary

Modifier and Type	Method	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(String text)	A convenience alias for append(text, null).
void	append(String text, T color)	Mutates this by appending text to it.
void	append(IColoredString.Bucket<T> bucket)
void	append(IColoredString<T> other)	Mutates this by appending other 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.
static <T> IColoredString.Impl<T>	clone(IColoredString<T> toClone)
T	colorAt(int index)
static <T> IColoredString.Impl<T>	create()	A static constructor, to avoid having to write <T> in the caller.
static <T> IColoredString.Impl<T>	create(String s)	A convenience method, equivalent to create(s, null).
static <T> IColoredString.Impl<T>	create(String s, T t)	A static constructor, to avoid having to write <T> in the caller.
protected static boolean	equals(Object o1, Object o2)
static <T> boolean	equals(IColoredString<T> one, IColoredString<T> two)
ArrayList<IColoredString.Bucket<T>>	getFragments()	Gets the Buckets as an ArrayList, allowing access by index instead of by iterator().
boolean	isEmpty()
ListIterator<IColoredString.Bucket<T>>	iterator()
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 IColoredString.colorAt(int).
int	length()
String	present()
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).
String	toString()
List<IColoredString<T>>	wrap(int width)
List<IColoredString<T>>	wrap(int width, List<IColoredString<T>> buf)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

fragments

protected final ArrayList<IColoredString.Bucket<T>> fragments

Constructor Details

Impl

public Impl()

An empty instance.

Impl

public Impl(String text, T color)

An instance initially containing text (with color).

Parameters:

text - The text that this should contain.

color - The color of text.

Method Details

create

public static <T> IColoredString.Impl<T> create()

A static constructor, to avoid having to write <T> in the caller.

Returns:

new Impl(s, t).

create

public static <T> IColoredString.Impl<T> create(String s)

A convenience method, equivalent to create(s, null).

Parameters:

s -

Returns:

create(s, null)

create

public static <T> IColoredString.Impl<T> create(String s, T t)

A static constructor, to avoid having to write <T> in the caller.

Returns:

new Impl(s, t).

clone

public static <T> IColoredString.Impl<T> clone(IColoredString<T> toClone)

equals

public static <T> boolean equals(IColoredString<T> one, IColoredString<T> two)

Parameters:

one -

two -

Returns:

Whether one represents the same content as two.

append

public void append(char c)

Description copied from interface: IColoredString

A convenience alias for append(c, null).

Specified by:

append in interface IColoredString<T>

Parameters:

c - the char to append

append

public void append(char c, T color)

Description copied from interface: IColoredString

Mutates this by appending c to it.

Specified by:

append in interface IColoredString<T>

Parameters:

c - The text to append.

color - text's color. Or null to let the panel decide.

append

public void append(String text)

Description copied from interface: IColoredString

A convenience alias for append(text, null).

Specified by:

append in interface IColoredString<T>

append

public void append(String text, T color)

Description copied from interface: IColoredString

Mutates this by appending text to it. Does nothing if text is null.

Specified by:

append in interface IColoredString<T>

Parameters:

text - The text to append.

color - text's color. Or null to let the panel decide.

appendInt

public void appendInt(int i, T color)

Description copied from interface: IColoredString

Mutates this by appending i to it.

Specified by:

appendInt in interface IColoredString<T>

Parameters:

i - The int to append.

color - text's color. Or null to let the panel decide.

appendFloat

public void appendFloat(float f, T color)

Description copied from interface: IColoredString

Mutates this by appending f to it.

Specified by:

appendFloat in interface IColoredString<T>

Parameters:

f - The float to append.

color - text's color. Or null to let the panel decide.

append

public void append(IColoredString<T> other)

Description copied from interface: IColoredString

Mutates this by appending other to it.

Specified by:

append in interface IColoredString<T>

replaceColor

public void replaceColor(T old, T new_)

Description copied from interface: IColoredString

Replace color old by new_ in all buckets of this.

Specified by:

replaceColor in interface IColoredString<T>

Parameters:

old - The color to replace.

new_ - The replacing color.

setColor

public void setColor(T color)

Description copied from interface: IColoredString

Set color in all buckets.

Specified by:

setColor in interface IColoredString<T>

append

public void append(IColoredString.Bucket<T> bucket)

setLength

public void setLength(int len)

Description copied from interface: IColoredString

Deletes all content after index len (if any).

Specified by:

setLength in interface IColoredString<T>

wrap

public List<IColoredString<T>> wrap(int width)

Specified by:

wrap in interface IColoredString<T>

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

public List<IColoredString<T>> wrap(int width, List<IColoredString<T>> buf)

Specified by:

wrap in interface IColoredString<T>

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

public IColoredString<T> justify(int width)

Description copied from interface: IColoredString

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.

Specified by:

justify in interface IColoredString<T>

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

public void clear()

Description copied from interface: IColoredString

Empties this.

Specified by:

clear in interface IColoredString<T>

length

public int length()

Specified by:

length in interface IColoredString<T>

Returns:

The length of text.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IColoredString<T>

Returns:

true if IColoredString.present() is "".

lastColor

public T lastColor()

Description copied from interface: IColoredString

This method is typically more efficient than IColoredString.colorAt(int).

Specified by:

lastColor in interface IColoredString<T>

Returns:

The color of the last bucket, if any.

colorAt

public T colorAt(int index)

Specified by:

colorAt in interface IColoredString<T>

Returns:

The color at index, if any.

charAt

public char charAt(int index)

Specified by:

charAt in interface IColoredString<T>

Returns:

The character at index, if any.

present

public String present()

Specified by:

present in interface IColoredString<T>

Returns:

The text that this represents.

presentWithMarkup

public 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.

Specified by:

presentWithMarkup in interface IColoredString<T>

Parameters:

markup - an IMarkup implementation

Returns:

a String with markup inserted inside.

iterator

public ListIterator<IColoredString.Bucket<T>> iterator()

Specified by:

iterator in interface Iterable<T>

toString

public String toString()

Overrides:

toString in class Object

equals

protected static boolean equals(Object o1, Object o2)

getFragments

public ArrayList<IColoredString.Bucket<T>> getFragments()

Gets the Buckets as an ArrayList, allowing access by index instead of by iterator().

Specified by:

getFragments in interface IColoredString<T>

Returns:

the Buckets that would be returned by iterator(), but in an ArrayList.