javax.swing.text
介面 StyledDocument

所有父級介面：

Document

所有已知實作類別：

DefaultStyledDocument, HTMLDocument

public interface StyledDocument
extends Document

用作通用樣式化文檔的介面。

欄位摘要

從介面 javax.swing.text.Document 繼承的欄位

StreamDescriptionProperty, TitleProperty

方法摘要

Style	addStyle(String nm, Style parent) 向邏輯樣式層次中添加新樣式。
Color	getBackground(AttributeSet attr) 使用一個屬性集並將其轉換為一個背景色規範。
Element	getCharacterElement(int pos) 獲取表示文檔中給定偏移量處字元的元素。
Font	getFont(AttributeSet attr) 使用一個屬性集並將其轉換為字體規範。
Color	getForeground(AttributeSet attr) 使用一個屬性集並將其轉換成為一個前景色規範。
Style	getLogicalStyle(int p) 獲取段落中給定位置的邏輯樣式。
Element	getParagraphElement(int pos) 獲取表示包含文檔中給定偏移量的段落的元素。
Style	getStyle(String nm) 獲取以前添加的指定樣式。
void	removeStyle(String nm) 移除以前添加到文檔中的指定樣式。
void	setCharacterAttributes(int offset, int length, AttributeSet s, boolean replace) 更改內容元素屬性，該屬性是用來給定文檔中現有內容範圍的。
void	setLogicalStyle(int pos, Style s) 設置給定位置的段落所用的邏輯樣式。
void	setParagraphAttributes(int offset, int length, AttributeSet s, boolean replace) 設置段落屬性。

從介面 javax.swing.text.Document 繼承的方法

addDocumentListener, addUndoableEditListener, createPosition, getDefaultRootElement, getEndPosition, getLength, getProperty, getRootElements, getStartPosition, getText, getText, insertString, putProperty, remove, removeDocumentListener, removeUndoableEditListener, render

方法詳細資訊

addStyle

Style addStyle(String nm,
               Style parent)

向邏輯樣式層次中添加新樣式。樣式屬性自下向上進行解析，所以在子級中指定的屬性將覆寫父級中指定的屬性。

參數：

nm - 樣式的名稱（在命名樣式集合中必須是惟一的）。如果樣式未命名，則此名稱可能為 null，但是調用者要負責管理返回的參考，因為未命名的樣式不能通過其名稱獲取。未命名的樣式可以用於諸如字元屬性覆寫這樣的情況（例如在樣式運行中）。

parent - 父樣式。如果未指定的屬性不需要以其他樣式解析，則此值可以為 null。

返回：

樣式

removeStyle

void removeStyle(String nm)

移除以前添加到文檔中的指定樣式。

參數：

nm - 要移除的樣式的名稱

getStyle

Style getStyle(String nm)

獲取以前添加的指定樣式。

參數：

nm - 樣式名稱

返回：

樣式

setCharacterAttributes

void setCharacterAttributes(int offset,
                            int length,
                            AttributeSet s,
                            boolean replace)

更改內容元素屬性，該屬性是用來給定文檔中現有內容範圍的。給定 Attributes 參數中定義的所有屬性都適用於此給定的範圍。此方法可用來完全移除給定範圍的所有內容層次的屬性，這是通過提供尚未定義屬性的 AttributeSet 參數和將 replace 參數設置為 true 實作的。

參數：

offset - 開始更改處，該值 >= 0

length - 更改的長度，該值 >= 0

s - 要更改為的非 null 屬性。任何定義的屬性都將適用於此給定範圍的文本。

replace - 表示在設置新屬性時是否清除以前的屬性。如果為 true，此操作將完全替換以前的屬性。如果為 false，新屬性將與以前的屬性合併。

setParagraphAttributes

void setParagraphAttributes(int offset,
                            int length,
                            AttributeSet s,
                            boolean replace)

設置段落屬性。

參數：

offset - 開始更改處，該值 >= 0

length - 更改的長度，該值 >= 0

s - 要更改為的非 null 屬性。任何定義的屬性都將適用於此給定範圍的文本。

replace - 表示在設置新屬性時是否清除以前的屬性。如果為 true，此操作將完全替換以前的屬性。如果為 false，新屬性將與以前的屬性合併。

setLogicalStyle

void setLogicalStyle(int pos,
                     Style s)

設置給定位置的段落所用的邏輯樣式。如果沒有為字元和段落屬性顯式設置屬性，則它們將通過分派到段落的邏輯樣式進行解析，也就是通過某個層次結構來解析，這些層次結構完全獨立於文檔中元素的層次結構。

參數：

pos - 開始位置，該值 >= 0

s - 要設置的樣式

getLogicalStyle

Style getLogicalStyle(int p)

獲取段落中給定位置的邏輯樣式。

參數：

p - 位置，該值 >= 0

返回：

樣式

getParagraphElement

Element getParagraphElement(int pos)

獲取表示包含文檔中給定偏移量的段落的元素。

參數：

pos - 偏移量，該值 >= 0

返回：

元素

getCharacterElement

Element getCharacterElement(int pos)

獲取表示文檔中給定偏移量處字元的元素。

參數：

pos - 偏移量，該值 >= 0

返回：

元素

getForeground

Color getForeground(AttributeSet attr)

使用一個屬性集並將其轉換成為一個前景色規範。此方法可以用於指定諸如更亮、更鮮艷等之類別的內容。

參數：

attr - 屬性集

返回：

顏色

getBackground

Color getBackground(AttributeSet attr)

使用一個屬性集並將其轉換為一個背景色規範。此方法可以用於指定諸如更亮、更鮮艷等之類別的內容。

參數：

attr - 屬性集

返回：

顏色

getFont

Font getFont(AttributeSet attr)

使用一個屬性集並將其轉換為字體規範。此操作可用於將諸如系列、樣式、大小等一類別的東西轉換為當前文檔所用的系統中可用的字體。

參數：

attr - 屬性集

返回：

字體