javax.swing.text
クラス JTextComponent

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.text.JTextComponent

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

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable

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

JEditorPane, JTextArea, JTextField

public abstract class JTextComponent
extends JComponent
implements Scrollable, Accessible

JTextComponent は、Swing テキストコンポーネントの基底クラスです。java.awt.TextComponent クラスとある程度の互換性があります。また、ほかのサービスも提供されており、プラグイン可能な UI や Bean のサポート以外の柔軟性もあります。このクラスが提供する機能の使い方については、「The Java Tutorial」の「General Rules for Using Text Components」を参照してください。

キャレット変更

キャレットは、Swing テキストコンポーネント内のプラグイン可能なオブジェクトです。キャレット位置と選択領域の変更通知は、テキストコンポーネントに登録済みの CaretListener インタフェースの実装に送られます。UI は、カスタマイズしたキャレットが設定済みでないかぎりデフォルトのキャレットをインストールします。
デフォルトでは、キャレットは、イベントディスパッチスレッド上でのすべてのドキュメントの変更を追跡し、キャレットの前 (キャレット位置) への挿入または削除が行われた場合は、それにしたがって位置を更新します。DefaultCaret は、自身を表示しようとします。このため、JScrollPane 内でテキストコンポーネントがスクロールされることがあります。キャレットのデフォルトの動作を変更するには、DefaultCaret.setUpdatePolicy(int) メソッドを使用します。
注 -編集不能なテキストコンポーネントはペイントされない場合もありますが、キャレットは存在します。

コマンド

テキストコンポーネントは、コンポーネントを操作するのに使うコマンドを提供します。これは本質的に、コンポーネントがその機能を表現する方法です。これらは TextAction の実装を使用して、swing Action インタフェースの形で表現されます。テキストコンポーネントがサポートするコマンドセットは、getActions() メソッドで確認できます。こうしたアクションは、ボタンなどから発生するキーイベントに割り当てられます。

テキスト入力

テキストコンポーネントは、キーマップとインプットメソッドのフレームワークを使用して柔軟で国際化されたテキスト入力をサポートしています。また、AWT リスナーモデルとの互換性も備えています。

Keymap で、アプリケーションを使用してキーストロークをアクションにバインドできます。キーマップを複数のテキストコンポーネントで共有するために、TextAction を拡張するアクションを使用できます。TextAction は、どの JTextComponent がフォーカスを持っていて、アクションの対象 (アクションに送られた ActionEvent がターゲットテキストコンポーネントをソースとして含んでいない場合) であるかを判定できます。

インプットメソッドのフレームワーク で、テキストコンポーネントをインプットメソッドと結び付けることができます。このインプットメソッドは、キーのかなり少ないキーボードを使用して何千もの異なる文字をユーザーが入力できるようにするイベントを前処理する個々のソフトウェアコンポーネントです。JTextComponent は、フレームワークの「アクティブクライアント」であるため、インプットメソッドとやりとりするための適切なユーザーインタフェースを実装します。結果的に、キーイベントの中にはインプットメソッドにより処理されるため、テキストコンポーネントに到達しないものがあります。 また、テキスト入力の中には、キーイベントとしてではなく InputMethodEvent の中の確定テキストとして、テキストコンポーネントに到達するものもあります。完全なテキスト入力とは、keyTyped キーイベントの文字と、インプットメソッドイベントの確定テキストとの組み合わせです。

AWT リスナーモデルで、アプリケーションを使用してイベントをアクションにバインドするためにイベントリスナーをコンポーネントと結び付けることができます。Swing では、リスナーではなくキーマップを使用することを推奨していますが、イベントを消費することによりそのイベントを横取りする機会をリスナーに与えることによってリスナーとの互換性を維持しています。

キーボードイベントとインプットメソッドイベントは、次の工程で処理されます。

工程	KeyEvent	InputMethodEvent
1.	インプットメソッド	(ここで生成される)
2.	フォーカスマネージャー
3.	登録済みのキーリスナー	登録済みのインプットメソッドリスナー
4.		JTextComponent で処理するインプットメソッド
5.	現在のキーマップを使用して処理するキーマップ
6.	JComponent で処理するキーボード (アクセラレータ、コンポーネントナビゲーションなど)

キーイベントには待機しているが、インプットメソッドイベントは認識しないアプリケーションとの互換性を保つため、工程 4 で処理するインプットメソッドは、インプットメソッドを処理しないコンポーネントのための互換性を提供しています。これらのコンポーネントでは、確定テキストは keyTyped キーイベントに変換され、インプットメソッドのイベントパイプラインではなく、工程 3 で開始されるキーイベントパイプラインで処理されます。

コンポーネントはデフォルトで、すべての JTextComponent のインスタンスによってデフォルトキーマップとして共有されるキーマップ (DEFAULT_KEYMAP) を作成します。)一般的に、Look & Feel の実装は、デフォルトのキーマップに解決する別のキーマップをインストールして、デフォルトのキーマップを、別のキーマップにはないキー割り当てに対応させます。次に、最小の割り当てを示します。

• エディタにプリント可能キーのコンテンツを挿入する
• バックスペースキーと Del キーでコンテンツを削除する
• 順方向と逆方向のキャレット移動

モデル/ビュー分割

テキストコンポーネントはモデル/ビュー分割を持ちます。テキストコンポーネントは、モデル、ビュー、コントローラを表すのに使うオブジェクトをまとめます。テキストドキュメントモデルは、モデルのオブザーバとして動作するほかのビューによって共有されます (ドキュメントを複数のコンポーネントによって共有できるなど)。

このモデルは Document インタフェースによって定義されます。これは、編集時に変更を追跡する柔軟なテキスト記憶機構を提供するためのもので、より高度なモデルに拡張できます。モデルインタフェースは、SGML が提供する式の機能、つまり多様なコンテンツを表現するのに使うシステムを取り込むためのものです。ドキュメントに加える各修正は、ビューを最新のモデルに同期できるようにする DocumentEvent という形式で変更の詳細な通知がすべてのオブザーバに送られます。このイベントは、DocumentListener インタフェースを実装して監視中のモデルに配信対象を登録したオブザーバに送られます。

位置情報

ビューでテキスト位置を指定する機能が提供されます。この情報を判定するために、modelToView(int) と viewToModel(java.awt.Point) の 2 つのメソッドが用意されています。

元に戻す/再実行のサポート

編集履歴機構のサポートが提供されているので、元に戻す/再実行の操作を行うことができます。テキストコンポーネントはそれ自体ではデフォルトで履歴バッファーを提供しませんが、履歴バッファーと組み合わせて使うと、「元に戻す/再実行」をサポートする UndoableEdit レコードを提供します。 そのサポートは Document モデルにより提供されます。そのサポートは Document モデルによって提供されます。このモデルにより、UndoableEditListener の実装の追加が可能になります。

スレッドに対する安全性

Swing テキストコンポーネントは特定のスレッドに対して安全な操作のサポートを提供します。テキストコンポーネントは高度な構成機能を持つので、提供される保護機能を使用しないこともできます。保護機能は主にモデルにより考え出されたもので、AbstractDocument のマニュアルでは提供される保護の前提条件を説明しています。非同期で安全に呼び出せるメソッドには、コメントが付けられています。

改行

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

印刷のサポート

基本的なドキュメントの印刷処理のため、いくつかの print メソッドが用意されています。高度な印刷処理が必要な場合は、getPrintable(java.text.MessageFormat, java.text.MessageFormat) メソッドを使用します。

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

