net.ranides.assira.text.format
Class AnsiString

java.lang.Object
  net.ranides.assira.text.format.AnsiString

All Implemented Interfaces:

Serializable, CharSequence, AnsiAttr, AnsiCharSequence

Direct Known Subclasses:

AnsiStringBuilder

public class AnsiString
extends Object
implements AnsiCharSequence, Serializable

Author:

ranides

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface net.ranides.assira.text.format.AnsiAttr

AnsiAttr.IndirectAt

Field Summary

Fields inherited from interface net.ranides.assira.text.format.AnsiAttr

bold, BOLD, changed, CHANGED, fresh, FRESH, invert, INVERT, MASK_INTERNAL, MASK_PUBLIC, narrow, NARROW, normal, NORMAL, SPLIT_ALL, SPLIT_BACK, SPLIT_FLAGS, SPLIT_FLAGS_ALL, SPLIT_FONT, SPLIT_FORE, strike, STRIKE, symbol, SYMBOL, underline, UNDERLINE

Constructor Summary

AnsiString(AnsiCharSequence sequence)

AnsiString(AnsiCharSequence source, int begin, int end)

AnsiString(AnsiColorScheme scheme, char[] text)

AnsiString(AnsiColorScheme scheme, int size, char c)

AnsiString(AnsiColorScheme scheme, String text)

AnsiString(String text)

Method Summary

void	addFlags(int from, int to, int flags)
void	addFlagsAt(int index, int flags)
char	charAt(int index)
boolean	equals(Object obj)
AnsiAttr	getAttr() Zwraca wszystkie domyślne właściwości przypisane do ciągu tekstowego (kolor, tło, czcionka, styl).
AnsiAttr	getAttrAt(int index) Zwraca wszystkie właściwości przypisane do znaku o podanym indeksie (kolor, tło, czcionka, styl).
int	getBack() Zwraca przypisany numer koloru tła.
int	getBackAt(int index) Zwraca numer koloru tła przypisany do znaku o podanym indeksie.
char	getCharAt(int index) Odczytuje z sekwencji znak o podanym indeksie.
Color	getComputedBack() Metoda opcjonalna: zwraca przypisany kolor tła.
Color	getComputedBackAt(int index) Metoda opcjonalna: zwraca kolor tła przypisany do znaku o podanym indeksie.
Font	getComputedFont() Metoda opcjonalna: zwraca przypisaną czcionkę.
Font	getComputedFontAt(int index) Metoda opcjonalna: zwraca numer czcionki przypisany do znaku o podanym indeksie.
Color	getComputedFore() Metoda opcjonalna: zwraca przypisany kolor tekstu.
Color	getComputedForeAt(int index) Metoda opcjonalna: zwraca kolor tekstu przypisany do znaku o podanym indeksie.
int	getFlags() Zwraca przypisane atrybuty tekstu.
int	getFlagsAt(int index) Zwraca atrybuty przypisane do znaku o podanym indeksie.
int	getFont() Zwraca przypisany numer czcionki.
int	getFontAt(int index) Zwraca numer czcionki przypisany do znaku o podanym indeksie.
AnsiFontScheme	getFonts() Zwraca schemat czcionek skojarzony z sekwencją znaków.
int	getFore() Zwraca przypisany numer koloru tekstu.
int	getForeAt(int index) Zwraca numer koloru tekstu przypisany do znaku o podanym indeksie.
AnsiColorScheme	getScheme() Zwraca schemat kolorów skojarzony z sekwencją znaków.
int	hashCode()
int	length()
void	remFlags(int from, int to, int flags)
void	remFlagsAt(int index, int flags)
AnsiString	setAttr(int from, int to, int attr)
AnsiString	setBack(int from, int to, int attr)
AnsiString	setBackAt(int index, int attr)
void	setCharAt(int index, char value)
void	setFlags(int from, int to, int flags)
void	setFlagsAt(int index, int flags)
void	setFont(int from, int to, int font)
void	setFontAt(int index, int font)
AnsiString	setFonts(AnsiFontScheme fonts)
AnsiString	setFore(int from, int to, int attr)
AnsiString	setForeAt(int index, int attr)
AnsiString	setScheme(AnsiColorScheme scheme)
Iterable<AnsiCharSequence>	split(int options) Rozbija tekst na fragmenty zawierające znaki zgrupowane według kryteriów podanych w opcjach.
AnsiCharSequence	subAnsiSequence(int begin, int end) Returns a new AnsiCharSequence that is a subsequence of this sequence.
CharSequence	subSequence(int start, int end)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AnsiString

public AnsiString(AnsiCharSequence sequence)

AnsiString

public AnsiString(String text)

AnsiString

public AnsiString(AnsiColorScheme scheme,
                  String text)

AnsiString

public AnsiString(AnsiColorScheme scheme,
                  char[] text)

AnsiString

