javax.swing.text

Class DefaultStyledDocument

java.lang.Object

javax.swing.text.AbstractDocument

javax.swing.text.DefaultStyledDocument

All Implemented Interfaces:

Serializable， Document， StyledDocument

已知直接子类：

HTMLDocument

public class DefaultStyledDocument
extends AbstractDocument
implements StyledDocument

可以以类似于富文本格式的方式标记字符和段落样式的文档。此文档的元素结构表示样式运行的样式交叉点。这些样式运行被映射到一个段落元素结构（它可以驻留在一些其他结构中）。样式在段落边界上被分配，因为逻辑样式被分配到段落边界。

警告：序列化该类的对象与以后的Swing版本不兼容。当前的序列化支持适用于短期贮藏或RMI运行相同Swing版本的应用程序之间。为1.4，为所有JavaBeans™长期存储的支持已被添加到java.beans包。请看XMLEncoder。

另请参见：

Document， AbstractDocument

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultStyledDocument.AttributeUndoableEdit 一个undoableedit用来记住attributeset改变元素。
class	DefaultStyledDocument.ElementBuffer 类来管理元素层次结构的更改。
static class	DefaultStyledDocument.ElementSpec 建筑构件规范。
protected class	DefaultStyledDocument.SectionElement 用于文档的默认根元素…

Nested classes/interfaces inherited from class javax.swing.text.AbstractDocument

AbstractDocument.AbstractElement, AbstractDocument.AttributeContext, AbstractDocument.BranchElement, AbstractDocument.Content, AbstractDocument.DefaultDocumentEvent, AbstractDocument.ElementEdit, AbstractDocument.LeafElement

Field Summary

Fields

Modifier and Type	Field and Description
protected DefaultStyledDocument.ElementBuffer	buffer
static int	BUFFER_SIZE_DEFAULT 初始内容缓冲区的默认大小。

Fields inherited from class javax.swing.text.AbstractDocument

BAD_LOCATION, BidiElementName, ContentElementName, ElementNameAttribute, listenerList, ParagraphElementName, SectionElementName

Fields inherited from interface javax.swing.text.Document

StreamDescriptionProperty, TitleProperty

构造方法摘要

构造方法

Constructor and Description
DefaultStyledDocument() 构造一个默认的样式文档。
DefaultStyledDocument(AbstractDocument.Content c, StyleContext styles) 构建一个样式文档。
DefaultStyledDocument(StyleContext styles) 构造一个具有默认内容存储实现和一组共享样式的样式的文档。

方法摘要

Modifier and Type	Method and Description
void	addDocumentListener(DocumentListener listener) 添加一个文档侦听器，以通知任何更改。
Style	addStyle(String nm, Style parent) 在逻辑样式层次结构中添加一个新样式。
protected void	create(DefaultStyledDocument.ElementSpec[] data) 初始化文档以反映给定的元素结构（即
protected AbstractDocument.AbstractElement	createDefaultRoot() 创建用于表示默认文档结构的根元素。
Color	getBackground(AttributeSet attr) 从属性集获取背景颜色。
Element	getCharacterElement(int pos) 获取基于位置的字符元素。
Element	getDefaultRootElement() 获取默认根元素。
Font	getFont(AttributeSet attr) 从属性集获取字体。
Color	getForeground(AttributeSet attr) 从属性集获取前景颜色。
Style	getLogicalStyle(int p) 获取分配给给定的位置代表段落的逻辑风格。
Element	getParagraphElement(int pos) 在胶印 pos段落元素。
Style	getStyle(String nm) 获取一个名叫风格以前添加的。
Enumeration<?>	getStyleNames() 取样式名称列表。
protected void	insert(int offset, DefaultStyledDocument.ElementSpec[] data) 批量插入新元素。
protected void	insertUpdate(AbstractDocument.DefaultDocumentEvent chng, AttributeSet attr) 更新文本插入的结果文档结构。
void	removeDocumentListener(DocumentListener listener) 删除文档侦听器。
void	removeElement(Element elem) 从这个文档中删除一个元素。
void	removeStyle(String nm) 删除先前添加到文档中的一个命名样式。
protected void	removeUpdate(AbstractDocument.DefaultDocumentEvent chng) 更新文档结构作为文本移除的结果。
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) 设置段落的属性。
protected void	styleChanged(Style style) 当此文档的样式更改时调用。

Methods inherited from class javax.swing.text.AbstractDocument

