javax.swing
クラス JEditorPane

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.text.JTextComponent
                          |
                          +--javax.swing.JEditorPane

すべての実装インタフェース:

Accessible, ImageObserver, MenuContainer, Scrollable, Serializable

直系の既知のサブクラス:

JTextPane

public class JEditorPane

extends JTextComponent

さまざまな種類のコンテンツを編集するためのテキストコンポーネントです。使用方法およびエディタ区画の例については、「The Java Tutorial」の「Using Text Components」を参照してください。

このコンポーネントは EditorKit の実装を使用して動作します。指定されたコンテンツの種類に対応して適切な種類のテキストエディタになります。ある時点でエディタに設定されるコンテンツタイプは、現在インストールされている EditorKit によって決まります。コンテンツが新しい URL に設定された場合、そのタイプを使って、そのコンテンツをロードするのにどの EditorKit を使用する必要があるかが判定されます。

デフォルトでは、次のコンテンツタイプに対応しています。

text/plain

プレーンテキスト。指定されたタイプが認識できない場合のデフォルトです。この場合に使われるキットは、ラップされたプレーンテキストビューを作成する DefaultEditorKit の拡張です。

text/html

HTML テキスト。この場合に使われるキットは、HTML 3.2 をサポートする javax.swing.text.html.HTMLEditorKit クラスです。

text/rtf

RTF テキスト。この場合に使われるキットは、リッチテキスト形式を制限付きでサポートする javax.swing.text.rtf.RTFEditorKit クラスです。

このコンポーネントには、次のような方法でコンテンツをロードできます。

1. setText メソッドを使うと、文字列からコンポーネントを初期化できます。この場合、現在の EditorKit が使われ、コンテンツタイプはこの EditorKit のタイプであることが要求されます。
2. read メソッドを使うと、リーダからコンポーネントを初期化できます。コンテンツタイプが HTML の場合、<base> タグが使われていないか、または HTMLDocument で Base プロパティが設定されていないと、イメージなどの相対参照を解決できません。この場合、現在の EditorKit が使われ、コンテンツタイプはこの EditorKit のタイプであることが要求されます。
3. setPage メソッドを使うと、URL からコンポーネントを初期化できます。この場合、コンテンツタイプは URL から判断され、そのコンテンツタイプに登録されている EditorKit が設定されます。

標準の Look & Feel (L&F) 表現でこのコンポーネントが使用するキーボードのキーについては、JEditorPane のキーの割り当てを参照してください。

コンテンツによっては、ハイパーリンクイベントを生成することによってハイパーリンクのサポートを提供します。HTML EditorKit は、JEditorPane が編集可能ではない場合、つまり JEditorPane.setEditable(false); が呼び出されている場合にハイパーリンクイベントを生成します。ドキュメントに HTML フレームが埋め込まれている場合、通常は現在のドキュメントの一部が変更されます。次のコードフラグメントは、ハイパーリンクリスナーの実装例です。このコードの場合、HTML フレームイベントには特別な処理を行い、ほかのすべてのアクティブなハイパーリンクは単に表示されるだけです。

     class Hyperactive implements HyperlinkListener {
 
         public void hyperlinkUpdate(HyperlinkEvent e) {
             if (e.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
                 JEditorPane pane = (JEditorPane) e.getSource();
                 if (e instanceof HTMLFrameHyperlinkEvent) {
                     HTMLFrameHyperlinkEvent  evt = (HTMLFrameHyperlinkEvent)e;
                     HTMLDocument doc = (HTMLDocument)pane.getDocument();
                     doc.processHTMLFrameHyperlinkEvent(evt);
                 } else {
                     try {
                         pane.setPage(e.getURL());
                     } catch (Throwable t) {
                         t.printStackTrace();
                     }
                 }
             }
         }
     }

ドキュメント内の文化に依存する情報は、文字エンコーディングと呼ばれる機構によって扱われます。文字エンコーディングとは、文字セットの構成要素 (文字、表意文字、数字、記号、制御文字) と特定の数値コードの明白なマッピングであり、ファイルへの保存方法を表します。文字エンコーディングには、ISO-8859-1、ISO-8859-5、Shift-jis、Euc-jp、UTF-8 などがあります。ファイルは、ユーザエージェント (JEditorPane) に渡されるときに、ドキュメントの文字セット (ISO-10646、別名 Unicode) に変換されます。

