当前页面: 在线文档首页 > JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

AbstractDocument.DefaultDocumentEvent (Java 2 Platform SE 5.0) - JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

概述  软件包   类  使用  树  已过时  索引  帮助		JavaTM 2 Platform Standard Ed. 5.0
上一个类   下一个类	框架    无框架
摘要： 嵌套 | 字段 | 构造方法 | 方法	详细信息： 字段 | 构造方法 | 方法

---

javax.swing.text
类 AbstractDocument.DefaultDocumentEvent

java.lang.Object
  javax.swing.undo.AbstractUndoableEdit
      javax.swing.undo.CompoundEdit
          javax.swing.text.AbstractDocument.DefaultDocumentEvent

所有已实现的接口：

Serializable, DocumentEvent, UndoableEdit

正在封闭类：

AbstractDocument

---

public class AbstractDocument.DefaultDocumentEvent
extends CompoundEdit
implements DocumentEvent

存储修改文档时发生的文档更改。文档修改完成后，可将此内容用于更改通知。AbstractDocument 类及其扩展使用此方法向文档侦听器广播更改信息。

---

嵌套类摘要

 

从接口 javax.swing.event.DocumentEvent 继承的嵌套类/接口
DocumentEvent.ElementChange, DocumentEvent.EventType

 

字段摘要

 

从类 javax.swing.undo.CompoundEdit 继承的字段
edits

 

从类 javax.swing.undo.AbstractUndoableEdit 继承的字段
RedoName, UndoName

 

构造方法摘要
AbstractDocument.DefaultDocumentEvent(int offs, int len, DocumentEvent.EventType type)           构造更改记录。

 

方法摘要
boolean	addEdit(UndoableEdit anEdit)           添加文档编辑。
DocumentEvent.ElementChange	getChange(Element elem)           获得元素的更改。
Document	getDocument()           获得发起更改事件的文档。
int	getLength()           返回更改的长度。
int	getOffset()           返回文档中更改开始位置的偏移量。
String	getPresentationName()           提供此次编辑的已本地化的、可读的描述，比如，适合于在更改日志中使用的。
String	getRedoPresentationName()           提供此次编辑可重复执行形式的、已本地化的、可读的描述，例如用作 Redo 菜单项。
DocumentEvent.EventType	getType()           返回事件的类型。
String	getUndoPresentationName()           提供此次编辑可撤消形式的、已本地化的、可读的描述，例如，用作 Undo 菜单项。
boolean	isSignificant()           DefaultDocument 事件是有意义的。
void	redo()           重复执行更改。
String	toString()           返回更改事件的字符串表示形式。
void	undo()           撤消更改。

 

从类 javax.swing.undo.CompoundEdit 继承的方法
canRedo, canUndo, die, end, isInProgress, lastEdit

 

从类 javax.swing.undo.AbstractUndoableEdit 继承的方法
replaceEdit

 

从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

构造方法详细信息

AbstractDocument.DefaultDocumentEvent

public AbstractDocument.DefaultDocumentEvent(int offs,
                                             int len,
                                             DocumentEvent.EventType type)

构造更改记录。

参数：

offs - 更改文档中的偏移量，该偏移量 >= 0

len - 更改的长度，该长度 >= 0

type - 事件类型 (DocumentEvent.EventType)

方法详细信息

toString

public String toString()

返回更改事件的字符串表示形式。

覆盖：

类 CompoundEdit 中的 toString

返回：

字符串。

---

addEdit

public boolean addEdit(UndoableEdit anEdit)

添加文档编辑。如果编辑事件的数量超过阈值，则会开启哈希表上针对 ElementChange 实现的查找功能，因为需要相对快速地执行这些访问。

指定者：

接口 UndoableEdit 中的 addEdit

覆盖：

类 CompoundEdit 中的 addEdit

参数：

anEdit - 文档编辑记录

返回：

如果添加了编辑，则返回 true

