javax.swing
クラス JTextArea
java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.text.JTextComponent
javax.swing.JTextArea
- すべての実装されたインタフェース:
- ImageObserver, MenuContainer, Serializable, Accessible, Scrollable
public class JTextArea
- extends JTextComponent
JTextArea
は、プレーンテキストを表示する複数行の領域です。この処理を適切に行う java.awt.TextArea
クラスとのソースの互換性を提供する軽量コンポーネントとして用意されています。テキストコンポーネントの詳細および例については、「The Java Tutorial」の「Using Text Components」を参照してください。
このコンポーネントは、java.awt.TextArea
クラスにはない機能を備えています。追加機能については、スーパークラスを参照してください。より多くの機能を備えた複数行テキストクラスとして、ほかに JTextPane
と JEditorPane
があります。
java.awt.TextArea
は内部的にスクロールを処理します。JTextArea
はスクロールを管理しない点では異なりますが、Swing の Scrollable
インタフェースを実装します。これにより、そのインタフェースをスクロール動作が必要な場合に JScrollPane
の内部に配置し、スクロールの動作が不要な場合に直接使えるようにできます。
java.awt.TextArea
は行折り返しを行う機能を備えています。これは、水平スクロールポリシーで制御されていました。スクロールは JTextArea
によって直接実行されるのではないので、下位互換は別の方法で提供されなければなりません。JTextArea
は、行を折り返すかどうかを制御する行折り返しのバウンドプロパティを持ちます。デフォルトでは、行折り返しプロパティは false (折り返さない) に設定されています。
java.awt.TextArea
には、適切なサイズを指定するのに使用される rows
および columns
の 2 つのプロパティがあります。JTextArea
はこれらのプロパティを使って、java.awt.TextArea
で提供される機能と一致するように JScrollPane
の内部にビューポートを配置する際の適切なサイズを示します。JTextArea
には、テキストすべての表示に必要となる最適なサイズが用意されているので、ビューポートは JScrollPane
の内部で適切に機能します。rows
または columns
の値が 0 のとき、その軸に沿った最適なサイズが、同じ軸に沿ったビューポートの適切なサイズに使用されます。
java.awt.TextArea
の変更を監視するには、TextEvent
の TextListener
を追加します。JTextComponent
ベースのコンポーネントでは、DocumentEvent
経由でモデルから DocumentListeners
に変更が送られます。DocumentEvent
は必要に応じて、変更位置と変更の種類を提供します。コードは次のようになります。
DocumentListener myListener = ??;
JTextArea myArea = ??;
myArea.getDocument().addDocumentListener(myListener);
改行 改行の処理方法については、DefaultEditorKit を参照してください。
警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。JDK バージョン 1.4 以降、すべての JavaBeans™ の長期間の運用サポートは、java.beans
パッケージに追加されています。詳細は、XMLEncoder
を参照してください。
- 関連項目:
JTextPane
,
JEditorPane
コンストラクタの概要 |
JTextArea()
新しい TextArea を構築します。 |
JTextArea(Document doc)
指定されたドキュメントモデルと、ほかの引数はすべてデフォルト (null, 0, 0) で、新しい JTextArea を構築します。 |
JTextArea(Document doc,
String text,
int rows,
int columns)
指定された行数と列数、および指定されたモデルで新しい JTextArea を構築します。 |
JTextArea(int rows,
int columns)
指定された行数と列数で新しい空の TextArea を構築します。 |
JTextArea(String text)
指定された表示テキストで新しい TextArea を構築します。 |
JTextArea(String text,
int rows,
int columns)
指定されたテキストと行数と列数で新しい TextArea を構築します。 |
クラス javax.swing.text.JTextComponent から継承されたメソッド |
addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, replaceSelection, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDocument, setDragEnabled, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setText, setUI, updateUI, viewToModel, write |
クラス javax.swing.JComponent から継承されたメソッド |
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, 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, 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 |
JTextArea
public JTextArea()
- 新しい TextArea を構築します。デフォルトモデルが設定され、初期文字列は null、行/列数は 0 に設定されます。
JTextArea
public JTextArea(String text)
- 指定された表示テキストで新しい TextArea を構築します。デフォルトモデルが作成され、行/列数は 0 に設定されます。
- パラメータ:
text
- 表示されるテキストまたは null
JTextArea
public JTextArea(int rows,
int columns)
- 指定された行数と列数で新しい空の TextArea を構築します。デフォルトモデルが作成され、初期文字列は null に設定されます。
- パラメータ:
rows
- 行数 >= 0columns
- 列数 >= 0
- 例外:
IllegalArgumentException
- 行または列の引数が負の値である場合
JTextArea
public JTextArea(String text,
int rows,
int columns)
- 指定されたテキストと行数と列数で新しい TextArea を構築します。デフォルトモデルが作成されます。
- パラメータ:
text
- 表示されるテキストまたは nullrows
- 行数 >= 0columns
- 列数 >= 0
- 例外:
IllegalArgumentException
- 行または列の引数が負の値である場合
JTextArea
public JTextArea(Document doc)
- 指定されたドキュメントモデルと、ほかの引数はすべてデフォルト (null, 0, 0) で、新しい JTextArea を構築します。
- パラメータ:
doc
- 使用するモデル
JTextArea
public JTextArea(Document doc,
String text,
int rows,
int columns)
- 指定された行数と列数、および指定されたモデルで新しい JTextArea を構築します。コンストラクタのすべては、このコンストラクタに波及効果をもたらします。
- パラメータ:
doc
- 使用するモデル。ただし null の場合は、デフォルトモデルを作成するtext
- 表示されるテキスト。ない場合は nullrows
- 行数 >= 0columns
- 列数 >= 0
- 例外:
IllegalArgumentException
- 行または列の引数が負の値である場合
getUIClassID
public String getUIClassID()
- UI のクラス ID を返します。
- オーバーライド:
- クラス
JComponent
内の getUIClassID
- 戻り値:
- ID (「TextAreaUI」)
- 関連項目:
JComponent.getUIClassID()
,
UIDefaults.getUI(javax.swing.JComponent)
createDefaultModel
protected Document createDefaultModel()
- モデルが明示的に指定されない場合は、構築時に使うモデルのデフォルト実装を作成します。 PlainDocument の新しいインスタンスが返されます。
- 戻り値:
- デフォルトのドキュメントモデル
setTabSize
public void setTabSize(int size)
- タブを展開する文字数を設定します。可変幅フォントに対しては最大有効幅が乗算されます。タブのサイズが変更されると、PropertyChange イベント (tabSize) が発生します。
- パラメータ:
size
- 展開する文字数- 関連項目:
getTabSize()
getTabSize
public int getTabSize()
- タブを展開するのに使う文字の数を返します。ドキュメントが null の場合、あるいはタブ設定を持たない場合は、デフォルトの 8 を返します。
- 戻り値:
- 文字数
setLineWrap
public void setLineWrap(boolean wrap)
- テキスト領域の行折り返しポリシーを設定します。true に設定すると、割り当て幅に収まりきらない長さの行は折り返されます。false に設定すると、行は折り返されません。ポリシーを変更すると、
PropertyChange
イベント (lineWrap) が発生します。デフォルトでは、このプロパティは false です。
- パラメータ:
wrap
- 行を折り返すかどうかを示す- 関連項目:
getLineWrap()
getLineWrap
public boolean getLineWrap()
- テキスト領域の行折り返しポリシーを返します。true に設定すると、割り当て幅に収まりきらない長さの行は折り返されます。false に設定すると、行は折り返されません。
- 戻り値:
- 行が折り返されるかどうか
setWrapStyleWord
public void setWrapStyleWord(boolean word)
- テキスト領域が折り返し行の場合に使う折り返し書式を設定します。true に設定すると、割り当て幅に収まりきらない長さの行はワード境界 (空白部分) で折り返されます。false に設定すると、行は文字境界で折り返されます。デフォルトではこのプロパティは false です。
- パラメータ:
word
- 行折り返しにワード境界を使うかどうかを示す- 関連項目:
getWrapStyleWord()
getWrapStyleWord
public boolean getWrapStyleWord()
- テキスト領域が折り返し行の場合に使う折り返し書式を返します。true に設定すると、割り当て幅に収まりきらない長さの行はワード境界 (空白部分) で折り返されます。false に設定すると、行は文字境界で折り返されます。
- 戻り値:
- 折り返し書式が文字境界でなくワード境界かどうか
- 関連項目:
setWrapStyleWord(boolean)
getLineOfOffset
public int getLineOfOffset(int offset)
throws BadLocationException
- コンポーネントテキストのオフセットを行番号に変換します。
- パラメータ:
offset
- オフセット >= 0
- 戻り値:
- 行番号 >= 0
- 例外:
BadLocationException
- オフセットがゼロより小さい場合、またはドキュメントの長さより大きい場合
getLineCount
public int getLineCount()
- 領域内に収める行数を返します。
- 戻り値:
- 行数 > 0
getLineStartOffset
public int getLineStartOffset(int line)
throws BadLocationException
- 指定された行の開始オフセットを返します。
- パラメータ:
line
- 変換対象の行番号 >= 0
- 戻り値:
- オフセット >= 0
- 例外:
BadLocationException
- 行がゼロより小さい場合、またはドキュメント内の行数 (getLineCount によって報告される) より大きいか等しい場合
getLineEndOffset
public int getLineEndOffset(int line)
throws BadLocationException
- 指定された行の終了オフセットを返します。
- パラメータ:
line
- 行 >= 0
- 戻り値:
- オフセット >= 0
- 例外:
BadLocationException
- 行がゼロより小さい場合、またはドキュメント内の行数 (getLineCount によって報告される) より大きいか等しい場合
insert
public void insert(String str,
int pos)
- 指定されたテキストを指定の位置に挿入します。モデルが null の場合、あるいはテキストが null または空の場合は何も行いません。
このメソッドはスレッドセーフですが、ほとんどの Swing メソッドは違います。詳細は、「Threads and Swing」を参照してください。
- パラメータ:
str
- 挿入するテキストpos
- 挿入位置 >= 0
- 例外:
IllegalArgumentException
- pos がモデル内の無効な位置の場合- 関連項目:
TextComponent.setText(java.lang.String)
,
replaceRange(java.lang.String, int, int)
append
public void append(String str)
- 指定されたテキストをドキュメントの末尾に追加します。モデルが null の場合、あるいは文字列が null か空の場合には何も行いません。
このメソッドはスレッドセーフですが、ほとんどの Swing メソッドは違います。詳細は、「Threads and Swing」を参照してください。
- パラメータ:
str
- 挿入するテキスト- 関連項目:
insert(java.lang.String, int)
replaceRange
public void replaceRange(String str,
int start,
int end)
- 指定された開始位置から終了位置までのテキストを、新しい指定テキストで置き換えます。モデルが null の場合は何も行いません。新しい文字列が null または空の場合は、単純に delete を実行します。
このメソッドはスレッドセーフですが、ほとんどの Swing メソッドは違います。詳細は、「Threads and Swing」を参照してください。
- パラメータ:
str
- 置き換えに使用するテキストstart
- 開始位置 >= 0end
- 終了位置 >= start
- 例外:
IllegalArgumentException
- 範囲の一部がモデル内の無効な位置にある場合- 関連項目:
insert(java.lang.String, int)
,
replaceRange(java.lang.String, int, int)
getRows
public int getRows()
- TextArea 内の行数を返します。
- 戻り値:
- 行数 >= 0
setRows
public void setRows(int rows)
- この TextArea の行数を設定します。新しい値を設定したあとに invalidate() を呼び出します。
- パラメータ:
rows
- 行数 >= 0
- 例外:
IllegalArgumentException
- 行が 0 より小さい場合- 関連項目:
getRows()
getRowHeight
protected int getRowHeight()
- 行の高さの意味を返します。このデフォルトはフォントの高さです。
- 戻り値:
- 高さ >= 1
getColumns
public int getColumns()
- TextArea 内の列数を返します。
- 戻り値:
- 列数 >= 0
setColumns
public void setColumns(int columns)
- この TextArea の列数を設定します。新しい値を設定したあとに invalidate() を実行します。
- パラメータ:
columns
- 列数 >= 0
- 例外:
IllegalArgumentException
- 列数が 0 より小さい場合- 関連項目:
getColumns()
getColumnWidth
protected int getColumnWidth()
- 列幅を返します。フォントによっては、列はあまり意味を持たないと考えられます。このメソッドを使うと、列の幅を定義できます。これはデフォルトで、使用フォントの文字「m」の幅で定義されます。このメソッドは、異なる幅になるように再定義できます。
- 戻り値:
- 列幅 >= 1
getPreferredSize
public Dimension getPreferredSize()
- TextArea の適切なサイズを返します。これは、テキストの表示に必要となるサイズとビューポートに要求されるサイズの大きい方です。
- オーバーライド:
- クラス
JComponent
内の getPreferredSize
- 戻り値:
- サイズ
- 関連項目:
JComponent.setPreferredSize(java.awt.Dimension)
,
ComponentUI
setFont
public void setFont(Font f)
- 現在のフォントを設定します。キャッシュされた行の高さと列の幅を削除して新しいフォントの設定が反映されるようにし、revalidate() を呼び出します。
- オーバーライド:
- クラス
JComponent
内の setFont
- パラメータ:
f
- 現在のフォントとして使うフォント- 関連項目:
Component.getFont()
paramString
protected String paramString()
- この JTextArea の文字列表現を返します。このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なります。返される文字列は空の場合がありますが、
null
にはなりません。
- オーバーライド:
- クラス
JTextComponent
内の paramString
- 戻り値:
- この JTextArea の文字列表現
getScrollableTracksViewportWidth
public boolean getScrollableTracksViewportWidth()
- ビューポートが常にこの Scrollable の幅を強制的にビューポートの幅に一致させようとする場合に true を返します。これを実装すると、行折り返しポリシーが true の場合は true を返し、行が折り返されない場合は false を返します。
- 定義:
- インタフェース
Scrollable
内の getScrollableTracksViewportWidth
- オーバーライド:
- クラス
JTextComponent
内の getScrollableTracksViewportWidth
- 戻り値:
- ビューポートが Scrollable の幅を強制的にそれ自体に一致させる場合は true
getPreferredScrollableViewportSize
public Dimension getPreferredScrollableViewportSize()
- このコンポーネントが JScrollPane に組み込まれている場合はビューポートの適切なサイズを返します。望ましい行と列が設定されている場合はそれを使い、そうでない場合はスーパークラスの動作が使われます。
- 定義:
- インタフェース
Scrollable
内の getPreferredScrollableViewportSize
- オーバーライド:
- クラス
JTextComponent
内の getPreferredScrollableViewportSize
- 戻り値:
- ビューがこの Scrollable である JViewport の preferredSize
- 関連項目:
JComponent.getPreferredSize()
getScrollableUnitIncrement
public int getScrollableUnitIncrement(Rectangle visibleRect,
int orientation,
int direction)
- 論理行または列を表示するコンポーネントは、方向の値に基づいて、新しい行または列を完全に表示するスクロール増分値を計算します。このメソッドを実装すると、
getRowHeight
メソッドと getColumnWidth
メソッドが返す値を使うことができます。
JScrollPane などのスクロールコンテナは、ユーザがユニットスクロールを要求すると、このメソッドを使用します。
- 定義:
- インタフェース
Scrollable
内の getScrollableUnitIncrement
- オーバーライド:
- クラス
JTextComponent
内の getScrollableUnitIncrement
- パラメータ:
visibleRect
- ビューポート内の可視のビュー領域orientation
- SwingConstants.VERTICAL または SwingConstants.HORIZONTALdirection
- 上または左にスクロールする場合は 0 より小さく、下または右にスクロールする場合は 0 より大きい
- 戻り値:
- 指定された方向にスクロールするための「ユニット」増分値
- 例外:
IllegalArgumentException
- 方向が無効な場合- 関連項目:
JScrollBar.setUnitIncrement(int)
,
getRowHeight()
,
getColumnWidth()
getAccessibleContext
public AccessibleContext getAccessibleContext()
- この JTextArea に関連した AccessibleContext を返します。JTextArea の場合、AccessibleContext は AccessibleJTextArea の形式を取ります。必要に応じて新しい AccessibleJTextArea インスタンスを作成します。
- 定義:
- インタフェース
Accessible
内の getAccessibleContext
- オーバーライド:
- クラス
JTextComponent
内の getAccessibleContext
- 戻り値:
- この JTextArea の AccessibleContext として機能する AccessibleJTextArea
バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。