JEditorPane で使われる文字セットを指定する方法は複数あります。

1. 1 つの方法は、文字セットを MIME 形式のパラメータとして指定することです。この方法では、setContentType メソッドを呼び出す必要があります。コンテンツが setPage メソッドによってロードされる場合、コンテンツタイプは URL の指定に従って設定されます。ファイルが直接ロードされる場合、コンテンツタイプはロードの前に設定される必要があります。
2. 文字セットを指定するためのもう 1 つの方法は、ドキュメント自体にあります。この場合、目的の文字セットを指定する前にドキュメントを読み込む必要があります。これを処理するためには、EditorKit 読み込みオペレーションによってスローされる ChangedCharSetException をキャッチすることが必要です。次に読み込みは ChangedCharSetException (IOException) において指定された文字セットを使う新しいリーダで再び開始されます。

警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。今後の Swing リリースでは、長期間の持続性をサポートする予定です。

関連項目:

直列化された形式

内部クラスの概要

protected class	JEditorPane.AccessibleJEditorPane このクラスは JEditorPane クラス用のユーザ補助機能のサポートを実装しています。
protected class	JEditorPane.AccessibleJEditorPaneHTML このクラスは AccessibleHypertext のサポートを提供し、JEditorPane にインストールされた EditorKit が HTMLEditorKit のインスタンスである場合のインスタンスで使用されます。
protected class	JEditorPane.JEditorPaneAccessibleHypertextSupport AccessibleJEditorPaneHTML.getAccessibleText によって返されるものを取得します。

クラス javax.swing.text.JTextComponent から継承した内部クラス

JTextComponent.AccessibleJTextComponent, JTextComponent.KeyBinding

クラス javax.swing.JComponent から継承した内部クラス

JComponent.AccessibleJComponent

クラス java.awt.Container から継承した内部クラス

Container.AccessibleAWTContainer

クラス java.awt.Component から継承した内部クラス

Component.AccessibleAWTComponent

クラス javax.swing.text.JTextComponent から継承したフィールド

DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY

クラス javax.swing.JComponent から継承したフィールド

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

クラス java.awt.Component から継承したフィールド

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

インタフェース java.awt.image.ImageObserver から継承したフィールド

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

コンストラクタの概要

JEditorPane()
新しい JEditorPane を作成します。

JEditorPane(String url)
URL 指定を示す文字列を基にして、JEditorPane を作成します。

JEditorPane(String type, String text)
指定されたテキストに初期化されている JEditorPane を作成します。

JEditorPane(URL initialPage)
入力のために指定された URL を基にして、JEditorPane を作成します。

メソッドの概要

