BaseAString (gui.swing 0.2.2 API)

java.lang.Object
- xyz.cofe.gui.swing.text.BaseAString

Direct Known Subclasses:

AString
```
public class BaseAString
extends Object
```
Модификация существующего класса java.text.AttributedString

Author:

Kamnev Georgiy (nt.gocha@gmail.com)

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class BaseAString.FoundRunBreak

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`BaseAString.FoundRunBreak`

Constructor Summary

Constructors
Constructor and Description
`BaseAString(AttributedCharacterIterator text)`
`BaseAString(AttributedCharacterIterator[] iterators)`
`BaseAString(AttributedCharacterIterator text, int beginIndex, int endIndex)`
`BaseAString(AttributedCharacterIterator text, int beginIndex, int endIndex, AttributedCharacterIterator.Attribute[] attributes)`
`BaseAString(AttributedString astr)` Конструктор копирования
`BaseAString(BaseAString astr)` Конструктор копирования
`BaseAString(String text)`
`BaseAString(String text, Map<? extends AttributedCharacterIterator.Attribute,?> attributes)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addAttribute(AttributedCharacterIterator.Attribute attribute, Object value)` Adds an attribute to the entire string.
`protected void`	`addAttribute(AttributedCharacterIterator.Attribute attribute, Object value, int beginIndex, int endIndex)` Adds an attribute to a subrange of the string.
`protected void`	`addAttributeImpl(AttributedCharacterIterator.Attribute attribute, Object value, int beginIndex, int endIndex)`
`protected void`	`addAttributeRunData(AttributedCharacterIterator.Attribute attribute, Object value, int beginRunIndex, int endRunIndex)`
`protected void`	`addAttributes(Map<? extends AttributedCharacterIterator.Attribute,?> attributes, int beginIndex, int endIndex)` Adds a set of attributes to a subrange of the string.
`protected void`	`appendContents(StringBuffer buf, CharacterIterator iterator)` Appends the contents of the CharacterIterator iterator into the StringBuffer buf.
`protected boolean`	`attributeValuesMatch(Set attributes, int runIndex1, int runIndex2)`
`char`	`charAt(int index)`
`protected void`	`clearAttributes(int beginIndex, int endIndex)`
`protected void`	`clearAttributesImpl(int beginIndex, int endIndex)`
`protected void`	`clearAttributesRunData(int beginRunIndex, int endRunIndex)`
`BaseAString`	`clone()`
`protected void`	`createRunAttributeDataVectors()`
`protected int`	`ensureRunBreak(int offset)`
`protected int`	`ensureRunBreak(int offset, boolean copyAttrs)` Ensures there is a run break at offset, returning the index of the run.
`protected BaseAString.FoundRunBreak`	`findRunBreak(int offset)`
`protected Object`	`getAttribute(AttributedCharacterIterator.Attribute attribute, int runIndex)`
`protected Object`	`getAttributeCheckRange(AttributedCharacterIterator.Attribute attribute, int runIndex, int beginIndex, int endIndex)`
`AttributedCharacterIterator`	`getIterator()` Creates an AttributedCharacterIterator instance that provides access to the entire contents of this string.
`AttributedCharacterIterator`	`getIterator(AttributedCharacterIterator.Attribute[] attributes)` Creates an AttributedCharacterIterator instance that provides access to selected contents of this string.
`AttributedCharacterIterator`	`getIterator(AttributedCharacterIterator.Attribute[] attributes, int beginIndex, int endIndex)` Creates an AttributedCharacterIterator instance that provides access to selected contents of this string.
`Vector[]`	`getRunAttributes()`
`Vector[]`	`getRunAttributeValues()`
`int`	`getRunCount()`
`int[]`	`getRunStarts()`
`long`	`getScn()`
`int`	`length()`
`static int`	`length(AttributedCharacterIterator astr)`
`protected static boolean`	`mapsDiffer(Map last, Map attrs)` Returns true if the attributes specified in last and attrs differ.
`protected void`	`nextScn()`
`protected void`	`removeAttributeImpl(AttributedCharacterIterator.Attribute attribute, int beginIndex, int endIndex)`
`protected void`	`removeAttributeRunData(AttributedCharacterIterator.Attribute attribute, int beginRunIndex, int endRunIndex)`
`protected void`	`removeAttributes(Set<? extends AttributedCharacterIterator.Attribute> attributes, int beginIndex, int endIndex)`
`protected void`	`setAttributes(Map attrs, int offset)` Sets the attributes for the range from offset to the next run break (typically the end of the text) to the ones specified in attrs.
`String`	`text()`
`static boolean`	`valuesMatch(Object value1, Object value2)`

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