関連項目:

Document, DocumentEvent, DocumentListener, Caret, CaretEvent, CaretListener, TextUI, View, ViewFactory

入れ子のクラスの概要

class	JTextComponent.AccessibleJTextComponent このクラスは JTextComponent クラス用のアクセシビリティーサポートを実装しています。
static class	JTextComponent.DropLocation JTextComponent のドロップ位置を示します。
static class	JTextComponent.KeyBinding キーバインド作成用のレコードを割り当てます。

クラス javax.swing.JComponent から継承された入れ子のクラス/インタフェース

JComponent.AccessibleJComponent

クラス java.awt.Container から継承された入れ子のクラス/インタフェース

Container.AccessibleAWTContainer

クラス java.awt.Component から継承された入れ子のクラス/インタフェース

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

フィールドの概要

static String	DEFAULT_KEYMAP 異なるキーマップセットを持っていない限り、全 JTextComponent インスタンスで共有されるデフォルトのキーマップです。
static String	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

コンストラクタの概要

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

メソッドの概要

void	addCaretListener(CaretListener listener) 変更を通知するためのキャレットリスナーをキャレットに追加します。
void	addInputMethodListener(InputMethodListener l) このコンポーネントからインプットメソッドイベントを受け取るために、指定されたインプットメソッドリスナーを追加します。
static Keymap	addKeymap(String nm, Keymap parent) 新しいキーマップをキーマップ階層に追加します。
void	copy() 関連するテキストモデル内の現在選択されている領域をシステムクリップボードに転送して、テキストモデル内のコンテンツはそのまま残します。
void	cut() 関連するテキストモデル内の現在選択されている領域をシステムクリップボードに転送して、モデルからコンテンツを削除します。
protected void	fireCaretUpdate(CaretEvent e) 通知の配信対象を、指定されたイベント型で登録したすべてのリスナーに通知します。
AccessibleContext	getAccessibleContext() この JTextComponent に関連した AccessibleContext を取得します。
Action[]	getActions() エディタのコマンドリストを取り出します。
Caret	getCaret() ビューでテキスト指向ナビゲーションを可能にするキャレットを取り出します。
Color	getCaretColor() キャレットを描画するのに使う現在の色を取り出します。
CaretListener[]	getCaretListeners() このテキストコンポーネントに登録された、すべてのキャレットリスナーからなる配列を返します。
int	getCaretPosition() テキストコンポーネントのテキスト挿入キャレットの位置を返します。
Color	getDisabledTextColor() 無効にしたテキストを描画するために使用する現在の色を取得します。
Document	getDocument() エディタに関連したモデルを取り出します。
boolean	getDragEnabled() 自動ドラッグ処理が有効であるかどうかを返します。
JTextComponent.DropLocation	getDropLocation() このコンポーネントがコンポーネントのドラッグ＆ドロップ時にドロップ位置として視覚的に示す位置を返します。
DropMode	getDropMode() このコンポーネントのドロップモードを返します。
char	getFocusAccelerator() 受信側テキストコンポーネントにフォーカスを取得させるキーアクセラレータを返します。
Highlighter	getHighlighter() ハイライトをつけるのに使用されるオブジェクトを取り出します。
InputMethodRequests	getInputMethodRequests() このコンポーネントのインプットメソッドからの要求をサポートするインプットメソッド要求ハンドラを返します。
Keymap	getKeymap() このテキストコンポーネントで現在アクティブなキーマップを取り出します。
static Keymap	getKeymap(String nm) それまでにドキュメントに追加されていた名前付きキーマップを取り出します。
Insets	getMargin() テキストコンポーネントの境界とそのテキストの間のマージンを返します。
NavigationFilter	getNavigationFilter() NavigationFilter を返します。
Dimension	getPreferredScrollableViewportSize() ビューコンポーネントのビューポートの適切なサイズを返します。
Printable	getPrintable(MessageFormat headerFormat, MessageFormat footerFormat) この JTextComponent の内容を印刷するために使用する Printable を返します。
int	getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction) 論理行または論理列を表示するコンポーネントは、orientation の値によって、1 ブロック分の行または列を完全にエクスポーズするスクロール増分値を計算します。
boolean	getScrollableTracksViewportHeight() ビューポートが常にこの Scrollable の高さを強制的にビューポートの高さと一致させる場合に true を返します。
boolean	getScrollableTracksViewportWidth() ビューポートが常にこの Scrollable の幅を強制的にビューポートの幅に一致させる場合に true を返します。
int	getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction) 論理行または論理列を表示するコンポーネントは、orientation の値によって、新しい 1 行または 1 列を完全にエクスポーズするスクロール増分値を計算します。
String	getSelectedText() この TextComponent に格納された選択されているテキストを返します。
Color	getSelectedTextColor() 選択したテキストを描画するのに使う現在の色を取り出します。
Color	getSelectionColor() 選択領域を描画するのに使う現在の色を取り出します。
int	getSelectionEnd() 選択したテキストの末尾位置を返します。
int	getSelectionStart() 選択したテキストの開始位置を返します。
String	getText() この TextComponent に格納されたテキストを返します。
String	getText(int offs, int len) コンポーネントが表すテキストの一部を取り出します。
String	getToolTipText(MouseEvent event) event のツールヒントとして使用される文字列を返します。
TextUI	getUI() このテキスト指向エディタのユーザーインタフェースファクトリを取り出します。
boolean	isEditable() この TextComponent が編集可能かどうかを示すブール型を返します。
static void	loadKeymap(Keymap map, JTextComponent.KeyBinding[] bindings, Action[] actions) キーマップに多数の割り当てをロードします。
Rectangle	modelToView(int pos) モデル内の指定された位置を、ビュー座標体系内の場所に変換します。
void	moveCaretPosition(int pos) キャレットを新しい位置に移動して、setCaretPosition が前回呼び出されたときに定義されたマークは残しておきます。
protected String	paramString() この JTextComponent の文字列表現を返します。
void	paste() システムクリップボードのコンテンツを関連するテキストモデルに転送します。
boolean	print() 印刷ダイアログを表示し、対話型モードで、ヘッダーテキストまたはフッターテキストを指定しないでこの JTextComponent を印刷する簡易印刷メソッドです。
boolean	print(MessageFormat headerFormat, MessageFormat footerFormat) 印刷ダイアログを表示し、対話型モードで、ヘッダーテキストおよびフッターテキストを指定してこの JTextComponent を印刷する簡易印刷メソッドです。
boolean	print(MessageFormat headerFormat, MessageFormat footerFormat, boolean showPrintDialog, PrintService service, PrintRequestAttributeSet attributes, boolean interactive) この JTextComponent の内容を印刷します。
protected void	processInputMethodEvent(InputMethodEvent e) このコンポーネントで発生するインプットメソッドイベントを、登録されているすべての InputMethodListener オブジェクトにディスパッチすることによって処理します。
void	read(Reader in, Object desc) ストリームから初期化します。
void	removeCaretListener(CaretListener listener) キャレットリスナーを削除します。
static Keymap	removeKeymap(String nm) それまでにドキュメントに追加されていた名前付きキーマップを削除します。
void	removeNotify() このコンポーネントに親コンポーネントがなくなったことを、このコンポーネントに通知します。
void	replaceSelection(String content) 現在選択されているコンテンツを、渡された文字列が示す新しいコンテンツで置き換えます。
void	select(int selectionStart, int selectionEnd) 指定された始点と終点の間にあるテキストを選択します。
void	selectAll() TextComponent 内のすべてのテキストを選択します。
void	setCaret(Caret c) 使用するキャレットを設定します。
void	setCaretColor(Color c) キャレットを描画するのに使う現在の色を設定します。
void	setCaretPosition(int position) TextComponent のテキスト挿入キャレットの位置を設定します。
void	setComponentOrientation(ComponentOrientation o) このコンポーネント内の要素またはテキストを整列するために使用する、言語に依存する方向を設定します。
void	setDisabledTextColor(Color c) 無効にしたテキストを描画するのに使う現在の色を設定します。
void	setDocument(Document doc) エディタをテキストドキュメントに関連付けます。
void	setDragEnabled(boolean b) 自動ドラッグ処理をオンまたはオフにします。
void	setDropMode(DropMode dropMode) このコンポーネントのドロップモードを設定します。
void	setEditable(boolean b) この TextComponent が編集可能かどうかを設定します。
void	setFocusAccelerator(char aKey) 受信側テキストコンポーネントにフォーカスを取得させるキーアクセラレータを設定します。
void	setHighlighter(Highlighter h) 使用するハイライタを設定します。
void	setKeymap(Keymap map) イベントをアクションに割り当てるのに使うキーマップを設定します。
void	setMargin(Insets m) テキストコンポーネントの境界とそのテキストの間のマージン空白を設定します。
void	setNavigationFilter(NavigationFilter filter) NavigationFilter を設定します。
void	setSelectedTextColor(Color c) 選択したテキストを描画するのに使う現在の色を設定します。
void	setSelectionColor(Color c) 選択領域を描画するのに使う現在の色を設定します。
void	setSelectionEnd(int selectionEnd) 選択領域の末尾を、指定された位置に設定します。
void	setSelectionStart(int selectionStart) 選択開始を、指定された位置に設定します。
void	setText(String t) この TextComponent のテキストに、指定されたテキストを設定します。
void	setUI(TextUI ui) このテキスト指向エディタのユーザーインタフェースファクトリを設定します。
void	updateUI() プラグイン可能な UI を再ロードします。
int	viewToModel(Point pt) ビュー座標体系内の指定された場所を、モデル内のもっとも近い位置に変換します。
void	write(Writer out) モデルのコンテンツを、指定されたストリームに格納します。

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

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

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

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

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

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

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

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

