java.text
類別 AttributedString

java.lang.Object
  java.text.AttributedString

public class AttributedString
extends Object

AttributedString 保存文本及相關屬性資訊。在文本 reader 希望通過 AttributedCharacterIterator 介面存取屬性文本的情況下，它可用於存儲實際資料。

屬性是一個鍵/值對，由鍵來標識。給定字元上的兩個屬性不能有相同的鍵。

屬性的值是不變的，或者必須由客戶端或存儲來更換。它們始終由參考來傳遞，但是不進行複製。

從以下版本開始：

1.2

另請參見：

AttributedCharacterIterator, Annotation

建構子摘要

AttributedString(AttributedCharacterIterator text)
建構帶有 AttributedCharacterIterator 表示的給定屬性文本的 AttributedString。

AttributedString(AttributedCharacterIterator text, int beginIndex, int endIndex)
建構帶有 AttributedCharacterIterator 表示的給定屬性文本子範圍的 AttributedString。

AttributedString(AttributedCharacterIterator text, int beginIndex, int endIndex, AttributedCharacterIterator.Attribute[] attributes)
建構具有 AttributedCharacterIterator 表示的給定屬性文本子範圍的 AttributedString。

AttributedString(String text)
建構帶給定文本的 AttributedString 實例。

AttributedString(String text, Map<? extends AttributedCharacterIterator.Attribute,?> attributes)
建構帶給定文本和屬性的 AttributedString。

方法摘要

void	addAttribute(AttributedCharacterIterator.Attribute attribute, Object value) 將一個屬性添加到整個字元串中。
void	addAttribute(AttributedCharacterIterator.Attribute attribute, Object value, int beginIndex, int endIndex) 將一個屬性添加到字元串的子範圍。
void	addAttributes(Map<? extends AttributedCharacterIterator.Attribute,?> attributes, int beginIndex, int endIndex) 將屬性集添加到字元串的子範圍。
AttributedCharacterIterator	getIterator() 創建一個 AttributedCharacterIterator 實例，提供對整個字元串內容的存取。
AttributedCharacterIterator	getIterator(AttributedCharacterIterator.Attribute[] attributes) 創建一個 AttributedCharacterIterator 實例，提供對字元串選定內容的存取。
AttributedCharacterIterator	getIterator(AttributedCharacterIterator.Attribute[] attributes, int beginIndex, int endIndex) 創建一個 AttributedCharacterIterator 實例，提供對字元串選定內容的存取。

從類別 java.lang.Object 繼承的方法

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

建構子詳細資訊

AttributedString

public AttributedString(String text)

建構帶給定文本的 AttributedString 實例。

參數：

text - 此屬性字元串的文本。

拋出：

NullPointerException - 如果 text 為 null。

AttributedString

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

建構帶給定文本和屬性的 AttributedString。

參數：

text - 此屬性字元串的文本。

attributes - 應用於整個字元串的屬性。

拋出：

NullPointerException - 如果 text 或 attributes 為 null。

IllegalArgumentException - 如果文本長度為 0 且屬性參數不是一個空 Map（屬性不能應用於 0 長度範圍文本）。

AttributedString

public AttributedString(AttributedCharacterIterator text)

建構帶有 AttributedCharacterIterator 表示的給定屬性文本的 AttributedString。

參數：

text - 此屬性字元串的文本。

拋出：

NullPointerException - 如果 text 為 null。

AttributedString

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

建構帶有 AttributedCharacterIterator 表示的給定屬性文本子範圍的 AttributedString。如果給定的範圍產生一個空文本，所有的屬性將被丟棄。注意，對於初始屬性範圍的子範圍，Annotation 物件包裹的任何屬性都被丟棄。

參數：

text - 此屬性字元串的文本。

beginIndex - 該範圍的第一個字元的索引。

endIndex - 範圍最後一個字元之後緊鄰字元的索引。

拋出：

NullPointerException - 如果 text 為 null。

IllegalArgumentException - 如果 beginIndex 和 endIndex 給出的子範圍超出文本範圍。