Constructor Detail

BaseAString

public BaseAString(AttributedCharacterIterator[] iterators)

BaseAString
```
public BaseAString(String text)
```

BaseAString

public BaseAString(String text,
                   Map<? extends AttributedCharacterIterator.Attribute,?> attributes)

BaseAString

public BaseAString(AttributedCharacterIterator text)

BaseAString

public BaseAString(AttributedCharacterIterator text,
                   int beginIndex,
                   int endIndex)

BaseAString

public BaseAString(AttributedCharacterIterator text,
                   int beginIndex,
                   int endIndex,
                   AttributedCharacterIterator.Attribute[] attributes)

BaseAString
```
public BaseAString(AttributedString astr)
```
Конструктор копирования

Parameters:

astr - образец

BaseAString
```
public BaseAString(BaseAString astr)
```
Конструктор копирования

Parameters:

astr - образец

Method Detail
- nextScn
```
protected void nextScn()
```
- getScn
```
public long getScn()
```
- getRunCount
```
public int getRunCount()
```
- getRunStarts
```
public int[] getRunStarts()
```
- getRunAttributes
```
public Vector[] getRunAttributes()
```
- getRunAttributeValues
```
public Vector[] getRunAttributeValues()
```
- clone
```
public BaseAString clone()
```
  Overrides:
  
  clone in class Object
- appendContents
```
protected void appendContents(StringBuffer buf,
                              CharacterIterator iterator)
```
  Appends the contents of the CharacterIterator iterator into the StringBuffer buf.
  
  Parameters:
  
  buf - string buffer
  
  iterator - char iter
- mapsDiffer
```
protected static boolean mapsDiffer(Map last,
                                    Map attrs)
```
  Returns true if the attributes specified in last and attrs differ.
  
  Parameters:
  
  last - doc it
  
  attrs - doc it
  
  Returns:
  
  bla bla
- setAttributes
```
protected void setAttributes(Map attrs,
                             int offset)
```
  Sets the attributes for the range from offset to the next run break (typically the end of the text) to the ones specified in attrs. This is only meant to be called from the constructor!
  
  Parameters:
  
  attrs - doc it
  
  offset - doc it
- createRunAttributeDataVectors
```
protected void createRunAttributeDataVectors()
```
- addAttribute
```
protected void addAttribute(AttributedCharacterIterator.Attribute attribute,
                            Object value)
```
  Adds an attribute to the entire string.
  
  Parameters:
  
  attribute - the attribute key
  
  value - the value of the attribute; may be null
  
  Throws:
  
  NullPointerException - if attribute is null.
  
  IllegalArgumentException - if the AttributedString has length 0 (attributes cannot be applied to a 0-length range).
- addAttribute
```
protected void addAttribute(AttributedCharacterIterator.Attribute attribute,
                            Object value,
                            int beginIndex,
                            int endIndex)
```
  Adds an attribute to a subrange of the string.
  
  Parameters:
  
  attribute - the attribute key
  
  value - The value of the attribute. May be null.
  
  beginIndex - Index of the first character of the range.
  
  endIndex - Index of the character following the last character of the range.
  
  Throws:
  
  NullPointerException - if attribute is null.
  
  IllegalArgumentException - if beginIndex is less then 0, endIndex is greater than the length of the string, or beginIndex and endIndex together don't define a non-empty subrange of the string.
- addAttributes
```
protected void addAttributes(Map<? extends AttributedCharacterIterator.Attribute,?> attributes,
                             int beginIndex,
                             int endIndex)
```
  Adds a set of attributes to a subrange of the string.
  
  Parameters:
  
  attributes - The attributes to be added to the string.
  
  beginIndex - Index of the first character of the range.
  
  endIndex - Index of the character following the last character of the range.
  
  Throws:
  
  NullPointerException - if attributes is null.
  
  IllegalArgumentException - if beginIndex is less then 0, endIndex is greater than the length of the string, or beginIndex and endIndex together don't define a non-empty subrange of the string and the attributes parameter is not an empty Map.