フィールドの詳細

FOCUS_ACCELERATOR_KEY

public static final String FOCUS_ACCELERATOR_KEY

フォーカスアクセラレータのバウンドプロパティー名です。

関連項目:

定数フィールド値

DEFAULT_KEYMAP

public static final String DEFAULT_KEYMAP

異なるキーマップセットを持っていない限り、全 JTextComponent インスタンスで共有されるデフォルトのキーマップです。

関連項目:

定数フィールド値

コンストラクタの詳細

JTextComponent

public JTextComponent()

新しい JTextComponent を作成します。キャレットイベントのリスナーが確立され、プラグイン可能な UI がインストールされます。コンポーネントは編集可能とマークされます。配置はテキストのビューサブシステムによって管理されるので、レイアウトマネージャーは使用されません。ドキュメントモデルは null に設定されます。

メソッドの詳細

getUI

public TextUI getUI()

このテキスト指向エディタのユーザーインタフェースファクトリを取り出します。

戻り値:

ファクトリ

setUI

public void setUI(TextUI ui)

このテキスト指向エディタのユーザーインタフェースファクトリを設定します。

パラメータ:

ui - ファクトリ

updateUI

public void updateUI()

プラグイン可能な UI を再ロードします。新しいインタフェースを取得するのに使うキーは getUIClassID() です。UI のタイプは TextUI です。 invalidate は、UI の設定後に呼び出されます。

オーバーライド:

クラス JComponent 内の updateUI

関連項目:

JComponent.setUI(javax.swing.plaf.ComponentUI), UIManager.getLookAndFeel(), UIManager.getUI(javax.swing.JComponent)

addCaretListener

public void addCaretListener(CaretListener listener)

変更を通知するためのキャレットリスナーをキャレットに追加します。

パラメータ:

listener - 追加されるリスナー

関連項目:

CaretEvent

removeCaretListener

public void removeCaretListener(CaretListener listener)

キャレットリスナーを削除します。

パラメータ:

listener - 削除されるリスナー

関連項目:

CaretEvent

getCaretListeners

public CaretListener[] getCaretListeners()

このテキストコンポーネントに登録された、すべてのキャレットリスナーからなる配列を返します。

戻り値:

このコンポーネントのすべての CaretListener、 変更リスナーが現在登録されていない場合は 空の配列

導入されたバージョン:

1.4

関連項目:

addCaretListener(javax.swing.event.CaretListener), removeCaretListener(javax.swing.event.CaretListener)

fireCaretUpdate

protected void fireCaretUpdate(CaretEvent e)

通知の配信対象を、指定されたイベント型で登録したすべてのリスナーに通知します。イベントインスタンスは、fire メソッドに渡されるパラメータを使って簡単に生成されます。リスナーリストは降順方式で処理されます。

パラメータ:

e - イベント

関連項目:

EventListenerList

setDocument

public void setDocument(Document doc)

エディタをテキストドキュメントに関連付けます。現在登録済みのファクトリを使うと、ドキュメントのビューを構築できます。このビューは、再検証後にエディタによって表示されます。PropertyChange イベント (document) は、各リスナーに通知されます。

パラメータ:

doc - 表示および編集するドキュメント

関連項目:

getDocument()

getDocument

public Document getDocument()

エディタに関連したモデルを取り出します。これは主に、テキストエディタになるのに必要な最小限の状態に UI が到達するためのものです。サブクラスは、モデルの実際の型を返します。この型は通常 Document を継承したものになります。

戻り値:

モデル

setComponentOrientation

public void setComponentOrientation(ComponentOrientation o)

クラス Component の記述:

このコンポーネント内の要素またはテキストを整列するために使用する、言語に依存する方向を設定します。言語に依存する LayoutManager サブクラスおよび Component サブクラスはこのプロパティーを使用してコンポーネントの配置方法および描画方法を決めます。

構築時には、コンポーネントの方向は、明示的に指定されていないことを示す ComponentOrientation.UNKNOWN に設定されます。UNKNOWN の方向の動作は ComponentOrientation.LEFT_TO_RIGHT と同じです。

コンポーネントの方向決定を単独で行う場合はこのメソッドを使用します。コンポーネント階層全体の方向を決定する場合は、applyComponentOrientation を使用します。

オーバーライド:

クラス Component 内の setComponentOrientation

関連項目:

ComponentOrientation

getActions

public Action[] getActions()

エディタのコマンドリストを取り出します。これは、エディタ自身がサポートするコマンドコレクションで拡張された、プラグイン済み UI によってサポートされるコマンドのリストです。これらは、キーマップ内と同じように、イベントへの割り当てに役立ちます。

戻り値:

コマンドリスト

setMargin

public void setMargin(Insets m)

テキストコンポーネントの境界とそのテキストの間のマージン空白を設定します。テキストコンポーネントのデフォルト Border オブジェクトは、この値を使って適切なマージンを作成します。ただし、デフォルト以外の境界が設定されている場合は、Border オブジェクトが適切なマージン空白を作成します。 (それ以外の場合、このプロパティーは事実上無視される)。このため、コンポーネントの再描画が行われます。PropertyChange イベント (margin) はすべてのリスナーに送られます。