public AnsiString(AnsiColorScheme scheme,
                  int size,
                  char c)

AnsiString

public AnsiString(AnsiCharSequence source,
                  int begin,
                  int end)

Method Detail

getComputedFore

public Color getComputedFore()

Description copied from interface: AnsiAttr

Metoda opcjonalna: zwraca przypisany kolor tekstu. Ogólnie metoda zwraca rozsądny wynik, jeśli obiekt został powiązany z odpowiednim schematem kolorów (AnsiColorScheme.

Specified by:

getComputedFore in interface AnsiAttr

Returns:

getComputedForeAt

public Color getComputedForeAt(int index)

Description copied from interface: AnsiCharSequence

Metoda opcjonalna: zwraca kolor tekstu przypisany do znaku o podanym indeksie. Ogólnie metoda zwraca rozsądny wynik, jeśli obiekt został powiązany z odpowiednim schematem kolorów (AnsiColorScheme.

Specified by:

getComputedForeAt in interface AnsiCharSequence

Returns:

getComputedBack

public Color getComputedBack()

Description copied from interface: AnsiAttr

Metoda opcjonalna: zwraca przypisany kolor tła. Ogólnie metoda zwraca rozsądny wynik, jeśli obiekt został powiązany z odpowiednim schematem kolorów (AnsiColorScheme.

Specified by:

getComputedBack in interface AnsiAttr

Returns:

getComputedBackAt

public Color getComputedBackAt(int index)

Description copied from interface: AnsiCharSequence

Metoda opcjonalna: zwraca kolor tła przypisany do znaku o podanym indeksie. Ogólnie metoda zwraca rozsądny wynik, jeśli obiekt został powiązany z odpowiednim schematem kolorów (AnsiColorScheme.

Specified by:

getComputedBackAt in interface AnsiCharSequence

Returns:

getFore

public int getFore()

Description copied from interface: AnsiAttr

Zwraca przypisany numer koloru tekstu. Numer może być zamieniony na graficzną reprezentację za pomocą AnsiColorScheme.

Specified by:

getFore in interface AnsiAttr

Returns:

See Also:

AnsiAttr.getComputedFore()

getForeAt

public int getForeAt(int index)

Description copied from interface: AnsiCharSequence

Zwraca numer koloru tekstu przypisany do znaku o podanym indeksie. Numer może być zamieniony na graficzną reprezentację za pomocą AnsiColorScheme.

Specified by:

getForeAt in interface AnsiCharSequence

Returns:

See Also:

AnsiCharSequence.getComputedForeAt(int)

getBack

public int getBack()

Description copied from interface: AnsiAttr

Zwraca przypisany numer koloru tła. Numer może być zamieniony na graficzną reprezentację za pomocą AnsiColorScheme.

Specified by:

getBack in interface AnsiAttr

Returns:

See Also:

AnsiAttr.getComputedBack()

getBackAt

public int getBackAt(int index)

Description copied from interface: AnsiCharSequence

Zwraca numer koloru tła przypisany do znaku o podanym indeksie. Numer może być zamieniony na graficzną reprezentację za pomocą AnsiColorScheme.

Specified by:

getBackAt in interface AnsiCharSequence

Returns:

See Also:

AnsiCharSequence.getComputedBackAt(int)

getFlagsAt

public int getFlagsAt(int index)

Description copied from interface: AnsiCharSequence

Zwraca atrybuty przypisane do znaku o podanym indeksie.

Specified by:

getFlagsAt in interface AnsiCharSequence

Returns:

getFlags

public int getFlags()

Description copied from interface: AnsiAttr

Zwraca przypisane atrybuty tekstu.

Specified by:

getFlags in interface AnsiAttr

Returns:

getComputedFont

public Font getComputedFont()

Description copied from interface: AnsiAttr

Metoda opcjonalna: zwraca przypisaną czcionkę. Ogólnie metoda zwraca rozsądny wynik, jeśli obiekt został powiązany z odpowiednim schematem czcionek (AnsiFontScheme.

Specified by:

getComputedFont in interface AnsiAttr

Returns:

getComputedFontAt

public Font getComputedFontAt(int index)

Description copied from interface: AnsiCharSequence

Metoda opcjonalna: zwraca numer czcionki przypisany do znaku o podanym indeksie. Ogólnie metoda zwraca rozsądny wynik, jeśli obiekt został powiązany z odpowiednim schematem czcionek (AnsiFontScheme.

Specified by:

getComputedFontAt in interface AnsiCharSequence

Returns:

getFont

public int getFont()

Description copied from interface: AnsiAttr

Zwraca przypisany numer czcionki. Numer może być zamieniony na graficzną reprezentację za pomocą AnsiFontScheme.

Specified by:

getFont in interface AnsiAttr

Returns:

See Also:

AnsiAttr.getComputedFont()

getFontAt

public int getFontAt(int index)

Description copied from interface: AnsiCharSequence

Zwraca numer czcionki przypisany do znaku o podanym indeksie. Numer może być zamieniony na graficzną reprezentację za pomocą AnsiFontScheme.

Specified by:

getFontAt in interface AnsiCharSequence

Returns:

See Also:

AnsiCharSequence.getComputedFontAt(int)

getAttr

public AnsiAttr getAttr()

Description copied from interface: AnsiCharSequence

Zwraca wszystkie domyślne właściwości przypisane do ciągu tekstowego (kolor, tło, czcionka, styl).

Specified by:

getAttr in interface AnsiCharSequence

Returns:

getAttrAt

public AnsiAttr getAttrAt(int index)

Description copied from interface: AnsiCharSequence

Zwraca wszystkie właściwości przypisane do znaku o podanym indeksie (kolor, tło, czcionka, styl).

Specified by:

getAttrAt in interface AnsiCharSequence

Returns:

setFonts

public AnsiString setFonts(AnsiFontScheme fonts)

getFonts

public AnsiFontScheme getFonts()

Description copied from interface: AnsiCharSequence

Zwraca schemat czcionek skojarzony z sekwencją znaków. Schemat powiązany z sekwencją odpowiada za prawidłowe działanie metod AnsiAttr.getComputedFont() oraz AnsiCharSequence.getComputedFontAt(int)

Specified by:

getFonts in interface AnsiCharSequence

Returns:

length

public int length()

Specified by:

length in interface CharSequence

charAt

public char charAt(int index)

Specified by:

charAt in interface CharSequence

getCharAt

public char getCharAt(int index)

Description copied from interface: AnsiCharSequence

Odczytuje z sekwencji znak o podanym indeksie. Zwraca wynik identyczny jak CharSequence.charAt(int). Metoda istniejąca w celu uzyskania pełnej kompatybilności sekwencji znaków z konwencją JavaBeans.

Specified by:

getCharAt in interface AnsiCharSequence

Returns:

setCharAt

public void setCharAt(int index,
                      char value)

subSequence

public CharSequence subSequence(int start,
                                int end)

Specified by:

subSequence in interface CharSequence

split

public Iterable<AnsiCharSequence> split(int options)

Description copied from interface: AnsiCharSequence

Rozbija tekst na fragmenty zawierające znaki zgrupowane według kryteriów podanych w opcjach. Opcje są zbiorem flag z klasy AnsiAttr.

Rozdziela tekst na fragmenty o jednym kolorze tekstu i tła:
text.split(AnsiAttr.SPLIT_FORE | AnsiAttr.SPLIT_BACK)

Rozdziela tekst na fragmenty o tym samym stylu pogrubienia:
text.split(AnsiAttr.SPLIT_FLAGS | AnsiAttr.BOLD)

Specified by:

split in interface AnsiCharSequence

Returns:

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

setScheme

public AnsiString setScheme(AnsiColorScheme scheme)

getScheme

public AnsiColorScheme getScheme()

Description copied from interface: AnsiCharSequence

Zwraca schemat kolorów skojarzony z sekwencją znaków. Schemat powiązany z sekwencją odpowiada za prawidłowe działanie metod AnsiAttr.getComputedFore(), AnsiAttr.getComputedBack() oraz pochodnych.

Specified by:

getScheme in interface AnsiCharSequence

Returns:

setBack

public AnsiString setBack(int from,
                          int to,
                          int attr)

setFore

public AnsiString setFore(int from,
                          int to,
                          int attr)

setAttr

public AnsiString setAttr(int from,
                          int to,
                          int attr)

setBackAt

public AnsiString setBackAt(int index,
                            int attr)

setForeAt

public AnsiString setForeAt(int index,
                            int attr)

setFontAt

public void setFontAt(int index,
                      int font)

setFont

public void setFont(int from,
                    int to,
                    int font)

setFlagsAt

public void setFlagsAt(int index,
                       int flags)

setFlags

public void setFlags(int from,
                     int to,
                     int flags)

addFlagsAt

public void addFlagsAt(int index,
                       int flags)

addFlags

public void addFlags(int from,
                     int to,
                     int flags)

remFlagsAt

public void remFlagsAt(int index,
                       int flags)

remFlags

public void remFlags(int from,
                     int to,
                     int flags)

subAnsiSequence

public AnsiCharSequence subAnsiSequence(int begin,
                                        int end)

Description copied from interface: AnsiCharSequence

Returns a new AnsiCharSequence that is a subsequence of this sequence. The subsequence starts with the char value at the specified index and ends with the char value at index end - 1. The length (in chars) of the returned sequence is end - start, so if start == end then an empty sequence is returned.

Specified by:

subAnsiSequence in interface AnsiCharSequence

Parameters:

begin - the start index, inclusive

end - the end index, exclusive

Returns:

the specified subsequence