addUndoableEditListener, createBranchElement, createLeafElement, createPosition, dump, fireChangedUpdate, fireInsertUpdate, fireRemoveUpdate, fireUndoableEditUpdate, getAsynchronousLoadPriority, getAttributeContext, getBidiRootElement, getContent, getCurrentWriter, getDocumentFilter, getDocumentListeners, getDocumentProperties, getEndPosition, getLength, getListeners, getProperty, getRootElements, getStartPosition, getText, getText, getUndoableEditListeners, insertString, postRemoveUpdate, putProperty, readLock, readUnlock, remove, removeUndoableEditListener, render, replace, setAsynchronousLoadPriority, setDocumentFilter, setDocumentProperties, writeLock, writeUnlock

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.text.Document

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

Field Detail

BUFFER_SIZE_DEFAULT

public static final int BUFFER_SIZE_DEFAULT

初始内容缓冲区的默认大小。

另请参见：

Constant Field Values

buffer

protected DefaultStyledDocument.ElementBuffer buffer

Constructor Detail

DefaultStyledDocument

public DefaultStyledDocument(AbstractDocument.Content c,
                             StyleContext styles)

构建一个样式文档。

参数

c为内容的容器

styles资源和样式定义的可共享的文件

DefaultStyledDocument

public DefaultStyledDocument(StyleContext styles)

构造一个具有默认内容存储实现和一组共享样式的样式的文档。

参数

styles -风格

DefaultStyledDocument

public DefaultStyledDocument()

构造一个默认的样式文档。这个缓冲区输入内容的大小和有buffer_size_default样式上下文显示的文档的寿命和不与其他文件共享。

方法详细信息

getDefaultRootElement

public Element getDefaultRootElement()

获取默认根元素。

Specified by:

getDefaultRootElement 接口 Document

Specified by:

getDefaultRootElement 方法重写，继承类 AbstractDocument

结果

根

另请参见：

Document.getDefaultRootElement()

create

protected void create(DefaultStyledDocument.ElementSpec[] data)

初始化文件反映了元件的结构（即结构的 getDefaultRootElement报道方法。如果文档包含任何数据，它将首先被删除。

insert

protected void insert(int offset,
                      DefaultStyledDocument.ElementSpec[] data)
               throws BadLocationException

批量插入新元素。这是有用的，允许在一个未锁的状态解析文档，并准备一个元素结构修改。此方法需要一个描述如何更新元素结构的令牌数组，所以在一个异步更新情况下，可以大大减少写锁中的时间。

这种方法是线程安全的，虽然大多数摇摆方法不是。更多信息请见Concurrency in Swing。

参数

offset -起始偏移> = 0

data -元素数据

异常

BadLocationException -无效的起始偏移

removeElement

public void removeElement(Element elem)

从这个文档中删除一个元素。

元素从它的父元素中移除，以及在元素所标识的范围内的文本。如果元素不与文档相关联的，IllegalArgumentException抛出。

在文档中不允许空的分支元素，如果元素是唯一的子元素，它的父元素也将被移除，递归地。这意味着，当更换一个特定元素的所有的孩子，新的孩子应该被添加在删除旧的儿童。

元素的去除结果两事件被解雇，对文档内容的变化和变化的DocumentEvent UndoableEditEvent元件结构。

如果元素包含的内容（文件结束标志的最后"\n"字符），这个字符不去除；相反，前叶元素扩展到覆盖特性。如果最后一片叶子已经结束"\n",它包含在内容删除。

如果元素是null, NullPointerException抛出。如果元素结构拆除后变得无效，例如，如果元素是文档的根元素，IllegalArgumentException抛出。如果当前元素的结构是无效的，IllegalStateException抛出。

参数

elem -要移除的元素

异常

NullPointerException -如果元素是 null

IllegalArgumentException -如果元素不能被删除

IllegalStateException如果元结构是无效的

从以下版本开始：

一点七

addStyle

public Style addStyle(String nm,
                      Style parent)

在逻辑样式层次结构中添加一个新样式。样式属性从下向上解决，所以子中指定的属性将覆盖父中指定的属性。

Specified by:

addStyle 接口 StyledDocument

参数

nm -该样式的名称（必须命名风格的集合中是唯一的）。如果样式是未命名的，则该名称可能为空，但调用方负责管理返回的引用作为一个未命名的样式无法获取名称。一位不愿透露姓名的风格可能像字符属性重写如风格运行发现是有用的。

parent -父样式。这可能是空的，如果未指定的属性，不需要在其他一些风格解决。

结果

风格

removeStyle

public void removeStyle(String nm)

删除先前添加到文档中的一个命名样式。

Specified by:

removeStyle 接口 StyledDocument

参数

nm -风格的名字删除

getStyle

public Style getStyle(String nm)

获取一个名叫风格以前添加的。

Specified by:

getStyle 接口 StyledDocument

参数