パラメータ:

m - ボーダーとテキストの間のマージン

getMargin

public Insets getMargin()

テキストコンポーネントの境界とそのテキストの間のマージンを返します。

戻り値:

マージン

setNavigationFilter

public void setNavigationFilter(NavigationFilter filter)

NavigationFilter を設定します。NavigationFilter は DefaultCaret と、カーソルの移動を限定するデフォルトのカーソル移動処理で使用されます。

導入されたバージョン:

1.4

getNavigationFilter

public NavigationFilter getNavigationFilter()

NavigationFilter を返します。NavigationFilter は DefaultCaret と、カーソルの移動を限定するデフォルトのカーソル移動処理で使用されます。戻り値の null はカーソルの移動と選択が制限されないことを表します。

戻り値:

NavigationFilter

導入されたバージョン:

1.4

getCaret

public Caret getCaret()

ビューでテキスト指向ナビゲーションを可能にするキャレットを取り出します。

戻り値:

キャレット

setCaret

public void setCaret(Caret c)

使用するキャレットを設定します。デフォルトで、インストールされる UI によって設定されます。これは、必要に応じてカスタムキャレットに変更できます。キャレットを設定すると、PropertyChange イベント (caret) が発生します。

パラメータ:

c - キャレット

関連項目:

getCaret()

getHighlighter

public Highlighter getHighlighter()

ハイライトをつけるのに使用されるオブジェクトを取り出します。

戻り値:

ハイライタ

setHighlighter

public void setHighlighter(Highlighter h)

使用するハイライタを設定します。デフォルトで、インストールされる UI によって設定されます。これは、必要に応じてカスタムハイライタに変更できます。これを無効にするには、ハイライタを null に設定します。新しいハイライタがインストールされると、PropertyChange イベント (highlighter) が発生します。

パラメータ:

h - ハイライタ

関連項目:

getHighlighter()

setKeymap

public void setKeymap(Keymap map)

イベントをアクションに割り当てるのに使うキーマップを設定します。null に設定すると、キーボード入力が事実上無効になります。新しいキーマップをインストールすると、PropertyChange イベント (keymap) が発生します。

パラメータ:

map - キーマップ

関連項目:

getKeymap()

setDragEnabled

public void setDragEnabled(boolean b)

自動ドラッグ処理をオンまたはオフにします。自動ドラッグ処理を有効にするには、このプロパティーの値を true に設定し、コンポーネントの TransferHandler の値を null 以外 にしてください。dragEnabled プロパティーのデフォルト値は false です。

このプロパティーを受け入れ、ユーザーのドラッグジェスチャーを認識する処理は、Look & Feel 実装 (特にコンポーネントの TextUI) によって行われます。自動ドラッグ処理が有効である場合、ほとんどの Look & Feel (BasicLookAndFeel のサブクラスの Look & Feel を含む) は、ユーザーが選択項目の上でマウスボタンを押し、マウスを数ピクセル移動すると、ドラッグ＆ドロップ操作を開始します。したがって、このプロパティーを true に設定すると、選択の動作に微妙な効果があります。

このプロパティーを無視するような Look & Feel を使用している場合も、コンポーネントの TransferHandler 上で exportAsDrag を呼び出すことにより、ドラッグ＆ドロップ操作を開始できます。

パラメータ:

b - 自動ドラッグ処理を有効にするかどうか

例外:

HeadlessException - b が true の場合で GraphicsEnvironment.isHeadless() が true を返す場合

導入されたバージョン:

1.4

関連項目:

GraphicsEnvironment.isHeadless(), getDragEnabled(), JComponent.setTransferHandler(javax.swing.TransferHandler), TransferHandler

getDragEnabled

public boolean getDragEnabled()

自動ドラッグ処理が有効であるかどうかを返します。

戻り値:

dragEnabled プロパティーの値

導入されたバージョン:

1.4

関連項目:

setDragEnabled(boolean)

setDropMode

public final void setDropMode(DropMode dropMode)

このコンポーネントのドロップモードを設定します。後方互換性を確保するため、このプロパティーのデフォルト値は DropMode.USE_SELECTION になっています。ただし、ユーザー経験を改善したい場合は、DropMode.INSERT の使用をお勧めします。DropMode.INSERT では、テキストのある位置から別の位置へのドロップとよく似た操作を実行できますが、現在選択しているテキストとキャレット位置に影響はありません。

JTextComponents は次のドロップモードをサポートしています。

• DropMode.USE_SELECTION
• DropMode.INSERT

このコンポーネントがドロップを受け付ける TransferHandler を持っていなければ、ドロップモードの効果はありません。

パラメータ:

dropMode - 使用するドロップモード

例外:

IllegalArgumentException - ドロップモードがサポートされていないか null の場合

導入されたバージョン:

1.6

関連項目:

getDropMode(), getDropLocation(), JComponent.setTransferHandler(javax.swing.TransferHandler), TransferHandler

getDropMode

public final DropMode getDropMode()

このコンポーネントのドロップモードを返します。

戻り値:

このコンポーネントのドロップモード

導入されたバージョン:

1.6

関連項目:

setDropMode(javax.swing.DropMode)

getDropLocation

public final JTextComponent.DropLocation getDropLocation()

このコンポーネントがコンポーネントのドラッグ＆ドロップ時にドロップ位置として視覚的に示す位置を返します。現在位置が表示されていない場合は null を返します。

このメソッドは、TransferHandler からドロップ位置を照会する手段にはなりません。ドロップ位置は、TransferHandler の canImport が返され、ドロップ位置を表示する準備ができてから設定されるからです。

このプロパティーが変更されると、コンポーネントにより、プロパティー変更イベント dropLocation がトリガーされます。

戻り値:

ドロップ位置

導入されたバージョン:

1.6

関連項目:

setDropMode(javax.swing.DropMode), TransferHandler.canImport(TransferHandler.TransferSupport)

getKeymap

public Keymap getKeymap()

このテキストコンポーネントで現在アクティブなキーマップを取り出します。

戻り値:

キーマップ

addKeymap

public static Keymap addKeymap(String nm,
                               Keymap parent)

新しいキーマップをキーマップ階層に追加します。キーマップ割り当ては下から上へ解釈処理されるので、子で指定した属性は親で指定した属性をオーバーライドします。

パラメータ:

nm - キーマップの名前。ドキュメント内の名前付きキーマップのコレクションの中で一意である必要がある。 キーマップに名前を指定しない場合、 名前は null でもかまわない。 ただし、名前なしのキーマップは名前を指定して取得することができないので、 返された参照の管理は 呼び出し側で行う

parent - 親キーマップ。未指定の割り当てをほかの特定のキーマップで解釈処理する必要がない場合は、null を設定できる

戻り値:

キーマップ

removeKeymap

public static Keymap removeKeymap(String nm)

それまでにドキュメントに追加されていた名前付きキーマップを削除します。名前が null であるキーマップは、この方法では削除できません。

パラメータ:

nm - 削除するキーマップの名前

戻り値:

削除されたキーマップ

getKeymap

public static Keymap getKeymap(String nm)

それまでにドキュメントに追加されていた名前付きキーマップを取り出します。名前が null であるキーマップは扱いません。

パラメータ:

nm - キーマップの名前

戻り値:

キーマップ

loadKeymap