另请参见：

UndoableEdit.addEdit(javax.swing.undo.UndoableEdit)

---

redo

public void redo()
          throws CannotRedoException

重复执行更改。

指定者：

接口 UndoableEdit 中的 redo

覆盖：

类 CompoundEdit 中的 redo

抛出：

CannotRedoException - 如果无法重复执行该更改

另请参见：

AbstractUndoableEdit.canRedo()

---

undo

public void undo()
          throws CannotUndoException

撤消更改。

指定者：

接口 UndoableEdit 中的 undo

覆盖：

类 CompoundEdit 中的 undo

抛出：

CannotUndoException - 如果无法撤消该更改

另请参见：

AbstractUndoableEdit.canUndo()

---

isSignificant

public boolean isSignificant()

DefaultDocument 事件是有意义的。如果希望聚集多个 DefaultDocumentEvent，以将其作为单次编辑展示给用户，则可将这些事件放入 CompoundEdit 中。

指定者：

接口 UndoableEdit 中的 isSignificant

覆盖：

类 CompoundEdit 中的 isSignificant

返回：

该事件对于编辑撤消而言是否有意义

另请参见：

UndoableEdit.isSignificant()

---

getPresentationName

public String getPresentationName()

提供此次编辑的已本地化的、可读的描述，比如，适合于在更改日志中使用的。

指定者：

接口 UndoableEdit 中的 getPresentationName

覆盖：

类 CompoundEdit 中的 getPresentationName

返回：

描述

另请参见：

AbstractUndoableEdit.getUndoPresentationName(), AbstractUndoableEdit.getRedoPresentationName()

---

getUndoPresentationName

public String getUndoPresentationName()

提供此次编辑可撤消形式的、已本地化的、可读的描述，例如，用作 Undo 菜单项。通常派生自 getDescription()；

指定者：

接口 UndoableEdit 中的 getUndoPresentationName

覆盖：

类 CompoundEdit 中的 getUndoPresentationName

返回：

描述

另请参见：

AbstractUndoableEdit.getPresentationName()

---

getRedoPresentationName

public String getRedoPresentationName()

提供此次编辑可重复执行形式的、已本地化的、可读的描述，例如用作 Redo 菜单项。通常派生自 getPresentationName()；

指定者：

接口 UndoableEdit 中的 getRedoPresentationName

覆盖：

类 CompoundEdit 中的 getRedoPresentationName

返回：

描述

另请参见：

AbstractUndoableEdit.getPresentationName()

---

getType

public DocumentEvent.EventType getType()

返回事件的类型。

指定者：

接口 DocumentEvent 中的 getType

返回：

以 DocumentEvent.EventType 形式返回事件的类型

另请参见：

DocumentEvent.getType()

---

getOffset

public int getOffset()

返回文档中更改开始位置的偏移量。

指定者：

接口 DocumentEvent 中的 getOffset

返回：

偏移量，该偏移量 >= 0

另请参见：

DocumentEvent.getOffset()

---

getLength

public int getLength()

返回更改的长度。

指定者：

接口 DocumentEvent 中的 getLength

返回：

长度，该长度 >= 0

另请参见：

Document.getLength()

---

getDocument

public Document getDocument()

获得发起更改事件的文档。

指定者：

接口 DocumentEvent 中的 getDocument

返回：

文档

另请参见：

DocumentEvent.getDocument()

---

getChange

public DocumentEvent.ElementChange getChange(Element elem)

获得元素的更改。

指定者：

接口 DocumentEvent 中的 getChange

参数：

elem - 元素

返回：

更改

---

概述  软件包   类  使用  树  已过时  索引  帮助		JavaTM 2 Platform Standard Ed. 5.0
上一个类   下一个类	框架    无框架
摘要： 嵌套 | 字段 | 构造方法 | 方法	详细信息： 字段 | 构造方法 | 方法

---

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

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