void	addHyperlinkListener(HyperlinkListener listener) 変更の通知のためにハイパーリンクリスナーを追加します。
protected EditorKit	createDefaultEditorKit() コンポーネントが初めて作成されたときに、デフォルトのエディタキット (PlainEditorKit) を作成します。
static EditorKit	createEditorKitForContentType(String type) エディタキットのデフォルトのレジストリから、指定されたコンテンツタイプのハンドラを作成します。
void	fireHyperlinkUpdate(HyperlinkEvent e) このタイプのイベントの通知を、登録してあるすべてのリスナーに通知します。
AccessibleContext	getAccessibleContext() この JEditorPane に関連した AccessibleContext を返します。
String	getContentType() このエディタが処理するように現在設定されているコンテンツタイプを返します。
EditorKit	getEditorKit() コンテンツの処理のために現在インストールされているキットを返します。
static String	getEditorKitClassNameForContentType(String type) タイプ type に現在登録されている EditorKit クラス名を返します。
EditorKit	getEditorKitForContentType(String type) 指定されたコンテンツタイプで使用するエディタキットを取り出します。
URL	getPage() 表示されている現在の URL を返します。
Dimension	getPreferredSize() JEditorPane の適切なサイズを返します。
boolean	getScrollableTracksViewportHeight() この Scrollable の高さが必ずビューポートの高さと一致することをビューポートが強制する場合に true を返します。
boolean	getScrollableTracksViewportWidth() ビューポートが常にこの Scrollable の幅を強制的にビューポートの幅に一致させる場合に true を返します。
protected InputStream	getStream(URL page) setPage メソッドによりロードされようとしている指定された URL のストリームを返します。
String	getText() この TextComponent に格納されているテキストをこのエディタのコンテンツタイプで返します。
String	getUIClassID() UI のクラス ID を返します。
boolean	isFocusCycleRoot() JEditorPane をフォーカスサイクルのルートにします。
boolean	isManagingFocus() フォーカスを得たあとにタブトラバーサルをオフに設定します。
protected String	paramString() この JEditorPane の文字列表現を返します。
protected void	processComponentKeyEvent(KeyEvent e) Shift + Tab タブ処理を扱うためにオーバーライドされます。
protected void	processKeyEvent(KeyEvent e) Tab イベントおよび Shift + Tab イベントを使用することにより、awt がフォーカスのトラバースを行わないようにします。
void	read(InputStream in, Object desc) このメソッドは、ストリームから初期化を行います。
static void	registerEditorKitForContentType(String type, String classname) コンテンツタイプと classname のデフォルトのバインディングを作成します。
static void	registerEditorKitForContentType(String type, String classname, ClassLoader loader) type と classname のデフォルトのバインディングを作成します。
void	removeHyperlinkListener(HyperlinkListener listener) ハイパーリンクリスナーを削除します。
void	replaceSelection(String content) 現在選択されているコンテンツを、指定された文字列で表される新しいコンテンツと置き換えます。
protected void	scrollToReference(String reference) 指定された参照位置 (表示されている URL に対する URL.getRef メソッドによって返される値) までビューをスクロールします。
void	setContentType(String type) このエディタが処理するコンテンツタイプを設定します。
void	setEditorKit(EditorKit kit) コンテンツの処理のために現在インストールされているキットを設定します。
void	setEditorKitForContentType(String type, EditorKit k) 指定されたコンテンツタイプで使用できるようにエディタキットを直接設定します。
void	setPage(String url) 表示されている現在の URL を設定します。
void	setPage(URL page) 表示されている現在の URL を設定します。
void	setText(String t) この TextComponent のテキストを指定されたコンテンツ (このエディタのコンテンツタイプでなければならない) に設定します。

クラス javax.swing.text.JTextComponent から継承したメソッド

addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretPosition, getDisabledTextColor, getDocument, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getUI, isEditable, isFocusTraversable, loadKeymap, modelToView, moveCaretPosition, paste, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, select, selectAll, setCaret, setCaretColor, setCaretPosition, setDisabledTextColor, setDocument, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write

クラス javax.swing.JComponent から継承したメソッド

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isLightweightComponent, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processFocusEvent, processKeyBinding, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

クラス java.awt.Container から継承したメソッド

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree

クラス java.awt.Component から継承したメソッド

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

クラス java.lang.Object から継承したメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

JEditorPane

public JEditorPane()

新しい JEditorPane を作成します。ドキュメントモデルは null に設定されます。

JEditorPane

public JEditorPane(URL initialPage)
            throws IOException

入力のために指定された URL を基にして、JEditorPane を作成します。

パラメータ:

initialPage - URL

例外:

IOException - URL が null であるか、アクセスできない場合

JEditorPane

public JEditorPane(String url)
            throws IOException

URL 指定を示す文字列を基にして、JEditorPane を作成します。

パラメータ:

url - URL

例外:

IOException - URL が null であるか、アクセスできない場合

JEditorPane

public JEditorPane(String type,
                   String text)

指定されたテキストに初期化されている JEditorPane を作成します。これは、setContentType メソッドおよび setText メソッドを呼び出す簡易コンストラクタです。

パラメータ:

type - 指定されたテキストの MIME 形式

text - 初期化に使うテキスト

メソッドの詳細

addHyperlinkListener

public void addHyperlinkListener(HyperlinkListener listener)

変更の通知のためにハイパーリンクリスナーを追加します。たとえば、リンクを選択した時、リンクに入った時などがあります。

パラメータ:

listener - リスナー

removeHyperlinkListener

public void removeHyperlinkListener(HyperlinkListener listener)

ハイパーリンクリスナーを削除します。

パラメータ:

listener - リスナー

fireHyperlinkUpdate

public void fireHyperlinkUpdate(HyperlinkEvent e)

このタイプのイベントの通知を、登録してあるすべてのリスナーに通知します。通常は、ハイパーリンクをサポートしているコンテンツタイプが現在アクティブであり、リンクが使用された場合に、現在インストールされている EditorKit によって呼び出されます。リスナーのリストは末尾から先頭への順序で処理されます。