public static void loadKeymap(Keymap map,
                              JTextComponent.KeyBinding[] bindings,
                              Action[] actions)

キーマップに多数の割り当てをロードします。このメソッドを使うと、定義のスタティックテーブルを取得して特定のキーマップにロードできます。次に、いくつかのキーを JtextComponent に関連したカット、コピー、ペーストの各アクションに割り当てる例を示します。これを実行するコードは、次のとおりです (抜粋)。

   static final JTextComponent.KeyBinding[] defaultBindings = {
     new JTextComponent.KeyBinding(
       KeyStroke.getKeyStroke(KeyEvent.VK_C, InputEvent.CTRL_MASK),
       DefaultEditorKit.copyAction),
     new JTextComponent.KeyBinding(
       KeyStroke.getKeyStroke(KeyEvent.VK_V, InputEvent.CTRL_MASK),
       DefaultEditorKit.pasteAction),
     new JTextComponent.KeyBinding(
       KeyStroke.getKeyStroke(KeyEvent.VK_X, InputEvent.CTRL_MASK),
       DefaultEditorKit.cutAction),
   };

   JTextComponent c = new JTextPane();
   Keymap k = c.getKeymap();
   JTextComponent.loadKeymap(k, defaultBindings, c.getActions());
 
 

割り当てとアクションのセットは空でもかまいませんが、null にはできません。

パラメータ:

map - キーマップ

bindings - バインディング

actions - アクションのセット

getCaretColor

public Color getCaretColor()

キャレットを描画するのに使う現在の色を取り出します。

戻り値:

色

setCaretColor

public void setCaretColor(Color c)

キャレットを描画するのに使う現在の色を設定します。これを null に設定すると、効果的にデフォルトの色を復元します。色を設定すると、PropertyChange イベント (caretColor) が発生します。

パラメータ:

c - 色

関連項目:

getCaretColor()

getSelectionColor

public Color getSelectionColor()

選択領域を描画するのに使う現在の色を取り出します。

戻り値:

色

setSelectionColor

public void setSelectionColor(Color c)

選択領域を描画するのに使う現在の色を設定します。色に null を設定することは、Color.white を設定することと同じです。色を設定すると、PropertyChange イベント (selectionColor) が発生します。

パラメータ:

c - 色

関連項目:

getSelectionColor()

getSelectedTextColor

public Color getSelectedTextColor()

選択したテキストを描画するのに使う現在の色を取り出します。

戻り値:

色

setSelectedTextColor

public void setSelectedTextColor(Color c)

選択したテキストを描画するのに使う現在の色を設定します。色に null を設定することは、Color.black を設定することと同じです。色を設定すると、PropertyChange イベント (selectedTextColor) が発生します。

パラメータ:

c - 色

関連項目:

getSelectedTextColor()

getDisabledTextColor

public Color getDisabledTextColor()

無効にしたテキストを描画するために使用する現在の色を取得します。

戻り値:

色

setDisabledTextColor

public void setDisabledTextColor(Color c)

無効にしたテキストを描画するのに使う現在の色を設定します。色を設定すると、PropertyChange イベント (disabledTextColor) が発生します。

パラメータ:

c - 色

関連項目:

getDisabledTextColor()

replaceSelection

public void replaceSelection(String content)

現在選択されているコンテンツを、渡された文字列が示す新しいコンテンツで置き換えます。選択領域がない場合は、指定されたテキストの挿入と同等です。置換後のテキストがない場合、現在の選択領域の削除と同等です。

このメソッドは、キーマップアクションに割り当てられるコンテンツを挿入するアクションのデフォルト実装によって使用されます。

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

パラメータ:

content - 選択範囲を置き換えるコンテンツ

getText

public String getText(int offs,
                      int len)
               throws BadLocationException

コンポーネントが表すテキストの一部を取り出します。長さが 0 の場合は、空の文字列を返します。

パラメータ:

offs - オフセット >= 0

len - 長さ >= 0

戻り値:

テキスト

例外:

BadLocationException - オフセットまたは長さが無効な場合

modelToView

public Rectangle modelToView(int pos)
                      throws BadLocationException

モデル内の指定された位置を、ビュー座標体系内の場所に変換します。この変換を計算するために、コンポーネントは正のサイズを持つ必要があります。つまり、コンポーネントのサイズが決定されるまでレイアウトの計算はできません。コンポーネントは可視である必要もペイントされている必要もありません。

パラメータ:

pos - 位置 >= 0

戻り値:

矩形の座標。座標系での位置を (r.x, r.y) で表現。 コンポーネントがまだ正のサイズを持っていない場合は null

例外:

BadLocationException - 指定された位置が、関連するドキュメント内の 有効な位置を示さない場合

関連項目:

TextUI.modelToView(javax.swing.text.JTextComponent, int)

viewToModel

public int viewToModel(Point pt)

ビュー座標体系内の指定された場所を、モデル内のもっとも近い位置に変換します。この変換を計算するために、コンポーネントは正のサイズを持つ必要があります。つまり、コンポーネントのサイズが決定されるまでレイアウトの計算はできません。コンポーネントは可視である必要もペイントされている必要もありません。

パラメータ:

pt - 変換するビュー内の位置

戻り値:

ドキュメントの先頭からのオフセット (0 以上)。コンポーネントがまだ正のサイズを持っていない場合は -1

関連項目:

TextUI.viewToModel(javax.swing.text.JTextComponent, java.awt.Point)

cut

public void cut()

関連するテキストモデル内の現在選択されている領域をシステムクリップボードに転送して、モデルからコンテンツを削除します。現在の選択領域は取り消されます。選択領域が null の場合には何も行いません。

関連項目:

Toolkit.getSystemClipboard(), Clipboard

copy

public void copy()

関連するテキストモデル内の現在選択されている領域をシステムクリップボードに転送して、テキストモデル内のコンテンツはそのまま残します。現在の選択領域は元のまま残ります。選択領域が null の場合には何も行いません。

関連項目:

Toolkit.getSystemClipboard(), Clipboard

paste

public void paste()

システムクリップボードのコンテンツを関連するテキストモデルに転送します。関連するビュー内に選択領域があるときは、クリップボードのコンテンツで置き換えられます。選択領域がないときは、クリップボードのコンテンツは関連するビュー内の現在の挿入位置の前に挿入されます。クリップボードが空の場合には何も行いません。

関連項目:

replaceSelection(java.lang.String), Toolkit.getSystemClipboard(), Clipboard

moveCaretPosition

public void moveCaretPosition(int pos)

キャレットを新しい位置に移動して、setCaretPosition が前回呼び出されたときに定義されたマークは残しておきます。このメソッドは、選択領域を形成します。ドキュメントが null の場合には何も行いません。位置は 0 とコンポーネントテキストの長さとの間でなければならず、そうでない場合は例外がスローされます。

パラメータ:

pos - 位置

例外:

IllegalArgumentException - position に指定した値が 0 未満、またはコンポーネントテキストより長い場合

関連項目:

setCaretPosition(int)

setFocusAccelerator

public void setFocusAccelerator(char aKey)

受信側テキストコンポーネントにフォーカスを取得させるキーアクセラレータを設定します。アクセラレータは、alt キーと指定された文字キーの組み合わせになります (大文字に変換される)。デフォルトでは、フォーカスアクセラレータキーはありません。それまでのキーアクセラレータ設定はすべて破棄されます。「\0」キー設定が登録され、フォーカスアクセラレータをオフに設定する効果を持ちます。新しいキーを設定すると、PropertyChange イベント (FOCUS_ACCELERATOR_KEY) が発生します。