另請參見：

Annotation

AttributedString

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

建構具有 AttributedCharacterIterator 表示的給定屬性文本子範圍的 AttributedString。只有屬性與給定的屬性比對時才被合併進該實例。如果指定的範圍產生一個空文本，所有的屬性將被丟棄。注意，對於初始屬性範圍的子範圍，Annotation 物件包裹的任何屬性都被丟棄。

參數：

text - 此屬性字元串的文本。

beginIndex - 該範圍的第一個字元的索引。

endIndex - 範圍最後一個字元之後緊鄰字元的索引。

attributes - 指定要從文本中提取出來的屬性。如果指定為 null，則用到所有可用屬性。

拋出：

NullPointerException - 如果 text 或 attributes 為 null。

IllegalArgumentException - 如果 beginIndex 和 endIndex 給出的子範圍超出文本範圍。

另請參見：

Annotation

方法詳細資訊

addAttribute

public void addAttribute(AttributedCharacterIterator.Attribute attribute,
                         Object value)

將一個屬性添加到整個字元串中。

參數：

attribute - 屬性鍵

value - 屬性值；可以為 null

拋出：

NullPointerException - 如果 attribute 為 null。

IllegalArgumentException - 如果 AttributedString 長度為 0（屬性不能應用於 0 長度範圍文本）。

addAttribute

public void addAttribute(AttributedCharacterIterator.Attribute attribute,
                         Object value,
                         int beginIndex,
                         int endIndex)

將一個屬性添加到字元串的子範圍。

參數：

attribute - 屬性鍵

value - 屬性值。可以為 null。

beginIndex - 該範圍的第一個字元的索引。

endIndex - 範圍最後一個字元之後緊鄰字元的索引。

拋出：

NullPointerException - 如果 attribute 為 null。

IllegalArgumentException - 如果 beginIndex 小於 0，endIndex 大於字元串的長度，或者 beginIndex 和 endIndex 一起未定義字元串的非空(null)子範圍。

addAttributes

public void addAttributes(Map<? extends AttributedCharacterIterator.Attribute,?> attributes,
                          int beginIndex,
                          int endIndex)

將屬性集添加到字元串的子範圍。

參數：

attributes - 要添加到字元串的屬性。

beginIndex - 該範圍的第一個字元的索引。

endIndex - 範圍最後一個字元之後緊鄰字元的索引。

拋出：

NullPointerException - 如果 attribute 為 null。

IllegalArgumentException - 如果 beginIndex 小於 0，endIndex 大於字元串的長度，或者 beginIndex 和 endIndex 一起未定義字元串的非空(null)子範圍，且屬性參數不是一個空 Map。

getIterator

public AttributedCharacterIterator getIterator()

創建一個 AttributedCharacterIterator 實例，提供對整個字元串內容的存取。

返回：

提供存取文本及其屬性的迭代器。

getIterator

public AttributedCharacterIterator getIterator(AttributedCharacterIterator.Attribute[] attributes)

創建一個 AttributedCharacterIterator 實例，提供對字元串選定內容的存取。實作者不必讓沒有列於屬性中的屬性資訊通過迭代器可存取。如果列表為 null，則應該讓所有可用的屬性資訊都可存取。

參數：

attributes - 客戶端感興趣的屬性列表

返回：

提供存取整個文本及其選定屬性的迭代器

getIterator

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

創建一個 AttributedCharacterIterator 實例，提供對字元串選定內容的存取。實作者不必讓沒有列於屬性中的屬性資訊通過迭代器可存取。如果列表為 null，則應該讓所有可用的屬性資訊都可存取。

參數：

attributes - 客戶端感興趣的屬性列表

beginIndex - 第一個字元的索引

endIndex - 最後一個字元之後緊鄰字元的索引

返回：

提供存取文本及其屬性的迭代器

拋出：

IllegalArgumentException - 如果 beginIndex 小於 0，endIndex 大於字元串的長度，或者 beginIndex 大於 endIndex。