JavaTM 2 Platform
Standard Ed. 6

java.awt
類別 TextComponent

java.lang.Object
  繼承者 java.awt.Component
      繼承者 java.awt.TextComponent
所有已實作的介面:
ImageObserver, MenuContainer, Serializable, Accessible
直接已知子類別:
TextArea, TextField

public class TextComponent
extends Component
implements Accessible

TextComponent 類別是所有允許編輯文本的元件的父級類別。

文本元件具體化文本字元串。TextComponent 類別定義了一組判斷此文本是否可編輯的方法。如果元件是可編輯的,則該類別還定義了另一組支持檔案插入符的方法。

此外,該類別定義了用於維護文本當前選擇 的方法。文本選擇是元件文本的子字元串,是編輯操作的目標。它也被稱為選定文本

從以下版本開始:
JDK1.0
另請參見:
序列化表格

巢狀類別摘要
protected  class TextComponent.AccessibleAWTTextComponent
          此類別實作對 TextComponent 類別的可存取性支持。
 
從類別 java.awt.Component 繼承的巢狀類別/介面
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
欄位摘要
protected  TextListener textListener
           
 
從類別 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
 
方法摘要
 void addNotify()
          通過將此 Component 連接到一個本機螢幕資源,使其成為可顯示的。
 void addTextListener(TextListener l)
          添加指定的文本事件偵聽器,以接收此文本元件發出的文本事件。
 void enableInputMethods(boolean enable)
          啟用或禁用此文本元件的輸入法支持。
 AccessibleContext getAccessibleContext()
          獲取與此 TextComponent 關聯的 AccessibleContext。
 Color getBackground()
          獲得此文本元件的背景色。
 int getCaretPosition()
          返回文本插入符的位置。
 InputMethodRequests getInputMethodRequests()
          獲取輸入方法請求處理程序,該處理程序支持此元件輸入方法發出的請求。
<T extends EventListener>
T[]
getListeners(Class<T> listenerType)
          返回當前已在此 TextComponent 上註冊為 FooListener 的所有物件的陣列。
 String getSelectedText()
          返回此文本元件所表示文本的選定文本。
 int getSelectionEnd()
          獲取此文本元件中選定文本的結束位置。
 int getSelectionStart()
          獲取此文本元件中選定文本的開始位置。
 String getText()
          返回此文本元件表示的文本。
 TextListener[] getTextListeners()
          返回在此文本元件上所有已註冊文本偵聽器的陣列。
 boolean isEditable()
          指示此文本元件是否可編輯。
protected  String paramString()
          返回表示此 TextComponent 狀態的字元串。
protected  void processEvent(AWTEvent e)
          處理此文本元件上發生的事件。
protected  void processTextEvent(TextEvent e)
          處理發生在此文本元件上的文本事件:將這些事件指派給所有已註冊的 TextListener 物件。
 void removeNotify()
          移除 TextComponent 的同位體。
 void removeTextListener(TextListener l)
          移除指定的文本事件偵聽器,不再接收此文本元件發出的文本事件。
 void select(int selectionStart, int selectionEnd)
          選擇指定開始位置和結束位置之間的文本。
 void selectAll()
          選擇此文本元件中的所有文本。
 void setBackground(Color c)
          設置此文本元件的背景色。
 void setCaretPosition(int position)
          設置文本插入符的位置。
 void setEditable(boolean b)
          設置判斷此文本元件是否可編輯的標誌。
 void setSelectionEnd(int selectionEnd)
          將此文本元件的選定結束位置設置為指定位置。
 void setSelectionStart(int selectionStart)
          將此文本元件的選定開始位置設置為指定位置。
 void setText(String t)
          將此文本元件顯示的文本設置為指定文本。
 
從類別 java.awt.Component 繼承的方法
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, update, validate
 
從類別 java.lang.Object 繼承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

欄位詳細資訊

textListener

protected transient TextListener textListener
方法詳細資訊

