Module  java.desktop
软件包  javax.swing

Class JTextPane

  • All Implemented Interfaces:
    ImageObserverMenuContainerSerializableAccessibleScrollable


    @JavaBean(description="A text component that can be marked up with attributes that are graphically represented.")
    public class JTextPane
    extends JEditorPane
    可以用图形化的属性标记的文本组件。 您可以在“Java教程”一节中 Using Text Components中找到使用文本窗格的操作方法信息和示例

    该组件模拟由字符级属性运行组成的段落。 每个段落可能具有连接到其上的逻辑风格,其中包含默认属性,如果不被该段落或字符运行时设置的属性覆盖,则使用默认属性。 组件和图像可能嵌入在文本流中。

    换行
    有关如何处理换行符的讨论,请参阅DefaultEditorKit

    警告: Swing不是线程安全的。 有关详细信息,请参阅Swing's Threading Policy

    警告:此类的序列化对象与将来的Swing版本不兼容。 当前的序列化支持适用于运行相同版本的Swing的应用程序之间的短期存储或RMI。 从1.4开始,支持所有JavaBeans的长期存储已被添加到java.beans包中。 请参阅XMLEncoder

    从以下版本开始:
    1.2
    另请参见:
    StyledEditorKitSerialized Form
    • 构造方法详细信息

      • JTextPane

        public JTextPane​()
        创建一个新的JTextPane 创建并设置新的StyledEditorKit实例,并将文档模型设置为null
      • JTextPane

        public JTextPane​(StyledDocument doc)
        创建一个新的JTextPane ,具有指定的文档模型。 创建并设置了一个新的javax.swing.text.StyledEditorKit实例。
        参数
        doc - 文件模型
    • 方法详细信息

      • setStyledDocument

        public void setStyledDocument​(StyledDocument doc)
        将编辑器与文本文档相关联。 当前注册的工厂用于构建文档的视图,由编辑器显示。
        参数
        doc - 要显示/编辑的文档
      • getStyledDocument

        public StyledDocument getStyledDocument​()
        获取与编辑器相关联的模型。
        结果
        该模型
      • replaceSelection

        public void replaceSelection​(String content)
        用给定字符串表示的新内容替换当前所选内容。 如果没有选择,这相当于给定文本的插入。 如果没有替换文本,则相当于删除当前选择。 替换文本将具有当前为插入点定义的输入属性。 如果文档不可编辑,则发出哔声并返回。
        重写:
        replaceSelection中的 JEditorPane
        参数
        content - 用于替换选择的内容
      • insertComponent

        public void insertComponent​(Component c)
        将组件插入到文档中作为当前所选内容的替代。 如果没有选择,组件将有效地插入到插入符号的当前位置。 这在相关联的文档中被表示为内容的一个字符的属性。

        给出的组件是JTextPane使用的实际组件。 由于组件不能是多个容器的子级,所以在模型由文本组件共享的情况下不应使用此方法。

        组件根据Component.getAlignmentY返回的值相对于文本基线放置。 对于Swing组件,可以使用方法JComponent.setAlignmentY方便地设置该值。 例如,设置值为0.75将导致75%的组件高于基线,25%的组件将低于基线。

        参数
        c - 要插入的组件
      • insertIcon

        public void insertIcon​(Icon g)
        将图标插入到文档中作为当前所选内容的替代。 如果没有选择,图标将有效插入插入符号的当前位置。 这在相关联的文档中被表示为内容的一个字符的属性。
        参数
        g - 要插入的图标
        另请参见:
        Icon
      • addStyle

        public Style addStyle​(String nm,
                              Style parent)
        在逻辑样式层次结构中添加新样式。 样式属性从下到上解析,因此在孩子中指定的属性将覆盖父项中指定的属性。
        参数
        nm - 样式的名称(在命名样式的集合中必须是唯一的)。 如果样式未命名,则名称可能为null ,但是调用者负责管理返回的引用,因为未命名的样式无法通过名称获取。 一个未命名的样式可能对于诸如字符属性覆盖(例如在样式运行中找到)的事情是有用的。
        parent - 父风格。 如果未指定的属性不需要以某种其他风格解决,则可能是null
        结果
        新的 Style
      • removeStyle

        public void removeStyle​(String nm)
        删除以前添加到文档的未命名的非 null样式。
        参数
        nm - 要删除的样式的名称
      • getStyle

        public Style getStyle​(String nm)
        获取以前添加的一个名为非 null样式。
        参数
        nm - 风格的名称
        结果
        Style
      • setLogicalStyle

        public void setLogicalStyle​(Style s)
        设置用于当前插入符位置的段落的逻辑样式。 如果没有为字符和段落属性显式设置属性,则它们将通过分配给段落的逻辑样式来解析,该段落可以通过某些层次结构完全独立于文档中的元素层次结构来解析。
        参数
        s - 分配给段落的逻辑风格,或 null为无风格
      • getLogicalStyle

        public Style getLogicalStyle​()
        获取分配给由插入符号的当前位置表示的段落的逻辑样式,或 null
        结果
        Style
      • getCharacterAttributes

        @BeanProperty(bound=false)
        public AttributeSet getCharacterAttributes​()
        获取在插入符号的当前位置生效的字符属性,或 null
        结果
        属性,或 null
      • setCharacterAttributes

        public void setCharacterAttributes​(AttributeSet attr,
                                           boolean replace)
        将给定的属性应用于字符内容。 如果有选择,属性将应用于选择范围。 如果没有选择,则属性将应用于输入属性集,该属性集定义任何插入的新文本的属性。
        参数
        attr - 属性
        replace - 如果为true,则先替换现有属性
      • getParagraphAttributes

        @BeanProperty(bound=false)
        public AttributeSet getParagraphAttributes​()
        获取当前段落属性在插入符号的位置,或 null如果没有)。
        结果
        属性
      • setParagraphAttributes

        public void setParagraphAttributes​(AttributeSet attr,
                                           boolean replace)
        将给定的属性应用于段落。 如果有选择,属性将应用于与选择相交的段落。 如果没有选择,属性将应用于当前插入符位置的段落。
        参数
        attr - 非 null属性
        replace - 如果为true, replace替换现有属性
      • getStyledEditorKit

        protected final StyledEditorKit getStyledEditorKit​()
        获得编辑工具包。
        结果
        编辑工具包
      • createDefaultEditorKit

        protected EditorKit createDefaultEditorKit​()
        创建默认使用的EditorKit 这是实现返回javax.swing.text.StyledEditorKit
        重写:
        createDefaultEditorKitJEditorPane
        结果
        编辑工具包
      • paramString

        protected String paramString​()
        返回此JTextPane的字符串表示JTextPane 该方法仅用于调试目的,并且返回的字符串的内容和格式可能因实现而异。 返回的字符串可能为空,但可能不是null
        重写:
        paramStringJEditorPane
        结果
        这个 JTextPane的字符串表示 JTextPane