站内搜索: 请输入搜索关键词
当前页面: 在线文档首页 > JavaTM 2 Platform Standard Edition 5.0 API 规范中文版

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

JavaTM 2 Platform
Standard Ed. 5.0

javax.swing.text
类 EditorKit

java.lang.Object
  继承者 javax.swing.text.EditorKit
所有已实现的接口:
Serializable, Cloneable
直接已知子类:
DefaultEditorKit

public abstract class EditorKit
extends Object
implements Cloneable, Serializable

针对某些类型 的文本内容,建立能够合理发挥编辑器功能的文本组件所需的实现集合。EditorKit 充当某个策略类型的工厂。例如,可以提供 html 和 rtf 的实现,它可与其他实现互换。

工具包可安全存储编辑状态,因为工具包的实例专供文本组件使用。新的工具包通常通过克隆原型工具包创建。工具包会调用其 setComponent 方法来建立与 JTextComponent 的联系。


构造方法摘要
EditorKit()
          构造一个 EditorKit。
 
方法摘要
 Object clone()
          创建此编辑器工具包的副本。
abstract  Caret createCaret()
          获取能在由关联的 ViewFactory 生成的视图中导航的插入符。
abstract  Document createDefaultDocument()
          创建一个适合此编辑器类型的未初始化的文本存储模型。
 void deinstall(JEditorPane c)
          从 JEditorPane 中移除工具包时调用。
abstract  Action[] getActions()
          获取能在文本组件上使用的一组命令,该文本组件使用由此工具包生成的模型和视图。
abstract  String getContentType()
          获得此工具包声明支持的数据的 MIME 类型。
abstract  ViewFactory getViewFactory()
          获取适合生成此工具包生成的任何模型视图的工厂。
 void install(JEditorPane c)
          将工具包安装到 JEditorPane 中时调用。
abstract  void read(InputStream in, Document doc, int pos)
          插入来自给定流的内容,其格式需要适合此类型的内容处理程序。
abstract  void read(Reader in, Document doc, int pos)
          插入来自给定流的内容,其格式需要适合此类型的内容处理程序。
abstract  void write(OutputStream out, Document doc, int pos, int len)
          将文档中的内容以适合此类型内容处理程序的格式写入给定的流。
abstract  void write(Writer out, Document doc, int pos, int len)
          将文档中的内容以适合此类型内容处理程序的格式写入给定的流。
 
从类 java.lang.Object 继承的方法
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

构造方法详细信息

EditorKit

public EditorKit()
构造一个 EditorKit。

方法详细信息

clone

public Object clone()
创建此编辑器工具包的副本。实现它可使用 Object.clone。如果无法克隆工具包,则返回 null。

覆盖:
Object 中的 clone
返回:
副本
另请参见:
Cloneable

install

public void install(JEditorPane c)
将工具包安装到 JEditorPane 中时调用。

参数:
c - JEditorPane

deinstall

public void deinstall(JEditorPane c)
从 JEditorPane 中移除工具包时调用。这可用于取消对任何所关联侦听器的注册。

参数:
c - JEditorPane

getContentType

public abstract String getContentType()
获得此工具包声明支持的数据的 MIME 类型。

返回:
类型

getViewFactory

public abstract ViewFactory getViewFactory()
获取适合生成此工具包生成的任何模型视图的工厂。

返回:
工厂

getActions

public abstract Action[] getActions()
获取能在文本组件上使用的一组命令,该文本组件使用由此工具包生成的模型和视图。

返回:
动作组

createCaret

public abstract Caret createCaret()
获取能在由关联的 ViewFactory 生成的视图中导航的插入符。

返回:
插入符

createDefaultDocument

public abstract Document createDefaultDocument()
创建一个适合此编辑器类型的未初始化的文本存储模型。

返回:
模型

read

public abstract void read(InputStream in,
                          Document doc,
                          int pos)
                   throws IOException,
                          BadLocationException
插入来自给定流的内容,其格式需要适合此类型的内容处理程序。

参数:
in - 要读入的流
doc - 插入到的目标文档。
pos - 文档中放入内容的位置,该值 >= 0。
抛出:
IOException - 如果有任何 I/O 错误
BadLocationException - 如果 pos 代表文档中的无效位置。

write

public abstract void write(OutputStream out,
                           Document doc,
                           int pos,
                           int len)
                    throws IOException,
                           BadLocationException
将文档中的内容以适合此类型内容处理程序的格式写入给定的流。

参数:
out - 要写入的流
doc - 写入所用的源文档。
pos - 文档中获取内容的位置,该值 >= 0。
len - 要写入的量,该值 >= 0。
抛出:
IOException - 如果有任何 I/O 错误
BadLocationException - 如果 pos 代表文档中的无效位置。

read

public abstract void read(Reader in,
                          Document doc,
                          int pos)
                   throws IOException,
                          BadLocationException
插入来自给定流的内容,其格式需要适合此类型的内容处理程序。

由于实际的编辑是基于 unicode 的,这将是读入数据的首选方法。但是有些类型的内容以 8 位形式存储,因此又适合 InputStream。

参数:
in - 要读入的流
doc - 插入到的目标文档。
pos - 文档中放入内容的位置,该值 >= 0。
抛出:
IOException - 如果有任何 I/O 错误
BadLocationException - 如果 pos 代表文档中的无效位置。

write

public abstract void write(Writer out,
                           Document doc,
                           int pos,
                           int len)
                    throws IOException,
                           BadLocationException
将文档中的内容以适合此类型内容处理程序的格式写入给定的流。

由于实际的编辑是基于 unicode 的,这将是写入数据的首选方法。但是有些类型的内容以 8 位形式存储,因此又适合 OutputStream。

参数:
out - 要写入的流
doc - 写入所用的源文档。
pos - 文档中获取内容的位置,该值 >= 0。
len - 要写出的量,该值 >= 0。
抛出:
IOException - 如果有任何 I/O 错误
BadLocationException - 如果 pos 代表文档中的无效位置。

JavaTM 2 Platform
Standard Ed. 5.0

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

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