enableInputMethods

public void enableInputMethods(boolean enable)
啟用或禁用此文本元件的輸入法支持。如果啟用輸入法支持並且文本元件也能處理按鍵事件,則將傳入事件提供給當前輸入法;如果輸入法沒有使用它們,則它們只能由元件處理或被指派給它們的偵聽器。預設情況下,啟用還是禁用,以及如何啟用或禁用此文本組建的輸入法支持與實作有關。

覆寫:
類別 Component 中的 enableInputMethods
參數:
enable - 為 true 表示啟用;為 false 表示禁用
從以下版本開始:
1.2
另請參見:
Component.processKeyEvent(java.awt.event.KeyEvent)

getInputMethodRequests

public InputMethodRequests getInputMethodRequests()
從類別 Component 複製的描述
獲取輸入方法請求處理程序,該處理程序支持此元件輸入方法發出的請求。支持當場文本輸入的元件必須覆寫此方法,以便返回一個 InputMethodRequests 實例。同時,還必須處理輸入方法事件。

覆寫:
類別 Component 中的 getInputMethodRequests
返回:
元件的輸入方法請求處理程序,預設為 null
另請參見:
Component.addInputMethodListener(java.awt.event.InputMethodListener)

addNotify

public void addNotify()
通過將此 Component 連接到一個本機螢幕資源,使其成為可顯示的。此方法由工具套件內部調用,不應直接由程序調用。

覆寫:
類別 Component 中的 addNotify
另請參見:
removeNotify()

removeNotify

public void removeNotify()
移除 TextComponent 的同位體。該同位體允許我們修改 TextComponent 的外觀,而不更改其功能。

覆寫:
類別 Component 中的 removeNotify
另請參見:
Component.isDisplayable(), Component.addNotify()

setText

public void setText(String t)
將此文本元件顯示的文本設置為指定文本。

參數:
t - 新文本;如果此參數為 null,則將文本設置為空字元串 ""
另請參見:
getText()

getText

public String getText()
返回此文本元件表示的文本。預設情況下,此文本是一個空字元串。

返回:
TextComponent 的值
另請參見:
setText(java.lang.String)

getSelectedText

public String getSelectedText()
返回此文本元件所表示文本的選定文本。

返回:
此文本元件的選定文本
另請參見:
select(int, int)

isEditable

public boolean isEditable()
指示此文本元件是否可編輯。

返回:
如果此文本元件是可編輯的,則返回 true;否則返回 false
從以下版本開始:
JDK1.0
另請參見:
setEditable(boolean)

setEditable

public void setEditable(boolean b)
設置判斷此文本元件是否可編輯的標誌。

如果將該標誌設置為 true,則此文本元件變成使用者可編輯的。如果將該標誌設置為 false,則使用者無法更改此文本元件的文本。預設情況下,不可編輯的文本元件的背景色為 SystemColor.control。通過調用 setBackground 可以覆寫此預設值。

參數:
b - 指示此文本元件是否是使用者可編輯的標誌。
從以下版本開始:
JDK1.0
另請參見:
isEditable()

getBackground

public Color getBackground()
獲得此文本元件的背景色。預設情況下,不可編輯的文本元件的背景色為 SystemColor.control。通過調用 setBackground 可以覆寫此預設值。

覆寫:
類別 Component 中的 getBackground
返回:
此文本元件的背景色。如果此文本元件沒有背景色,則返回其父元件的背景色。
從以下版本開始:
JDK1.0
另請參見:
setBackground(Color)

setBackground

public void setBackground(Color c)
設置此文本元件的背景色。

覆寫:
類別 Component 中的 setBackground
參數:
c - 成為此文本元件顏色的顏色。如果此參數為 null,則此文本元件將繼承其父元件的背景色。
從以下版本開始:
JDK1.0
另請參見:
getBackground()

getSelectionStart

public int getSelectionStart()
獲取此文本元件中選定文本的開始位置。

