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 - 属性集

返回：

字体