パラメータ:

e - イベント

関連項目:

EventListenerList

setPage

public void setPage(URL page)
             throws IOException

表示されている現在の URL を設定します。区画のコンテンツタイプが設定され、区画のエディタキットが null ではない場合、新しいデフォルトドキュメントが作成され、URL がそのドキュメントに読み込まれます。URL に参照位置が含まれている場合は、scrollToReference メソッドを呼び出すと、その参照位置までスクロールされます。目的の URL が現在表示されていない場合、getStream メソッドが呼び出されて、指定されたストリームに対する制御がサブクラスに渡されます。

このメソッドは、EditorKit によって返されるドキュメントに基づいて同期的または非同期的にロードを行います。ドキュメントが AbstractDocument 型で、AbstractDocument.getAsynchronousLoadPriority によって返された 0 以上の値を持つ場合、そのページはその優先順位により別々のスレッドでロードされます。

ドキュメントが同期的にロードされる場合、そのドキュメントは、setDocument (ドキュメントをエディタに関連付け、プロパティ変更イベントをトリガーする) の呼び出しによって、エディタにインストールされる前にストリームで満たされます。IOException がスローされた場合、部分的にロードされたドキュメントは破棄され、ドキュメントプロパティ変更イベントもページプロパティ変更イベントもトリガーされません。ドキュメントが正常にロードおよびインストールされた場合、UI によってそのドキュメントのビューが作成され (必要な場合はさらにスクロールされ)、ページプロパティ変更イベントがトリガーされます。

ドキュメントが非同期的にロードされる場合、ドキュメントは setDocument (ドキュメントプロパティ変更イベントをトリガーする) の呼び出しを使ってただちにエディタにインストールされ、次に実際のロードを開始するスレッドが生成されます。この場合、ページプロパティ変更イベントはこのメソッドの呼び出しによって直接トリガーされることはなく、ロードを実行するスレッドが終了したときにトリガーされます。呼び出し側のスレッドはもう一方のスレッドでエラーが発生した場合に IOException をスローできないので、ロードが成功したかどうかに関係なく、ページプロパティ変更イベントはもう一方のスレッドが終了したときにトリガーされます。

パラメータ:

page - ページの URL

例外:

IOException - null または無効なページが指定された場合、あるいは読み込み中のストリームから例外が発生した場合

関連項目:

getPage()

read

public void read(InputStream in,
                 Object desc)
          throws IOException

このメソッドは、ストリームから初期化を行います。キットが HTMLEditorKit 型に設定されている場合、desc パラメータが HTMLDocument のときは、このメソッドは HTMLEditorKit を呼び出すことにより読み込みを開始します。そうでない場合は、プレーンテキストとしてモデルをロードするスーパークラスメソッドを呼び出します。

パラメータ:

in - 読み込み元のストリーム

desc - ストリームを記述するオブジェクト

例外:

IOException - 初期化に使われるストリームによってスローされる

関連項目:

JTextComponent.read(java.io.Reader, java.lang.Object), JTextComponent.setDocument(javax.swing.text.Document)

getStream

protected InputStream getStream(URL page)
                         throws IOException

setPage メソッドによりロードされようとしている指定された URL のストリームを返します。デフォルトでは、このメソッドは単に URL をオープンし、ストリームを返します。このメソッドを実装し直すと、キャッシュからのストリームの取り出し、ストリームの進捗状況の監視などの便利な機能を実行できます。

このメソッドは、コンテンツタイプを確立し、その結果としてストリームのロードに使う適切な EditorKit を設定すると考えられます。

このストリームが http 接続の場合、続いてリダイレクトが行われ、その結果 URL は相対 URL を適切に解決できるように Document.StreamDescriptionProperty として設定されます。

パラメータ:

page - ページの URL

scrollToReference

protected void scrollToReference(String reference)

指定された参照位置 (表示されている URL に対する URL.getRef メソッドによって返される値) までビューをスクロールします。デフォルトでは、このメソッドは HTMLDocument 内での参照位置を認識しているだけです。実際のスクロール処理を実行するには、実装により scrollRectToVisible メソッドを呼び出します。HTML 以外のドキュメント形式で参照位置へのスクロールが必要な場合は、このメソッドを再実装する必要があります。このメソッドは、コンポーネントが可視状態でない場合は無効です。

パラメータ:

