モジュール java.desktop
パッケージ javax.swing

クラスJTextPane

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.text.JTextComponent
javax.swing.JEditorPane
javax.swing.JTextPane
すべての実装されたインタフェース:
ImageObserver, MenuContainer, Serializable, Accessible, Scrollable
@JavaBean(description="A text component that can be marked up with attributes that are graphically represented.")
public class JTextPane
extends JEditorPane
グラフィックで表現される属性でマークアップできるテキスト・コンポーネントです。 使用方法およびテキスト・ペインの例については、『The Java Tutorial』の「Using Text Components」を参照してください。

このコンポーネントは、文字レベル属性の並びから構成される段落をモデル化します。 各段落には、段落または文字の並びに設定される属性によってオーバーライドされないかぎり使用される、デフォルト属性を収めた論理書式が付属しています。 コンポーネントとイメージは、テキストの中に組み込むことができます。

Newlines
改行の処理方法については、DefaultEditorKitを参照してください。

警告: Swingはスレッドに対して安全ではありません。 詳細は、「Swing's Threading Policy」を参照してください。

警告: このクラスの直列化されたオブジェクトは、今後のSwingリリースと互換ではなくなる予定です。 現在の直列化のサポートは、短期間の格納や、同じバージョンのSwingを実行するアプリケーション間のRMIに適しています。 1.4では、すべてのJavaBeansの長期ストレージのサポートがjava.beansパッケージに追加されました。 XMLEncoderを参照してください。

導入されたバージョン:
1.2
関連項目:
StyledEditorKit

  • コンストラクタの詳細

    • JTextPane

      public JTextPane()
      新しいJTextPaneを作成します。 StyledEditorKitの新しいインスタンスが生成および設定され、ドキュメント・モデルはnullに設定されます。

    • JTextPane

      public JTextPane​(StyledDocument doc)
      指定されたドキュメント・モデルを使用して、新しいJTextPaneを作成します。 javax.swing.text.StyledEditorKitの新しいインスタンスが生成および設定されます。
      パラメータ:
      doc - ドキュメント・モデル

  • メソッドの詳細

    • getUIClassID

      @BeanProperty(bound=false) public String getUIClassID()
      UIのクラスIDを返します。
      オーバーライド:
      getUIClassID 、クラス:  JEditorPane
      戻り値:
      文字列「TextPaneUI」
      関連項目:
      JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

    • setDocument

      public void setDocument​(Document doc)
      エディタをテキスト・ドキュメントに関連付けます。 これはStyledDocumentである必要があります。
      オーバーライド:
      setDocument 、クラス:  JTextComponent
      パラメータ:
      doc - 表示および編集するドキュメント
      例外:
      IllegalArgumentException - docをこのテキスト・コンポーネントに必要な型のモデルであるStyledDocumentにナロー変換できない場合
      関連項目:
      JTextComponent.getDocument()

    • 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)
      現在選択されている内容の置換としてドキュメントにコンポーネントを挿入します。 選択範囲がない場合、コンポーネントは事実上、キャレットの現在の位置に挿入されます。 これは、関連したドキュメントでコンテンツの1文字の属性として表現されます。

      指定されるコンポーネントは、JTextPaneが使う実際のコンポーネントです。 コンポーネントは複数のコンテナの子になることはできないため、複数のテキスト・コンポーネントでモデルを共用する場合は、このメソッドを使わないでください。

      コンポーネントは、Component.getAlignmentYによって返された値に従って、テキスト・ベースラインに相対的に配置されます。 Swingコンポーネントの場合、JComponent.setAlignmentYメソッドを使うと、この値を簡単に設定できます。 たとえば、値を0.75に設定すると、コンポーネントの75パーセントがベースラインの上に、25パーセントがベースラインの下になります。

      パラメータ:
      c - 挿入されるコンポーネント

    • insertIcon

      public void insertIcon​(Icon g)
      現在選択されているコンテンツの置換後の内容としてドキュメントにアイコンを挿入します。 選択範囲がない場合、アイコンは事実上、キャレットの現在の位置に挿入されます。 これは、関連したドキュメントでコンテンツの1文字の属性として表現されます。
      パラメータ:
      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の場合、既存の属性が最初に置き換えられる

    • getInputAttributes

      @BeanProperty(bound=false) public MutableAttributeSet getInputAttributes()
      ペインの入力属性を返します。
      戻り値:
      属性

    • getStyledEditorKit

      protected final StyledEditorKit getStyledEditorKit()
      エディタ・キットを返します。
      戻り値:
      エディタ・キット

    • createDefaultEditorKit

      protected EditorKit createDefaultEditorKit()
      デフォルトで使うEditorKitを作成します。 これを実装すると、javax.swing.text.StyledEditorKitが返されます。
      オーバーライド:
      createDefaultEditorKit 、クラス:  JEditorPane
      戻り値:
      エディタ・キット

    • setEditorKit

      public final void setEditorKit​(EditorKit kit)
      コンテンツを処理するために現在インストールされているキットを設定します。 これは、エディタのコンテンツ形式を確定するバウンド・プロパティです。
      オーバーライド:
      setEditorKit 、クラス:  JEditorPane
      パラメータ:
      kit - 望ましいエディタ動作
      例外:
      IllegalArgumentException - キットがStyledEditorKitではない場合
      関連項目:
      JEditorPane.getEditorKit()

    • paramString

      protected String paramString()
      このJTextPaneの文字列表現を返します。 このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なる可能性があります。 返される文字列は空でもかまいませんが、nullにはできません。
      オーバーライド:
      paramString 、クラス:  JEditorPane
      戻り値:
      このJTextPaneの文字列表現