|
JavaTM 2 Platform Std. Ed. v1.4.0 |
||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | ||||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | ||||||||||
java.lang.Object
|
+--java.awt.Component
|
+--java.awt.Container
|
+--javax.swing.JComponent
|
+--javax.swing.text.JTextComponent
|
+--javax.swing.JEditorPane
さまざまな種類のコンテンツを編集するためのテキストコンポーネントです。使用方法およびエディタ区画の例については、「The Java Tutorial」の「Using Text Components」を参照してください。
このコンポーネントは EditorKit の実装を使用して動作します。指定されたコンテンツの種類に対応して適切な種類のテキストエディタとして動作します。ある時点でエディタに設定されるコンテンツタイプは、現在インストールされている EditorKit によって決まります。コンテンツが新しい URL に設定された場合、そのタイプを使って、そのコンテンツをロードするのにどの EditorKit を使用する必要があるかが判定されます。
デフォルトでは、次のコンテンツタイプに対応しています。
DefaultEditorKit の拡張
javax.swing.text.html.HTMLEditorKit クラス
javax.swing.text.rtf.RTFEditorKit クラス
このコンポーネントには、次のような方法でコンテンツをロードできます。
EditorKit が使われ、コンテンツタイプはこの EditorKit のタイプであることが要求される
Reader からコンポーネントを初期化できる。コンテンツタイプが HTML の場合、<base> タグが使われていないか、または HTMLDocument で Base プロパティが設定されていないと、イメージなどの相対参照を解決ができない。この場合、現在の EditorKit が使われ、コンテンツタイプはこの EditorKit のタイプであることが要求される
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 で使われる文字セットを指定する方法は複数あります。
EditorKit 読み込みオペレーションによってスローされる ChangedCharSetException をキャッチする必要がある。読み込み自体は ChangedCharSetException (IOException) で指定された文字セットを使う新しいリーダで再び開始される
警告:
このクラスの直列化オブジェクトは今後リリースされる Swing との互換性はありません。現在サポートされている直列化は、短期間の保管、または同じバージョンの Swing が稼働しているアプリケーション間の RMI に適しています。1.4 からは、すべての JavaBeansTM の長期間の保管が java.beans パッケージで追加サポートされています。XMLEncoder を参照してください。
| 入れ子クラスの概要 | |
protected class |
JEditorPane.AccessibleJEditorPane
このクラスは JEditorPane クラス用のユーザ補助機能のサポートを実装しています。 |
protected class |
JEditorPane.AccessibleJEditorPaneHTML
このクラスは AccessibleHypertext のサポートを提供し、JEditorPane にインストールされた EditorKit が HTMLEditorKit のインスタンスである場合に、そのインスタンスで使用されます。
|
protected class |
JEditorPane.JEditorPaneAccessibleHypertextSupport
AccessibleJEditorPaneHTML.getAccessibleText が返す値により、この JEditorPane に表示されている HTML ドキュメントがある場合は、AccessibleHypertext のサポートが可能になります。 |
| クラス javax.swing.text.JTextComponent から継承した入れ子クラス |
JTextComponent.KeyBinding |
| クラス javax.swing.JComponent から継承した入れ子クラス |
|
| クラス java.awt.Container から継承した入れ子クラス |
|
| クラス java.awt.Component から継承した入れ子クラス |
Component.BltBufferStrategy, Component.FlipBufferStrategy |
| フィールドの概要 |
| クラス 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)
指定されたコンテンツタイプで使用するエディタキットを取り出します。 |
HyperlinkListener[] |
getHyperlinkListeners()
addHyperlinkListener() を使用して、この JEditorPane に追加されたすべての HyperLinkListener の配列を返します。 |
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 を返します。 |
protected String |
paramString()
この JEditorPane の文字列表現を返します。 |
void |
read(InputStream in,
Object desc)
このメソッドは、ストリームから初期化を行います。 |
static void |
registerEditorKitForContentType(String type,
String classname)
typeと classname のデフォルトのバインディングを作成します。 |
static void |
registerEditorKitForContentType(String type,
String classname,
ClassLoader loader)
type と classname のデフォルトのバインディングを作成します。 |
void |
removeHyperlinkListener(HyperlinkListener listener)
ハイパーリンクリスナーを削除します。 |
void |
replaceSelection(String content)
現在選択されているコンテンツを、指定された文字列で表される新しいコンテンツと置き換えます。 |
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 のテキストを、指定されたコンテンツに設定します。 |
| クラス java.lang.Object から継承したメソッド |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| コンストラクタの詳細 |
public JEditorPane()
JEditorPane を生成します。ドキュメントモデルは null に設定されます。
public JEditorPane(URL initialPage)
throws IOException
JEditorPane を生成します。
initialPage - URL
IOException - URL が null であるか、アクセスできない場合
public JEditorPane(String url)
throws IOException
JEditorPane を生成します。
url - URL
IOException - URL が null であるか、アクセスできない場合
public JEditorPane(String type,
String text)
JEditorPane を生成します。これは、setContentType メソッドおよび setText メソッドを呼び出す簡易コンストラクタです。
type - 指定されたテキストの MIME 形式text - 初期化に使うテキスト
NullPointerException - type パラメータが null の場合| メソッドの詳細 |
public void addHyperlinkListener(HyperlinkListener listener)
listener - リスナーpublic void removeHyperlinkListener(HyperlinkListener listener)
listener - リスナーpublic HyperlinkListener[] getHyperlinkListeners()
HyperLinkListener の配列を返します。
HyperLinkListener。リスナーが追加されていない場合は空の配列public void fireHyperlinkUpdate(HyperlinkEvent e)
EditorKit によって呼び出されます。リスナーのリストは末尾から先頭への順序で処理されます。
e - イベントEventListenerList
public void setPage(URL page)
throws IOException
null ではない場合、新しいデフォルトドキュメントが生成され、URL がそのドキュメントに読み込まれます。URL に参照位置が含まれている場合は、scrollToReference メソッドを呼び出すと、その参照位置までスクロールされます。目的の URL が現在表示されていない場合、getStream メソッドが呼び出され、指定されたストリームに対する制御がサブクラスに渡されます。
このメソッドは、EditorKit によって返されるドキュメントに基づいて同期的または非同期的にロードを行います。ドキュメントが AbstractDocument 型で、AbstractDocument.getAsynchronousLoadPriority によって返されたゼロ以上の値を持つ場合、そのページはその優先順位により別々のスレッドでロードされます。
ドキュメントが同期的にロードされる場合、ドキュメントをプロパティ変更イベントに関連付け、トリガする setDocument が呼び出され、エディタにインストールされる前にこのドキュメントにストリームが設定されます。IOException がスローされる場合、部分的にロードされたドキュメントは破棄され、ドキュメントプロパティ変更イベントもページプロパティ変更イベントもトリガされません。ドキュメントが正常にロードおよびインストールされた場合、UI によってそのドキュメントのビューが生成され、必要な場合はさらにスクロールされて、ページプロパティ変更イベントがトリガされます。
ドキュメントが非同期的にロードされる場合、ドキュメントプロパティ変更イベントをトリガする setDocument を呼び出してドキュメントがただちにエディタにインストールされ、次に実際のロードを開始するスレッドが生成されます。この場合、ページプロパティ変更イベントはこのメソッドの呼び出しによって直接トリガされることはなく、ロードを実行するスレッドが終了したときにトリガされます。呼び出し側のスレッドは、もう一方のスレッドでエラーが発生した場合に IOException をスローできないので、ロードが成功したかどうかに関係なく、ページプロパティ変更イベントはもう一方のスレッドが終了したときにトリガされます。
page - ページの URL
IOException - null または無効なページが指定された場合、あるいは読み込み中のストリームから例外が発生した場合getPage()
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)
protected InputStream getStream(URL page)
throws IOException
setPage メソッドによりロードされようとしている、指定された URL のストリームを返します。デフォルトでは、このメソッドは単に URL をオープンし、ストリームを返します。このメソッドを実装し直すと、キャッシュからのストリームの取り出し、ストリームの進捗状況の監視などの便利な機能を実行できます。
このメソッドは、コンテンツタイプを確立し、その結果としてストリームのロードに使う適切な EditorKit を設定すると考えられます。
このストリームが http 接続の場合、続いてリダイレクトが行われ、その結果得られる URL が、相対 URL を適切に解決できるように Document.StreamDescriptionProperty として設定されます。
page - ページの URL
IOExceptionpublic void scrollToReference(String reference)
URL.getRef メソッドによって返される値) までビューをスクロールします。デフォルトでは、このメソッドは HTMLDocument 内での参照位置を認識しているだけです。実際のスクロール処理を実行するには、実装により scrollRectToVisible メソッドを呼び出します。HTML 以外のドキュメント形式で参照位置へのスクロールが必要な場合は、このメソッドを再実装する必要があります。このメソッドは、コンポーネントが可視状態でない場合は無効です。
reference - スクロール先となる指定された位置public URL getPage()
null を返し、相対 URL は解決されません。
null
public void setPage(String url)
throws IOException
url - 表示されている URL
IOException - null または無効な URL 指定の場合public String getUIClassID()
JComponent 内の getUIClassIDJComponent.getUIClassID(),
UIDefaults.getUI(javax.swing.JComponent)protected EditorKit createDefaultEditorKit()
PlainEditorKit) を生成します。
public EditorKit getEditorKit()
createDefaultEditorKit が呼び出されます。
public final String getContentType()
EditorKit に関連したタイプになるように定義されています。
nullpublic final void setContentType(String type)
getEditorKitForContentType を呼び出し、エディタキットが正しく検出できたら setEditorKit を呼び出します。このメソッドは、setEditorKit の直接呼び出しの代わりに使用できる、簡易メソッドとほぼ同じです。
コンテンツタイプ指定のパラメータとして文字セットの定義が指定されている場合、関連付けられた EditorKit を使って入力ストリームをロードするときは、その文字セットが使われます。たとえば、タイプが text/html; charset=EUC-JP として指定されている場合、コンテンツは、text/html に登録されている EditorKit を使ってロードされ、ドキュメントに Unicode をロードするために EditorKit に提供されるリーダは、Unicode への変換のために EUC-JP 文字セットを使います。タイプが識別できない場合は、コンテンツはプレーンテキスト text/plain に登録された EditorKit を使ってロードされます。
type - コンテンツを編集するための MIME タイプ。null 以外を指定getContentType()public void setEditorKit(EditorKit kit)
null ではない場合、新しいキットがインストールされ、デフォルトドキュメントが生成されます。setEditorKit が呼び出されると、常に PropertyChange イベント (editorKit) がトリガされます。
注: EditorKit は特定のタイプのコンテンツをモデル化するソースであるため、モデルを変更するという副作用があります。このメソッドを使用すると、内部状態の完全性を保証するために、呼び出し側に代わり setDocument が呼び出されます。
kit - 望ましいエディタ動作getEditorKit()public EditorKit getEditorKitForContentType(String type)
EditorKit がない場合は、デフォルトの EditorKit レジストリから EditorKit の生成を試みます。生成できなかった場合は、すべてのテキストドキュメントをプレーンテキストとして表示できるものと仮定し、PlainEditorKit が使用されます。
このメソッドは、他種のコンテンツタイプレジストリを使用するために再実装できます。このメソッドを再実装すれば、たとえば Java Activation Framework を使用できるようになります。
type - null ではないコンテンツタイプ
public void setEditorKitForContentType(String type,
EditorKit k)
createEditorKitForContentType とともに使用して、Look & Feel (L&F) を考慮したコンテンツタイプのハンドラをインストールすることがあります。
type - null ではないコンテンツタイプk - 設定するエディタキットpublic void replaceSelection(String content)
null の場合は、現在の選択領域の削除を行います。置換後のテキストには、入力用に現在定義されている属性が設定されます。コンポーネントが編集できない状態であれば、ビープ音を鳴らして終了します。
このメソッドはスレッドに対して安全ですが、ほとんどの Swing メソッドは安全ではありません。詳細は、「Threads and Swing」を参照してください。
JTextComponent 内の replaceSelectioncontent - 選択領域と置き換えるコンテンツ。null も可public static EditorKit createEditorKitForContentType(String type)
ClassLoader とともに登録されていた場合は、その ClassLoader を使ってプロトタイプがロードされます。登録されている ClassLoader がなかった場合は、Class.forName を使ってプロトタイプがロードされます。
プロトタイプ EditorKit のインスタンスが正しく検出されると、そのインスタンスが複製され、その複製が返されます。
type - コンテンツタイプ
null
public static void registerEditorKitForContentType(String type,
String classname)
typeと classname のデフォルトのバインディングを作成します。クラスは、あとで実際に必要になったときに動的にロードされ、実際の使用の前に安全に変更できるので、不必要なクラスのロードを避けることができます。プロトタイプ EditorKit は、このメソッドで登録されたときに、Class.forName でロードされます。
type - null ではないコンテンツタイプclassname - あとでロードするクラス
public static void registerEditorKitForContentType(String type,
String classname,
ClassLoader loader)
type と classname のデフォルトのバインディングを作成します。クラスは、あとで実際に必要になったときに、指定された ClassLoader を使って動的にロードされ、実際の使用の前に安全に変更できるため、不要なクラスのロードを避けることができます。
type - null ではないコンテンツタイプclassname - あとでロードするクラスloader - 名前をロードするための ClassLoaderpublic static String getEditorKitClassNameForContentType(String type)
type に現在登録されている EditorKit クラス名を返します。
type - null ではないコンテンツタイプ- 導入されたバージョン:
- 1.3
public Dimension getPreferredSize()
JEditorPane の適切なサイズを返します。JEditorPane の適切なサイズはスーパークラスの適切なサイズとわずかに異なります。ビューポートのサイズがコンポーネントの最小サイズより小さくなった場合、幅または高さをトラックするための scrollable 定義が false に変わります。デフォルトのビューポートレイアウトは適切なサイズを返しますが、このサイズは scrollable がトラッキングしている場合には適切ではありません。その場合、「通常の」適切なサイズが最小サイズにあわせて調整されます。これにより、HTML テーブルなどは最小サイズに縮小され、そのサイズで配置されます。最小サイズより小さくなることはありません。
JComponent 内の getPreferredSizeDimensionJComponent.setPreferredSize(java.awt.Dimension),
ComponentUIpublic void setText(String t)
TextComponent のテキストを、指定されたコンテンツに設定します。設定されるコンテンツはこのエディタのコンテンツタイプとなる必要があります。たとえば、タイプが text/html に設定されている場合、文字列は HTML の形式で指定されます。
現在のドキュメントのコンテンツを削除し、現在の EditorKit を使用して指定された文字列を解析してコンテンツを置き換えるように実装されます。これにより、コンポーネントに現在設定されているコンテンツタイプをサポートしながら、モデルを変更しないでスーパークラスのセマンティクスが指定されます。前のコンテンツが比較的小さく、副作用がないことが前提になります。この前提がどちらも守られない場合、予期しない結果を生じることがあります。これを避けるために、新しいドキュメント getEditorKit().createDefaultDocument() を生成して、既存のDocument を新しいものに置き換えます。これで前の Document が中途半端な状態になることはありません。
文字列と一緒にコンポーネントをロードするもう 1 つの方法には、StringReader を生成して読み込みメソッドを呼び出すものがあります。この方法の場合、モデルは初期化が完了すると文字列のコンテンツに置き換えられます。
このメソッドはスレッドに対して安全ですが、ほとんどの Swing メソッドは安全ではありません。詳細は、「Threads and Swing」を参照してください。
JTextComponent 内の setTextt - 設定する新しいテキストgetText()public String getText()
TextComponent に格納されているテキストをこのエディタのコンテンツタイプで返します。テキストの取得時に例外がスローされた場合は、null が返されます。このメソッドを実装すると、StringWriter で JTextComponent.write を呼び出すことができます。
JTextComponent 内の getTextsetText(java.lang.String)public boolean getScrollableTracksViewportWidth()
Scrollable の幅を強制的にビューポートの幅に一致させる場合に true を返します。
Scrollable 内の getScrollableTracksViewportWidthJTextComponent 内の getScrollableTracksViewportWidthpublic boolean getScrollableTracksViewportHeight()
Scrollable の高さを強制的にビューポートの高さと一致させる場合に true を返します。
Scrollable 内の getScrollableTracksViewportHeightJTextComponent 内の getScrollableTracksViewportHeightScrollable の高さをそれ自体の高さと強制的に一致させる場合は true、それ以外の場合は falseprotected String paramString()
JEditorPane の文字列表現を返します。このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なります。返される文字列は空の場合がありますが、null にはなりません。
JTextComponent 内の paramStringJEditorPane の文字列表現public AccessibleContext getAccessibleContext()
Accessible 内の getAccessibleContextJTextComponent 内の getAccessibleContext
|
JavaTM 2 Platform Std. Ed. v1.4.0 |
||||||||||
| 前のクラス 次のクラス | フレームあり フレームなし | ||||||||||
| 概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド | ||||||||||
Java、Java 2D、および JDBC は米国ならびにその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.