パラメータ:

aKey - キー

関連項目:

getFocusAccelerator()

getFocusAccelerator

public char getFocusAccelerator()

受信側テキストコンポーネントにフォーカスを取得させるキーアクセラレータを返します。設定済みのフォーカスアクセラレータがない場合は、「\0」を返します。

戻り値:

キー

read

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

ストリームから初期化します。コンポーネントに適切なタイプのモデルを作成して、モデルをストリームから初期化します。デフォルトで、モデルをプレーンテキストでロードします。モデルのそれまでのコンテンツは破棄されます。

パラメータ:

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

desc - ストリームを記述するオブジェクト。String、File、URL など。ある種のドキュメント (たとえば HTML) は、この情報を利用できる場合がある。null 以外の場合、ドキュメントのプロパティーとして追加される

例外:

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

関連項目:

EditorKit.createDefaultDocument(), setDocument(javax.swing.text.Document), PlainDocument

write

public void write(Writer out)
           throws IOException

モデルのコンテンツを、指定されたストリームに格納します。デフォルトで、モデルをプレーンテキストで格納します。

パラメータ:

out - 出力ストリーム

例外:

IOException - 入出力エラーが発生した場合

removeNotify

public void removeNotify()

クラス JComponent の記述:

このコンポーネントに親コンポーネントがなくなったことを、このコンポーネントに通知します。このメソッドが呼び出されると、親コンポーネントのチェーンに設定された KeyboardAction が削除されます。

オーバーライド:

クラス JComponent 内の removeNotify

関連項目:

JComponent.registerKeyboardAction(java.awt.event.ActionListener, java.lang.String, javax.swing.KeyStroke, int)

setCaretPosition

public void setCaretPosition(int position)

TextComponent のテキスト挿入キャレットの位置を設定します。 TextComponent のテキスト挿入キャレットの位置を設定します。キャレットは変更を追跡するので、コンポーネントの基本となるテキストが変更されるとこれも移動することに注意してください。ドキュメントが null の場合には何も行いません。位置は 0 とコンポーネントテキストの長さとの間でなければならず、そうでない場合は例外がスローされます。

パラメータ:

position - 位置

例外:

IllegalArgumentException - position に指定した値が 0 未満、またはコンポーネントテキストより長い場合

getCaretPosition

public int getCaretPosition()

テキストコンポーネントのテキスト挿入キャレットの位置を返します。

戻り値:

テキストコンポーネントのテキスト挿入キャレットの位置 (0 以上)

setText

public void setText(String t)

この TextComponent のテキストに、指定されたテキストを設定します。テキストが null または空の場合は、古いテキストを単に削除する効果があります。テキストが挿入されたときに結果として得られるキャレット位置は、キャレットクラスの実装によって決定されます。

このメソッドはスレッドに対して安全ですが、ほとんどの Swing メソッドは違います。詳細は、「How to Use Threads」を参照してください。 テキストはバウンドプロパティーではないため、それが変更されても PropertyChangeEvent はトリガーされません。テキストの変更を待機するには、DocumentListener を使用してください。

パラメータ:

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

関連項目:

getText(int, int), DefaultCaret

getText

public String getText()

この TextComponent に格納されたテキストを返します。基本となるドキュメントが null の場合は、NullPointerException を返します。 テキストはバウンドプロパティーではないため、それが変更されても PropertyChangeEvent はトリガーされません。テキストの変更を待機するには、DocumentListener を使用してください。

戻り値:

テキスト

例外:

NullPointerException - ドキュメントが null の場合

関連項目:

setText(java.lang.String)

getSelectedText

public String getSelectedText()

この TextComponent に格納された選択されているテキストを返します。選択領域が null であるか、ドキュメントが空の場合は、null を返します。

戻り値:

テキスト

例外:

IllegalArgumentException - 選択領域がなんらかの理由で ドキュメントへの有効なマッピングを持たない場合

関連項目:

setText(java.lang.String)

isEditable

public boolean isEditable()

この TextComponent が編集可能かどうかを示すブール型を返します。

戻り値:

boolean 型の値

関連項目:

setEditable(boolean)

setEditable

public void setEditable(boolean b)

この TextComponent が編集可能かどうかを設定します。状態が変更されると、PropertyChange イベント (editable) が発生します。

パラメータ:

b - 設定される boolean

関連項目:

isEditable()

getSelectionStart

public int getSelectionStart()

選択したテキストの開始位置を返します。ドキュメントが空の場合は 0、選択領域がない場合はドットの値を返します。

戻り値:

開始位置 >= 0

setSelectionStart

public void setSelectionStart(int selectionStart)

選択開始を、指定された位置に設定します。新しい先頭は、現在の選択領域の末尾かその前に限定されます。

これは、このメソッドを java.awt.TextComponent で呼び出したコードに対する下位互換に役立ちます。これを実装すると、実際の選択領域が管理されている場所である Caret の実装に転送できます。

パラメータ:

selectionStart - テキストの開始位置 >= 0

getSelectionEnd

public int getSelectionEnd()

選択したテキストの末尾位置を返します。ドキュメントが空の場合は 0、選択領域がない場合はドットの値を返します。

戻り値:

末尾位置 >= 0

setSelectionEnd

public void setSelectionEnd(int selectionEnd)

選択領域の末尾を、指定された位置に設定します。新しい末尾は、現在の選択領域の先頭またはそのあとに限定されます。

これは、このメソッドを java.awt.TextComponent で呼び出したコードに対する下位互換に役立ちます。これを実装すると、実際の選択領域が管理されている場所である Caret の実装に転送できます。

パラメータ:

selectionEnd - テキストの末尾位置 >= 0

select

public void select(int selectionStart,
                   int selectionEnd)

指定された始点と終点の間にあるテキストを選択します。

このメソッドは選択テキストの始点と終点を設定します。 始点は 0 以上でなければならないという制約が適用されます。終点は始点と同じか、それより大きい値でなければならず、またテキストコンポーネントのテキストの長さに等しいか、それより短くなければいけません。

呼び出し側が一貫性のない値または境界外の値を指定した場合、メソッドはメッセージを表示せずに、これらの制約を適用します。具体的には、始点または終点がテキストの長さを超える場合、テキストと同じ長さに設定し直します。始点がゼロより小さい場合、ゼロに設定し直します。 終点が始点より小さい場合、始点に設定し直します。

この呼び出しは、下位互換のために提供されています。これは、setCaretPosition の呼び出しに回送され、それに moveCaretPostion の呼び出しが続きます。選択領域を管理する望ましい方法は、これらのメソッドを直接呼び出すことです。

パラメータ:

selectionStart - テキストの始点

selectionEnd - テキストの終点

関連項目:

setCaretPosition(int), moveCaretPosition(int)

selectAll

public void selectAll()

TextComponent 内のすべてのテキストを選択します。null または空のドキュメントでは何も行いません。

getToolTipText

public String getToolTipText(MouseEvent event)

event のツールヒントとして使用される文字列を返します。返されるのは次のいずれかです。

1. null 以外の値で setToolTipText が呼び出されると、その値が返される。そうでない場合は
2. UI 上での getToolTipText の呼び出しによる値が返される

デフォルトでは、JTextComponent が ToolTipManager で登録されることはありません。これは、registerComponent が ToolTipManager 上で呼び出されない限り、ツールヒントは TextUI から表示されないことを意味します。