reference - スクロール先となる指定された位置

getPage

public URL getPage()

表示されている現在の URL を返します。このドキュメントの作成で URL が指定されなかった場合は、null を返し、相対 URL は解決されません。

戻り値:

URL または指定されていない場合は、null

setPage

public void setPage(String url)
             throws IOException

表示されている現在の URL を設定します。

パラメータ:

url - 表示用の URL

例外:

IOException - null または無効な URL 指定の場合

getUIClassID

public String getUIClassID()

UI のクラス ID を返します。

オーバーライド:

クラス JComponent 内の getUIClassID

戻り値:

文字列 「EditorPaneUI」

関連項目:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

createDefaultEditorKit

protected EditorKit createDefaultEditorKit()

コンポーネントが初めて作成されたときに、デフォルトのエディタキット (PlainEditorKit) を作成します。

戻り値:

エディタキット

getEditorKit

public EditorKit getEditorKit()

コンテンツの処理のために現在インストールされているキットを返します。必要な場合は、デフォルトのエディタキットのセットアップのために createDefaultEditorKit が呼び出されます。

戻り値:

エディタキット

getContentType

public final String getContentType()

このエディタが処理するように現在設定されているコンテンツタイプを返します。これは、現在インストールされている EditorKit に関連したタイプになるように定義されています。

戻り値:

コンテンツタイプ。エディタキットが設定されていない場合は null

setContentType

public final void setContentType(String type)

このエディタが処理するコンテンツタイプを設定します。このメソッドは getEditorKitForContentType を呼び出し、エディタキットが正しく検出できたら setEditorKit を呼び出します。このメソッドは、setEditorKit の直接呼び出しの代わりに使用できる、簡易メソッドといえるものです。

コンテンツタイプ指定のパラメータとして文字セットの定義が指定されている場合、関連した EditorKit を使って入力ストリームをロードするときは、その文字セットが使われます。たとえば、タイプが text/html; charset=EUC-JP として指定されている場合、コンテンツは、text/html に登録されている EditorKit を使ってロードされ、ドキュメントに Unicode をロードするために EditorKit に提供されるリーダは、Unicode に変換するために EUC-JP 文字セットを使います。

パラメータ:

type - コンテンツを編集するための null ではない MIME 形式

関連項目:

getContentType()

setEditorKit

public void setEditorKit(EditorKit kit)

コンテンツの処理のために現在インストールされているキットを設定します。これは、エディタのコンテンツタイプを設定するバウンドプロパティです。最初に以前のキットを削除し、キットが null ではない場合、新しいキットがインストールされ、デフォルトドキュメントが作成されます。setEditorKit が呼び出されると、常に PropertyChange イベント ("editorKit") がトリガーされます。

注: EditorKit は特定のタイプのコンテンツをモデル化するソースであるため、モデルを変更するという副作用があります。このメソッドを使用すると、内部状態の完全性を保証するために、呼び出し側に代わり setDocument が呼び出されます。

パラメータ:

kit - 望ましいエディタ動作

関連項目:

getEditorKit()

getEditorKitForContentType

public EditorKit getEditorKitForContentType(String type)

指定されたコンテンツタイプで使用するエディタキットを取り出します。このメソッドは、現在インストールされているコンテンツタイプに一致しないタイプが要求されたときに呼び出されます。コンポーネントに、指定されたタイプに対して登録されている EditorKit がない場合は、デフォルトの EditorKit レジストリから EditorKit の作成を試みます。作成できなかった場合は、すべてのテキストドキュメントがプレーンテキストとして表示できると仮定して、PlainEditorKit が使用されます。

このメソッドは、他種のコンテンツタイプレジストリを使用するための再実装が行えます。このメソッドを再実装すれば、たとえば Java Activation Framework を使用できるようになります。

パラメータ:

type - null ではないコンテンツタイプ

戻り値:

エディタキット

setEditorKitForContentType

public void setEditorKitForContentType(String type,
                                       EditorKit k)

指定されたコンテンツタイプで使用できるようにエディタキットを直接設定します。Look & Feel の実装は、このメソッドを createEditorKitForContentType とともに使用して、Look & Feel を考慮したコンテンツタイプのハンドラをインストールすることがあります。

パラメータ:

type - null ではないコンテンツタイプ

k - 設定されるエディタキット

replaceSelection

public void replaceSelection(String content)

