JavaTM 2 Platform
Standard Ed. 6

javax.swing.event
接口 DocumentEvent

所有已知实现类:
AbstractDocument.DefaultDocumentEvent

public interface DocumentEvent

用于文档更改通知的接口。此接口为 Document 观察者提供了有关 Document 更改方式的细节信息。它提供一些高级信息,比如更改类型、在哪儿发生更改,以及更多具体的结构性更改(插入和移除哪些 Element)。

另请参见:
Document, DocumentListener

嵌套类摘要
static interface DocumentEvent.ElementChange
          描述对特定元素所做的更改。
static class DocumentEvent.EventType
          文档事件类型的枚举
 
方法摘要
 DocumentEvent.ElementChange getChange(Element elem)
          获得给定元素的更改信息。
 Document getDocument()
          获得发起更改事件的文档。
 int getLength()
          返回更改的长度。
 int getOffset()
          返回文档中更改开始的偏移量。
 DocumentEvent.EventType getType()
          获得事件类型。
 

方法详细信息

getOffset

int getOffset()
返回文档中更改开始的偏移量。

返回:
偏移量,该偏移量 >= 0

getLength

int getLength()
返回更改的长度。

返回:
长度,该长度 >= 0

getDocument

Document getDocument()
获得发起更改事件的文档。

返回:
文档

getType

DocumentEvent.EventType getType()
获得事件类型。

返回:
类型

getChange

DocumentEvent.ElementChange getChange(Element elem)
获得给定元素的更改信息。更改信息描述了哪些元素被添加和移处,以及添加和移处的位置。如果没有更改,则返回 null。

此方法适用于观察者发现已完成的结构性更改。这意味着只有发生变化之前存在的元素(以及发生变化之后仍然存在的元素)需要有 ElementChange 记录。变得可用的更改不必是递归的。

例如,如果从父元素中移除某个元素,则此方法应该报告该父元素已更改,并提供描述父元素的更改的 ElementChange 实现。如果已移除的子元素有子级,则在移除时不需要报告这些元素。

如果子元素被插入到父元素中,则父元素应该报告此更改。如果子元素中还有一些已插入其中的元素(父元素的孙级),则这些元素无需报告发生的更改。

参数:
elem - 元素
返回:
更改信息,如果元素未被修改,则返回 null

JavaTM 2 Platform
Standard Ed. 6

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策