オーバーライド:

クラス JComponent 内の getToolTipText

パラメータ:

event - 該当のイベント

戻り値:

event のツールヒントとして使用される文字列

関連項目:

JComponent.setToolTipText(java.lang.String), TextUI.getToolTipText(javax.swing.text.JTextComponent, java.awt.Point), ToolTipManager.registerComponent(javax.swing.JComponent)

getPreferredScrollableViewportSize

public Dimension getPreferredScrollableViewportSize()

ビューコンポーネントのビューポートの適切なサイズを返します。これを実装すると、コンポーネントの適切なサイズを返すデフォルト動作を実行できます。

定義:

インタフェース Scrollable 内の getPreferredScrollableViewportSize

戻り値:

この Scrollable をビューとして持つ JViewport の preferredSize

関連項目:

JComponent.getPreferredSize()

getScrollableUnitIncrement

public int getScrollableUnitIncrement(Rectangle visibleRect,
                                      int orientation,
                                      int direction)

論理行または論理列を表示するコンポーネントは、orientation の値によって、新しい 1 行または 1 列を完全にエクスポーズするスクロール増分値を計算します。理論的には、コンポーネントは項目を完全にエクスポーズするために必要な距離を返すことで、部分的にエクスポーズされている行または列を処理します。

このデフォルト実装は、単純に可視領域の 10% を返します。サブクラスは、よりいっそう適正な値を提供できます。

定義:

インタフェース Scrollable 内の getScrollableUnitIncrement

パラメータ:

visibleRect - ビューポート内の可視のビュー領域

orientation - SwingConstants.VERTICAL または SwingConstants.HORIZONTAL

direction - 上または左にスクロールする場合は 0 より小さく、下または右にスクロールする場合は 0 より大きい

戻り値:

指定された方向にスクロールするための「ユニット」増分値

例外:

IllegalArgumentException - 方向が無効な場合

関連項目:

JScrollBar.setUnitIncrement(int)

getScrollableBlockIncrement

public int getScrollableBlockIncrement(Rectangle visibleRect,
                                       int orientation,
                                       int direction)

論理行または論理列を表示するコンポーネントは、orientation の値によって、1 ブロック分の行または列を完全にエクスポーズするスクロール増分値を計算します。

このデフォルト実装は、単純に可視領域を返します。サブクラスは、よりいっそう適正な値を提供できます。

定義:

インタフェース Scrollable 内の getScrollableBlockIncrement

パラメータ:

visibleRect - ビューポート内の可視のビュー領域

orientation - SwingConstants.VERTICAL または SwingConstants.HORIZONTAL

direction - 上または左にスクロールする場合は 0 より小さく、下または右にスクロールする場合は 0 より大きい

戻り値:

指定された方向にスクロールするための「ブロック」増分値

例外:

IllegalArgumentException - 方向が無効な場合

関連項目:

JScrollBar.setBlockIncrement(int)

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

ビューポートが常にこの Scrollable の幅を強制的にビューポートの幅に一致させる場合に true を返します。たとえば、折り返し行がビューポートの右端を越えて消えてしまうようでは不都合なので、行折り返しをサポートした通常のテキストビューはここで true を返します。上位クラスに JScrollPane を持つ Scrollable に true を返すと、水平スクロールが事実上無効になることに注意してください。

JViewport などのスクロールコンテナは、検証されるとこのメソッドを使用します。

定義:

インタフェース Scrollable 内の getScrollableTracksViewportWidth

戻り値:

ビューポートが Scrollable の幅を強制的にビューポートの幅に一致させる場合は true

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

ビューポートが常にこの Scrollable の高さを強制的にビューポートの高さと一致させる場合に true を返します。たとえば、左から右の列へテキストを表示する段組みのテキストビューの場合、このメソッドで true を返すと、垂直方向のスクロールが結果的に無効になります。

JViewport などのスクロールコンテナは、検証されるとこのメソッドを使用します。

定義:

インタフェース Scrollable 内の getScrollableTracksViewportHeight

戻り値:

ビューポートが Scrollable の高さを強制的に ビューポートの高さに一致させる場合は true

print

public boolean print()
              throws PrinterException

印刷ダイアログを表示し、対話型モードで、ヘッダーテキストまたはフッターテキストを指定しないでこの JTextComponent を印刷する簡易印刷メソッドです。注:このメソッドは印刷が完了するまでブロックされます。

注:ヘッドレスモードでは、ダイアログは表示されません。

このメソッドは、印刷の実行時に、完全な機能を備えた print メソッドを呼び出します。

戻り値:

ユーザーが印刷を取り消さないかぎり true

例外:

PrinterException - 印刷システムのエラーが原因でジョブが停止した場合

SecurityException - 印刷ジョブ要求の開始がこのスレッドに許可されていない場合

導入されたバージョン:

1.6

関連項目:

print(MessageFormat, MessageFormat, boolean, PrintService, PrintRequestAttributeSet, boolean)

print

public boolean print(MessageFormat headerFormat,
                     MessageFormat footerFormat)
              throws PrinterException

印刷ダイアログを表示し、対話型モードで、ヘッダーテキストおよびフッターテキストを指定してこの JTextComponent を印刷する簡易印刷メソッドです。注:このメソッドは印刷が完了するまでブロックされます。

注:ヘッドレスモードでは、ダイアログは表示されません。

このメソッドは、印刷の実行時に、完全な機能を備えた print メソッドを呼び出します。

パラメータ:

headerFormat - ヘッダーとして使用されるテキスト (MessageFormat 形式)。 ヘッダーがない場合は null

footerFormat - フッターとして使用されるテキスト (MessageFormat 形式)。 フッターがない場合は null

戻り値:

ユーザーが印刷を取り消さないかぎり true

例外:

PrinterException - 印刷システムのエラーが原因でジョブが停止した場合

SecurityException - 印刷ジョブ要求の開始がこのスレッドに許可されていない場合

導入されたバージョン:

1.6

関連項目:

print(MessageFormat, MessageFormat, boolean, PrintService, PrintRequestAttributeSet, boolean), MessageFormat

print

public boolean print(MessageFormat headerFormat,
                     MessageFormat footerFormat,
                     boolean showPrintDialog,
                     PrintService service,
                     PrintRequestAttributeSet attributes,
                     boolean interactive)
              throws PrinterException

この JTextComponent の内容を印刷します。注:このメソッドは印刷が完了するまでブロックされます。

MessageFormat 引数を指定して、ヘッダーテキストとフッターテキストを出力に追加することができます。印刷コードは、それらの形式から Strings を要求して、書式付き文字列に含まれる単一の項目 (現在のページ番号を表す Integer) を提供します。

showPrintDialog boolean パラメータを使用すると、印刷ダイアログがユーザーに表示されるかどうかを指定できます。ダイアログが表示されると、ユーザーはそれを使用して印刷属性を変更したり、印刷を取り消したりすることができます。

service では、印刷ダイアログの初期値 PrintService や、ダイアログが表示されないときに印刷する PrintService を指定することができます。

属性は、印刷ダイアログの初期値を指定したり、ダイアログが表示されないときに必要な属性を提供するために使用できます。属性を使って、ジョブの印刷方法 (両面または片面) を制御することができます。