- removeAttributes
```
protected void removeAttributes(Set<? extends AttributedCharacterIterator.Attribute> attributes,
                                int beginIndex,
                                int endIndex)
```
- clearAttributes
```
protected void clearAttributes(int beginIndex,
                               int endIndex)
```
- addAttributeImpl
```
protected void addAttributeImpl(AttributedCharacterIterator.Attribute attribute,
                                Object value,
                                int beginIndex,
                                int endIndex)
```
- removeAttributeImpl
```
protected void removeAttributeImpl(AttributedCharacterIterator.Attribute attribute,
                                   int beginIndex,
                                   int endIndex)
```
- clearAttributesImpl
```
protected void clearAttributesImpl(int beginIndex,
                                   int endIndex)
```
- findRunBreak
```
protected BaseAString.FoundRunBreak findRunBreak(int offset)
```
- ensureRunBreak
```
protected int ensureRunBreak(int offset)
```
- ensureRunBreak
```
protected int ensureRunBreak(int offset,
                             boolean copyAttrs)
```
  Ensures there is a run break at offset, returning the index of the run. If this results in splitting a run, two things can happen:
  - If copyAttrs is true, the attributes from the existing run will be placed in both of the newly created runs.
  - If copyAttrs is false, the attributes from the existing run will NOT be copied to the run to the right (>= offset) of the break, but will exist on the run to the left (< offset).
  Parameters:
  
  offset - doc it
  
  copyAttrs - doc it
  
  Returns:
  
  doc it
- addAttributeRunData
```
protected void addAttributeRunData(AttributedCharacterIterator.Attribute attribute,
                                   Object value,
                                   int beginRunIndex,
                                   int endRunIndex)
```
- removeAttributeRunData
```
protected void removeAttributeRunData(AttributedCharacterIterator.Attribute attribute,
                                      int beginRunIndex,
                                      int endRunIndex)
```
- clearAttributesRunData
```
protected void clearAttributesRunData(int beginRunIndex,
                                      int endRunIndex)
```
- getIterator
```
public AttributedCharacterIterator getIterator()
```
  Creates an AttributedCharacterIterator instance that provides access to the entire contents of this string.
  
  Returns:
  
  An iterator providing access to the text and its attributes.
- getIterator
```
public AttributedCharacterIterator getIterator(AttributedCharacterIterator.Attribute[] attributes)
```
  Creates an AttributedCharacterIterator instance that provides access to selected contents of this string. Information about attributes not listed in attributes that the implementor may have need not be made accessible through the iterator. If the list is null, all available attribute information should be made accessible.
  
  Parameters:
  
  attributes - a list of attributes that the client is interested in
  
  Returns:
  
  an iterator providing access to the entire text and its selected attributes
- getIterator
```
public AttributedCharacterIterator getIterator(AttributedCharacterIterator.Attribute[] attributes,
                                               int beginIndex,
                                               int endIndex)
```
  Creates an AttributedCharacterIterator instance that provides access to selected contents of this string. Information about attributes not listed in attributes that the implementor may have need not be made accessible through the iterator. If the list is null, all available attribute information should be made accessible.
  
  Parameters:
  
  attributes - a list of attributes that the client is interested in
  
  beginIndex - the index of the first character
  
  endIndex - the index of the character following the last character
  
  Returns:
  
  an iterator providing access to the text and its attributes
  
  Throws:
  
  IllegalArgumentException - if beginIndex is less then 0, endIndex is greater than the length of the string, or beginIndex is greater than endIndex.
- charAt
```
public char charAt(int index)
```
- getAttribute
```
protected Object getAttribute(AttributedCharacterIterator.Attribute attribute,
                              int runIndex)
```
- getAttributeCheckRange
```
protected Object getAttributeCheckRange(AttributedCharacterIterator.Attribute attribute,
                                        int runIndex,
                                        int beginIndex,
                                        int endIndex)
```
- attributeValuesMatch
```
protected boolean attributeValuesMatch(Set attributes,
                                       int runIndex1,
                                       int runIndex2)
```
- valuesMatch
```
public static boolean valuesMatch(Object value1,
                                  Object value2)
```
- length
```
public int length()
```
- length
```
public static int length(AttributedCharacterIterator astr)
```
- text
```
public String text()
```

Class BaseAString

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BaseAString

BaseAString

BaseAString

BaseAString

BaseAString

BaseAString

BaseAString

BaseAString

Method Detail

nextScn

getScn

getRunCount

getRunStarts

getRunAttributes

getRunAttributeValues

clone

appendContents

mapsDiffer

setAttributes

createRunAttributeDataVectors

addAttribute

addAttribute

addAttributes

removeAttributes

clearAttributes

addAttributeImpl

removeAttributeImpl

clearAttributesImpl

findRunBreak

ensureRunBreak

ensureRunBreak

addAttributeRunData

removeAttributeRunData

clearAttributesRunData

getIterator

getIterator

getIterator

charAt

getAttribute

getAttributeCheckRange

attributeValuesMatch

valuesMatch

length

length

text