現在選択されているコンテンツを、指定された文字列で表される新しいコンテンツと置き換えます。選択領域がない場合、これは指定されたテキストの挿入に相当します。置き換えるテキストがない場合 (コンテンツ文字列が空、または null の場合)、これは現在の選択領域の削除に相当します。置換後のテキストには、入力用に現在定義されている属性が設定されます。コンポーネントが編集できない状態であれば、ビープ音が鳴って復帰します。

このメソッドはスレッドに対して安全ですが、ほとんどの Swing メソッドは違います。詳細は、「Threads and Swing」を参照してください。

オーバーライド:

クラス JTextComponent 内の replaceSelection

パラメータ:

content - 選択領域と置き換えるコンテンツ。null も可

createEditorKitForContentType

public static EditorKit createEditorKitForContentType(String type)

エディタキットのデフォルトのレジストリから、指定されたコンテンツタイプのハンドラを作成します。レジストリは必要に応じて作成されます。登録されているクラスがまだロードされていない場合は、指定されたタイプ用のエディタキットのプロトタイプを動的にロードしようとします。タイプが ClassLoader とともに登録されていた場合は、その ClassLoader を使ってプロトタイプがロードされます。登録されている ClassLoader がなかった場合は、Class.forName を使ってプロトタイプがロードされます。

プロトタイプ EditorKit のインスタンスが正しく検出されたら、複製され、その複製が返されます。

パラメータ:

type - コンテンツタイプ

戻り値:

エディタキット。指定されたタイプに何も登録されていない場合は null

registerEditorKitForContentType

public static void registerEditorKitForContentType(String type,
                                                   String classname)

コンテンツタイプと classname のデフォルトのバインディングを作成します。クラスは、あとで実際に必要になったときに動的にロードされ、実際の使用の前に安全に変更できるので、不必要なクラスのロードを避けることができます。プロトタイプ EditorKit は、このメソッドで登録されたときに、Class.forName でロードされます。

パラメータ:

type - null ではないコンテンツタイプ

classname - あとでロードするクラス

registerEditorKitForContentType

public static void registerEditorKitForContentType(String type,
                                                   String classname,
                                                   ClassLoader loader)

type と classname のデフォルトのバインディングを作成します。クラスは、あとで実際に必要になったときに指定された ClassLoader を使って動的にロードされ、実際の使用の前に安全に変更できるので、不必要なクラスのロードを避けることができます。

パラメータ:

type - null ではないコンテンツタイプ

classname - あとでロードするクラス

loader - 名前をロードするための ClassLoader

getEditorKitClassNameForContentType

public static String getEditorKitClassNameForContentType(String type)

タイプ type に現在登録されている EditorKit クラス名を返します。

パラメータ:

type - null ではないコンテンツタイプ

導入されたバージョン:

1.3

getPreferredSize

public Dimension getPreferredSize()

JEditorPane の適切なサイズを返します。JEditorPane の適切なサイズはスーパークラスの適切なサイズと少し異なります。ビューポートのサイズがコンポーネントの最小サイズより小さくなった場合、幅または高さをトラックするための scrollable 定義が false に変わります。デフォルトのビューポートレイアウトは適切なサイズを返しますが、このサイズは scrollable がトラックしている場合には適切ではありません。その場合、通常の適切なサイズが最小サイズにあわせて調整されます。これにより、HTML テーブルなどは最小サイズに縮小され、そのサイズで配置されます。最小サイズより小さくなることはありません。

オーバーライド:

クラス JComponent 内の getPreferredSize

戻り値:

適切なサイズを保持する Dimension

isManagingFocus

public boolean isManagingFocus()

フォーカスを得たあとにタブトラバーサルをオフに設定します。

オーバーライド:

クラス JComponent 内の isManagingFocus

戻り値:

フォーカスが使用中であることを示す場合は true を返し、それ以外の場合は false を返します。

isFocusCycleRoot

public boolean isFocusCycleRoot()

JEditorPane をフォーカスサイクルのルートにします。つまり、デフォルトでは、エディタ区画内でのタブ移動は、フォームコントロールのようにその区画のコンポーネント間を移動しますが、区画の外には移動しません。

このメソッドは常に true を返します。

オーバーライド:

クラス JComponent 内の isFocusCycleRoot

戻り値:

true

関連項目:

JComponent.isFocusCycleRoot()

processComponentKeyEvent