interactive boolean パラメータでは、印刷を対話型モードで行うかどうかを指定できます。true の場合、印刷中に中止オプション付きの進捗ダイアログが表示されます。このダイアログは、ベントディスパッチスレッド上で印刷を行う場合はモーダル、それ以外の場合は非モーダルです。警告:イベントディスパッチスレッド上で、interactive パラメータに false を指定してこのメソッドを呼び出すと、印刷が完了するまで、再ペイントを含むすべてのイベントの処理が中断されます。表示できる GUI のないアプリケーションから印刷するときにのみ false を指定することをお勧めします。

注:ヘッドレスモード では、showPrintDialog パラメータと interactive パラメータが無視されるため、ダイアログは表示されません。

このメソッドを使用すると、印刷中にドキュメントが変更される心配がありません。視覚的に指定するには、印刷中に setEnabled(false) を設定します。

このメソッドは、getPrintable(java.text.MessageFormat, java.text.MessageFormat) を使ってドキュメントの内容を描画します。

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

使用例。次のコードの抜粋は、クロスプラットフォーム型の印刷ダイアログを表示し、対話型モードで JTextComponent を印刷します (ただしユーザーが印刷ダイアログを取り消した場合を除く)。

 textComponent.print(new MessageFormat("My text component header"),
     new MessageFormat("Footer. Page - {0}"), true, null, null, true);
 

イベントディスパッチスレッド以外でこのコードを実行すると、バックグラウンドで印刷が行われます。バックグラウンド印刷では、次のパターンが使用されることがあります。

     FutureTask<Boolean> future =
         new FutureTask<Boolean>(
             new Callable<Boolean>() {
                 public Boolean call() {
                     return textComponent.print(.....);
                 }  
             });
     executor.execute(future);
 

パラメータ:

headerFormat - ヘッダーとして使用されるテキスト (MessageFormat 形式)。 ヘッダーがない場合は null

footerFormat - フッターとして使用されるテキスト (MessageFormat 形式)。 フッターがない場合は null

showPrintDialog - 印刷ダイアログを表示する場合は true、 そうでない場合は false

service - 初期 PrintService、デフォルトの場合は null

attributes - 印刷ジョブに適用されるジョブ属性。何も適用しない場合は null

interactive - 対話型モードで印刷するかどうか

戻り値:

ユーザーが印刷を取り消さないかぎり true

例外:

PrinterException - 印刷システムのエラーが原因でジョブが停止した場合

SecurityException - 印刷ジョブ要求の開始がこのスレッドに許可されていない場合

導入されたバージョン:

1.6

関連項目:

getPrintable(java.text.MessageFormat, java.text.MessageFormat), MessageFormat, GraphicsEnvironment.isHeadless(), FutureTask

getPrintable

public Printable getPrintable(MessageFormat headerFormat,
                              MessageFormat footerFormat)

この JTextComponent の内容を印刷するために使用する Printable を返します。返される Printable は、用紙のサイズに合わせて、画面に表示したとおりにドキュメントを印刷します。複雑なレポートやドキュメントを作成する場合は、返される Printable を別の Printable にラップすることもできます。

返される Printable は、この JTextComponent とドキュメントを共有します。開発者が責任を持って、この Printable の使用中にドキュメントが変更されないようにします。印刷中にドキュメントが変更されると、印刷動作は保証されません。

MessageFormat 引数を指定して、ヘッダーテキストとフッターテキストを出力に追加することができます。印刷コードは、それらの形式から Strings を要求して、書式付き文字列に含まれる単一の項目 (現在のページ番号を表す Integer) を提供します。

印刷時に返される Printable は、ページサイズに合わせてドキュメントの内容の書式設定を行います。行折り返しを適切に行うためには、全ページのイメージング可能領域の幅を同じにする必要があります。PageFormat.getImageableWidth() を参照してください。

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

返される Printable は、どのスレッド上でも印刷できます。

この実装の返される Printable は、どのスレッド上で使用されているかに関係なく、イベントディスパッチスレッド上のすべてのペイントを実行します。

パラメータ:

headerFormat - ヘッダーとして使用されるテキスト (MessageFormat 形式)。 ヘッダーがない場合は null

footerFormat - フッターとして使用されるテキスト (MessageFormat 形式)。 フッターがない場合は null

戻り値:

この JTextComponent の内容を印刷するために使用する Printable

導入されたバージョン:

1.6

関連項目:

Printable, PageFormat, Document.render(java.lang.Runnable)

getAccessibleContext

public AccessibleContext getAccessibleContext()

この JTextComponent に関連した AccessibleContext を取得します。テキストコンポーネントの場合、AccessibleContext は AccessibleJTextComponent の形式を取ります。必要に応じて新規の AccessibleJTextComponent インスタンスが作成されます。

定義:

インタフェース Accessible 内の getAccessibleContext

オーバーライド:

クラス JComponent 内の getAccessibleContext

戻り値:

この JTextComponent の AccessibleContext として機能する JTextComponent

paramString

protected String paramString()

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

JFC コンポーネントの特定の新しい側面についての情報を提供するには、paramString をオーバーライドします。

オーバーライド:

クラス JComponent 内の paramString

戻り値:

この JTextComponent の文字列表現

processInputMethodEvent

protected void processInputMethodEvent(InputMethodEvent e)

クラス Component の記述:

このコンポーネントで発生するインプットメソッドイベントを、登録されているすべての InputMethodListener オブジェクトにディスパッチすることによって処理します。

このコンポーネントに対してインプットメソッドイベントが使用可能でない場合、このメソッドは呼び出されません。インプットメソッドイベントは、次のいずれかの場合に使用可能になります。

• InputMethodListener オブジェクトが addInputMethodListener によって登録されている
• enableEvents によってインプットメソッドイベントが使用可能になっている

イベントパラメータが null の場合の動作は定義されていないため例外がスローされます。

オーバーライド:

クラス Component 内の processInputMethodEvent

パラメータ:

e - インプットメソッドイベント

関連項目:

InputMethodEvent, InputMethodListener, Component.addInputMethodListener(java.awt.event.InputMethodListener), Component.enableEvents(long)

getInputMethodRequests

public InputMethodRequests getInputMethodRequests()

クラス Component の記述:

このコンポーネントのインプットメソッドからの要求をサポートするインプットメソッド要求ハンドラを返します。オンザスポットテキスト入力をサポートするコンポーネントは、InputMethodRequests のインスタンスを返すためにはこのメソッドをオーバーライドする必要があります。同時に、インプットメソッドイベントを処理する必要もあります。

オーバーライド:

クラス Component 内の getInputMethodRequests

戻り値:

このコンポーネントのインプットメソッド要求ハンドラ。デフォルトでは null

関連項目:

Component.addInputMethodListener(java.awt.event.InputMethodListener)

addInputMethodListener

public void addInputMethodListener(InputMethodListener l)

クラス Component の記述:

このコンポーネントからインプットメソッドイベントを受け取るために、指定されたインプットメソッドリスナーを追加します。InputMethodRequests のインスタンスを返すように getInputMethodRequests もオーバーライドする場合、コンポーネントはインプットメソッドからインプットメソッドイベントを受け取るだけです。リスナー l が null の場合、例外はスローされず、処理も実行されません。

AWT スレッドモデルの詳細については、「AWT Threading Issues」を参照してください。

オーバーライド:

クラス Component 内の addInputMethodListener

パラメータ:

l - インプットメソッドリスナー

関連項目:

InputMethodEvent, InputMethodListener, Component.removeInputMethodListener(java.awt.event.InputMethodListener), Component.getInputMethodListeners(), Component.getInputMethodRequests()