返回:
選定文本的開始位置
另請參見:
setSelectionStart(int), getSelectionEnd()

setSelectionStart

public void setSelectionStart(int selectionStart)
將此文本元件的選定開始位置設置為指定位置。新的起始點限制在當前選定結束位置處或之前。並且不能將它設置為小於零,即小於元件文本的開始處。如果調用者提供的 selectionStart 值超出限度,則該方法暗中執行這些限制,操作不會失敗。

參數:
selectionStart - 選定文本的開始位置
從以下版本開始:
JDK1.1
另請參見:
getSelectionStart(), setSelectionEnd(int)

getSelectionEnd

public int getSelectionEnd()
獲取此文本元件中選定文本的結束位置。

返回:
選定文本的結束位置
另請參見:
setSelectionEnd(int), getSelectionStart()

setSelectionEnd

public void setSelectionEnd(int selectionEnd)
將此文本元件的選定結束位置設置為指定位置。新的結束點限制在當前選定開始位置處或之後。並且不能將它設置為超出元件文本末端。如果調用者提供的 selectionEnd 值超出限度,則該方法暗中執行這些限制,操作不會失敗。

參數:
selectionEnd - 選定文本的結束位置
從以下版本開始:
JDK1.1
另請參見:
getSelectionEnd(), setSelectionStart(int)

select

public void select(int selectionStart,
                   int selectionEnd)
選擇指定開始位置和結束位置之間的文本。

此方法設置選定文本的開始位置和結束位置,並強行限制開始位置必須大於等於零。結束位置必須大於等於開始位置,並小於等於文本元件的文本長度。字元位置的索引從零開始。選擇文本的長度是 endPosition - startPosition,因此沒有選定 endPosition 處的字元。如果選定文本的開始位置和結束位置是相等的,則取消對所有文本的選擇。

如果調用者提供不一致或超出限度的值,則該方法暗中執行這些限制,操作不會失敗。具體來說,如果開始位置或結束位置大於文本長度,則將它重置為等於文本長度。如果開始位置小於零,則將它重置為零,如果結束位置小於開始位置,則將它重置為開始位置。

參數:
selectionStart - 要選定的首字元(char 值)從零開始的索引
selectionEnd - 要選定的文本從零開始的結束位置;selectionEnd 處的字元(char 值)未被選定
另請參見:
setSelectionStart(int), setSelectionEnd(int), selectAll()

selectAll

public void selectAll()
選擇此文本元件中的所有文本。

另請參見:
select(int, int)

setCaretPosition

public void setCaretPosition(int position)
設置文本插入符的位置。插入符的位置被限制在 0 和文本最後一個字元(包括)之間。如果傳入值大於此範圍,則將該值設置為最後一個字元(如果 TextComponent 不包含文本,則將該值設置為 0),並且不返回任何錯誤。如果傳入值小於 0,則拋出 IllegalArgumentException

參數:
position - 文本插入符的位置
拋出:
IllegalArgumentException - 如果 position 小於零
從以下版本開始:
JDK1.1

getCaretPosition

public int getCaretPosition()
返回文本插入符的位置。插入符的位置被限制在 0 和文本最後一個字元(包括)之間。如果沒有設置文本或插入符,則預設插入符的位置為 0。

返回:
文本插入符的位置
從以下版本開始:
JDK1.1
另請參見:
setCaretPosition(int)

addTextListener

public void addTextListener(TextListener l)
添加指定的文本事件偵聽器,以接收此文本元件發出的文本事件。如果 lnull,則不拋出任何異常,也不執行任何操作。

有關 AWT 執行緒網要的詳細資訊,請參考 AWT Threading Issues

參數:
l - 文本事件偵聽器
另請參見:
removeTextListener(java.awt.event.TextListener), getTextListeners(), TextListener

removeTextListener

public void removeTextListener(TextListener l)
移除指定的文本事件偵聽器,不再接收此文本元件發出的文本事件。如果 lnull,則不拋出任何異常,也不執行任何操作。