protected void processComponentKeyEvent(KeyEvent e)

Shift + Tab タブ処理を扱うためにオーバーライドされます。e がタブを識別し、エディタ区画が編集不可でコンポーネントがある場合は、FocusManager は次または前のコンポーネントにフォーカスを渡すよう促されます。

オーバーライド:

クラス JComponent 内の processComponentKeyEvent

パラメータ:

e - 現在のキーイベント

processKeyEvent

protected void processKeyEvent(KeyEvent e)

Tab イベントおよび Shift + Tab イベントを使用することにより、awt がフォーカスのトラバースを行わないようにします。

オーバーライド:

クラス JComponent 内の processKeyEvent

パラメータ:

e - 現在のキーイベント

setText

public void setText(String t)

この TextComponent のテキストを指定されたコンテンツ (このエディタのコンテンツタイプでなければならない) に設定します。たとえば、タイプが text/html に設定されている場合、文字列は HTML の形式で指定されます。

現在のドキュメントのコンテンツを削除し、現在の EditorKit を使用して指定された文字列を解析してコンテンツを置き換えるように実装されます。これにより、コンポーネントに現在設定されているコンテンツタイプをサポートしながら、モデルを変更しないでスーパークラスのセマンティクスが指定されます。前のコンテンツが比較的小さく、副作用がないことが前提になります。この前提がどちらも守られず予期しない結果を生じることがあります。これを避けるために、新しいドキュメント getEditorKit().createDefaultDocument() を作成して、既存の Document を新しいものに置き換えます。これで前の Document が中途半端な状態になることはありません。

1. 既存のモデルを使用可能のままにしておくと、古いビューがティアダウンされて新しいビューが作成されます。これに対して、ドキュメントを置き換えると古いビューのティアダウンが避けられます。
2. HTML などのいくつかの形式は、将来のコンテンツに影響をあたえるドキュメントにコンテンツをインストールできます。HTML 形式の場合は、スタイル情報を埋め込んで、次のコンテンツが予期せずインストールされたときに影響を与えるようにできます。

文字列と一緒にコンポーネントをロードするもう 1 つ方法は、StringReader を生成して読み込みメソッドを呼び出すというものです。この方法の場合、モデルは初期化が完了すると文字列のコンテンツに置き換えられます。

このメソッドはスレッドに対して安全ですが、ほとんどの Swing メソッドは違います。詳細は、「Threads and Swing」を参照してください。

オーバーライド:

クラス JTextComponent 内の setText

パラメータ:

t - 設定する新しいテキスト

関連項目:

getText()

getText

public String getText()

この TextComponent に格納されているテキストをこのエディタのコンテンツタイプで返します。テキストの取得時に例外がスローされた場合は、null が返されます。このメソッドを実装すると、StringWriter で JTextComponent.write を呼び出すことができます。

オーバーライド:

クラス JTextComponent 内の getText

戻り値:

テキスト

関連項目:

setText(java.lang.String)

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

ビューポートが常にこの Scrollable の幅を強制的にビューポートの幅に一致させる場合に true を返します。

オーバーライド:

クラス JTextComponent 内の getScrollableTracksViewportWidth

戻り値:

ビューポートが Scrollable の幅を強制的にそれ自体に一致させる場合は true を返し、それ以外の場合は false を返します。

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

この Scrollable の高さが必ずビューポートの高さと一致することをビューポートが強制する場合に true を返します。

オーバーライド:

クラス JTextComponent 内の getScrollableTracksViewportHeight

戻り値:

ビューポートが Scrollable の高さを強制的にそれ自体に一致させる場合は true を返し、それ以外の場合は false を返します。

paramString

protected String paramString()

この JEditorPane の文字列表現を返します。このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なります。返される文字列は空の場合がありますが、null にはなりません。

オーバーライド:

クラス JTextComponent 内の paramString

戻り値:

この JEditorPane の文字列表現

getAccessibleContext

public AccessibleContext getAccessibleContext()

この JEditorPane に関連した AccessibleContext を返します。エディタ区画の場合、AccessibleContext は AccessibleJEditorPane の形式を取ります。必要に応じて新規の AccessibleJEditorPane インスタンスが作成されます。

オーバーライド:

クラス JTextComponent 内の getAccessibleContext

戻り値:

この JEditorPane の AccessibleContext として機能する AccessibleJEditorPane