nm -样式的名称

结果

风格

getStyleNames

public Enumeration<?> getStyleNames()

取样式名称列表。

结果

所有的样式名称

setLogicalStyle

public void setLogicalStyle(int pos,
                            Style s)

设置给定位置的段落的逻辑样式。如果属性没有显式设置为字符和段落属性，他们将通过分配给该段的逻辑样式来解决，这反过来又可以通过一些完全独立于文档中元素层次结构的层次结构来解决。

这种方法是线程安全的，虽然大多数摇摆方法不是。更多信息请见Concurrency in Swing。

Specified by:

setLogicalStyle 接口 StyledDocument

参数

pos -从文档> = 0开始的偏移量

s -指定段落的逻辑风格，如果没有返回null

getLogicalStyle

public Style getLogicalStyle(int p)

获取分配给给定的位置代表段落的逻辑风格。

Specified by:

getLogicalStyle 接口 StyledDocument

参数

p位置--翻译一段和确定分配> = 0的逻辑式。这是一个从文档的开始偏移。

结果

风格，如果没有空

setCharacterAttributes

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

设置文档的某一部分的属性。一个写锁是由这个操作而正在作出改变，和documentevent是变更后已成功完成发送给听众。

这种方法是线程安全的，虽然大多数摇摆方法不是。更多信息请见Concurrency in Swing。

Specified by:

setCharacterAttributes 接口 StyledDocument

参数

offset在文件> = 0的偏移

length -长度> = 0

s -属性

replace -如果以前的属性应该在设置新的属性替换

setParagraphAttributes

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

设置段落的属性。

这种方法是线程安全的，虽然大多数摇摆方法不是。更多信息请见Concurrency in Swing。

Specified by:

setParagraphAttributes 接口 StyledDocument

参数

offset -偏移到段落> = 0

length -影响> = 0字符数

s -属性

replace -是否替换现有的属性，或者将他们合并

getParagraphElement

public Element getParagraphElement(int pos)

在胶印 pos段落元素。一个段落由至少一个子元素组成，通常是一个叶子。

Specified by:

getParagraphElement 接口 StyledDocument

Specified by:

getParagraphElement 方法重写，继承类 AbstractDocument

参数

pos -起始偏移> = 0

结果

元素

getCharacterElement

public Element getCharacterElement(int pos)

获取基于位置的字符元素。

Specified by:

getCharacterElement 接口 StyledDocument

参数

pos在文件> = 0的位置

结果

元素

insertUpdate

protected void insertUpdate(AbstractDocument.DefaultDocumentEvent chng,
                            AttributeSet attr)

更新文本插入的结果文档结构。这将发生在一个写锁。这种实现简单解析插入内容的换行和建立元素的缓冲指令。

重写：

insertUpdate 方法重写，继承类 AbstractDocument

参数

chng -描述文件的改变

attr -属性

removeUpdate

protected void removeUpdate(AbstractDocument.DefaultDocumentEvent chng)

更新文档结构作为文本移除的结果。

重写：

removeUpdate 方法重写，继承类 AbstractDocument

参数

chng -描述文件的改变

createDefaultRoot

protected AbstractDocument.AbstractElement createDefaultRoot()

创建用于表示默认文档结构的根元素。

结果

的元件库

getForeground

public Color getForeground(AttributeSet attr)

从属性集获取前景颜色。

Specified by:

getForeground 接口 StyledDocument

参数

attr -属性设置

结果

颜色

getBackground

public Color getBackground(AttributeSet attr)

从属性集获取背景颜色。

Specified by:

getBackground 接口 StyledDocument

参数

attr -属性设置

结果

颜色

getFont

public Font getFont(AttributeSet attr)

从属性集获取字体。

Specified by:

getFont 接口 StyledDocument

参数

attr -属性设置

结果

字体

styleChanged

protected void styleChanged(Style style)

当此文档的样式更改时调用。子类可能希望对损坏的东西有智能化的。

参数

style的风格改变了。

addDocumentListener

public void addDocumentListener(DocumentListener listener)

添加一个文档侦听器，以通知任何更改。

Specified by:

addDocumentListener 接口 Document

重写：

addDocumentListener 方法重写，继承类 AbstractDocument

参数

listener -听众

另请参见：

Document.addDocumentListener(javax.swing.event.DocumentListener)

removeDocumentListener

public void removeDocumentListener(DocumentListener listener)

删除文档侦听器。

Specified by:

removeDocumentListener 接口 Document

重写：

removeDocumentListener 方法重写，继承类 AbstractDocument

参数

listener -听众

另请参见：

Document.removeDocumentListener(javax.swing.event.DocumentListener)