有關 AWT 執行緒網要的詳細資訊,請參考 AWT Threading Issues

參數:
l - 文本偵聽器
從以下版本開始:
JDK1.1
另請參見:
addTextListener(java.awt.event.TextListener), getTextListeners(), TextListener

getTextListeners

public TextListener[] getTextListeners()
返回在此文本元件上所有已註冊文本偵聽器的陣列。

返回:
此文本元件的所有 TextListener;如果當前沒有已註冊的文本偵聽器,則返回一個空陣列
從以下版本開始:
1.4
另請參見:
addTextListener(java.awt.event.TextListener), removeTextListener(java.awt.event.TextListener)

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)
返回當前已在此 TextComponent 上註冊為 FooListener 的所有物件的陣列。FooListener 是用 addFooListener 方法註冊的。

可以使用 class 文字值來指定 listenerType 參數,如 FooListener.class。例如,可以使用以下程式碼來查詢 TextComponent t 的文本偵聽器:

TextListener[] tls = (TextListener[])(t.getListeners(TextListener.class));
如果不存在這樣的偵聽器,則此方法返回一個空陣列。

覆寫:
類別 Component 中的 getListeners
參數:
listenerType - 請求的偵聽器型別;此參數應該指定一個從 java.util.EventListener 繼承的介面
返回:
在此文本元件上作為 FooListener 註冊的所有物件的陣列;如果尚未添加這樣的偵聽器,則返回一個空陣列
拋出:
ClassCastException - 如果 listenerType 未指定一個實作 java.util.EventListener 的類別或介面
從以下版本開始:
1.3
另請參見:
getTextListeners()

processEvent

protected void processEvent(AWTEvent e)
處理此文本元件上發生的事件。如果事件是 TextEvent,那麼它將調用 processTextEvent 方法,否則它將調用其父級類別的 processEvent

注意,如果事件參數為 null,則行為是不明確的,並可能導致異常。

覆寫:
類別 Component 中的 processEvent
參數:
e - 事件
另請參見:
Component.processComponentEvent(java.awt.event.ComponentEvent), Component.processFocusEvent(java.awt.event.FocusEvent), Component.processKeyEvent(java.awt.event.KeyEvent), Component.processMouseEvent(java.awt.event.MouseEvent), Component.processMouseMotionEvent(java.awt.event.MouseEvent), Component.processInputMethodEvent(java.awt.event.InputMethodEvent), Component.processHierarchyEvent(java.awt.event.HierarchyEvent), Component.processMouseWheelEvent(java.awt.event.MouseWheelEvent)

processTextEvent

protected void processTextEvent(TextEvent e)
處理發生在此文本元件上的文本事件:將這些事件指派給所有已註冊的 TextListener 物件。

註:如果沒有對此元件啟用文本事件,則不調用此方法。這發生在出現以下情況之一時:

注意,如果事件參數為 null,則行為是不明確的,並可能導致異常。

參數:
e - 文本事件
另請參見:
Component.enableEvents(long)

paramString

protected String paramString()
返回表示此 TextComponent 狀態的字元串。此方法僅用於除錯目的,對於各個實作,返回字元串的內容和格式可能有所不同。返回的字元串可能為空,但不可能為 null

覆寫:
類別 Component 中的 paramString
返回:
此文本元件的參數字元串

getAccessibleContext

public AccessibleContext getAccessibleContext()
獲取與此 TextComponent 關聯的 AccessibleContext。對於文本元件,AccessibleContext 採用 AccessibleAWTTextComponent 的形式。如有必要,可創建一個新的 AccessibleAWTTextComponent 實例。

指定者:
介面 Accessible 中的 getAccessibleContext
覆寫:
類別 Component 中的 getAccessibleContext
返回:
一個 AccessibleAWTTextComponent,它充當此 TextComponent 的 AccessibleContext
從以下版本開始:
1.3

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only