|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.eclipse.swt.widgets.Widget org.eclipse.swt.widgets.Control org.eclipse.swt.widgets.Scrollable org.eclipse.swt.widgets.Text
Instances of this class are selectable user interface objects that allow the user to enter and modify text.
Note: Only one of the styles MULTI and SINGLE may be specified.
IMPORTANT: This class is not intended to be subclassed.
Field Summary | |
static java.lang.String |
DELIMITER
The delimiter used by multi-line text widgets. |
static int |
LIMIT
The maximum number of characters that can be entered into a text widget. |
Constructor Summary | |
Text(Composite parent,
int style)
Constructs a new instance of this class given its parent and a style value describing its behavior and appearance. |
Method Summary | |
void |
addModifyListener(ModifyListener listener)
Adds the listener to the collection of listeners who will be notified when the receiver's text is modified, by sending it one of the messages defined in the ModifyListener
interface. |
void |
addSelectionListener(SelectionListener listener)
Adds the listener to the collection of listeners who will be notified when the control is selected, by sending it one of the messages defined in the SelectionListener
interface. |
void |
addVerifyListener(VerifyListener listener)
Adds the listener to the collection of listeners who will be notified when the receiver's text is verified, by sending it one of the messages defined in the VerifyListener
interface. |
void |
append(java.lang.String string)
Appends a string. |
void |
clearSelection()
Clears the selection. |
void |
copy()
Copies the selected text. |
void |
cut()
Cuts the selected text. |
int |
getCaretLineNumber()
Returns the line number of the caret. |
Point |
getCaretLocation()
Returns a point describing the receiver's location relative to its parent (or its display if its parent is null). |
int |
getCaretPosition()
Returns the character position of the caret. |
int |
getCharCount()
Returns the number of characters. |
boolean |
getDoubleClickEnabled()
Returns the double click enabled flag. |
char |
getEchoChar()
Returns the echo character. |
boolean |
getEditable()
Returns the editable state. |
int |
getLineCount()
Returns the number of lines. |
java.lang.String |
getLineDelimiter()
Returns the line delimiter. |
int |
getLineHeight()
Returns the height of a line. |
int |
getOrientation()
Returns the orientation of the receiver, which will be one of the constants SWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT . |
Point |
getSelection()
Returns a Point whose x coordinate is the
character position representing the start of the selected
text, and whose y coordinate is the character position
representing the end of the selection. |
int |
getSelectionCount()
Returns the number of selected characters. |
java.lang.String |
getSelectionText()
Gets the selected text, or an empty string if there is no current selection. |
java.lang.String |
getText()
Returns the widget text. |
java.lang.String |
getText(int start,
int end)
Returns a range of text. |
int |
getTextLimit()
Returns the maximum number of characters that the receiver is capable of holding. |
int |
getTopIndex()
Returns the zero-relative index of the line which is currently at the top of the receiver. |
int |
getTopPixel()
Returns the top pixel. |
void |
insert(java.lang.String string)
Inserts a string. |
void |
paste()
Pastes text from clipboard. |
void |
removeModifyListener(ModifyListener listener)
Removes the listener from the collection of listeners who will be notified when the receiver's text is modified. |
void |
removeSelectionListener(SelectionListener listener)
Removes the listener from the collection of listeners who will be notified when the control is selected. |
void |
removeVerifyListener(VerifyListener listener)
Removes the listener from the collection of listeners who will be notified when the control is verified. |
void |
selectAll()
Selects all the text in the receiver. |
void |
setDoubleClickEnabled(boolean doubleClick)
Sets the double click enabled flag. |
void |
setEchoChar(char echo)
Sets the echo character. |
void |
setEditable(boolean editable)
Sets the editable state. |
void |
setOrientation(int orientation)
Sets the orientation of the receiver, which must be one of the constants SWT.LEFT_TO_RIGHT or SWT.RIGHT_TO_LEFT . |
void |
setSelection(int start)
Sets the selection. |
void |
setSelection(int start,
int end)
Sets the selection to the range specified by the given start and end indices. |
void |
setSelection(Point selection)
Sets the selection to the range specified by the given point, where the x coordinate represents the start index and the y coordinate represents the end index. |
void |
setText(java.lang.String string)
Sets the contents of the receiver to the given string. |
void |
setTextLimit(int limit)
Sets the maximum number of characters that the receiver is capable of holding to be the argument. |
void |
setTopIndex(int index)
Sets the zero-relative index of the line which is currently at the top of the receiver. |
void |
showSelection()
Shows the selection. |
Methods inherited from class org.eclipse.swt.widgets.Scrollable |
computeTrim, getClientArea, getHorizontalBar, getVerticalBar |
Methods inherited from class org.eclipse.swt.widgets.Widget |
addDisposeListener, addListener, checkSubclass, checkWidget, dispose, getData, getData, getDisplay, getStyle, isDisposed, isListening, notifyListeners, removeDisposeListener, removeListener, removeListener, setData, setData, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int LIMIT
Note that this value is platform dependent, based upon the native widget implementation.
public static final java.lang.String DELIMITER
Constructor Detail |
public Text(Composite parent, int style)
The style value is either one of the style constants defined in
class SWT
which is applicable to instances of this
class, or must be built by bitwise OR'ing together
(that is, using the int
"|" operator) two or more
of those SWT
style constants. The class description
lists the style constants that are applicable to the class.
Style bits are also inherited from superclasses.
parent
- a composite control which will be the parent of the new instance (cannot be null)style
- the style of control to construct
java.lang.IllegalArgumentException
- SWTException
- SWT.SINGLE
,
SWT.MULTI
,
SWT.READ_ONLY
,
SWT.WRAP
,
Widget.checkSubclass()
,
Widget.getStyle()
Method Detail |
public void addModifyListener(ModifyListener listener)
ModifyListener
interface.
listener
- the listener which should be notified
java.lang.IllegalArgumentException
- SWTException
- ModifyListener
,
removeModifyListener(org.eclipse.swt.events.ModifyListener)
public void addSelectionListener(SelectionListener listener)
SelectionListener
interface.
widgetSelected
is not called for texts.
widgetDefaultSelected
is typically called when ENTER is pressed in a single-line text.
listener
- the listener which should be notified
java.lang.IllegalArgumentException
- SWTException
- SelectionListener
,
removeSelectionListener(org.eclipse.swt.events.SelectionListener)
,
SelectionEvent
public void addVerifyListener(VerifyListener listener)
VerifyListener
interface.
listener
- the listener which should be notified
java.lang.IllegalArgumentException
- SWTException
- VerifyListener
,
removeVerifyListener(org.eclipse.swt.events.VerifyListener)
public void append(java.lang.String string)
The new text is appended to the text at the end of the widget.
string
- the string to be appended
java.lang.IllegalArgumentException
- SWTException
- public void clearSelection()
SWTException
- public void copy()
The current selection is copied to the clipboard.
SWTException
- public void cut()
The current selection is first copied to the clipboard and then deleted from the widget.
SWTException
- public int getCaretLineNumber()
The line number of the caret is returned.
SWTException
- public Point getCaretLocation()
The location of the caret is returned.
SWTException
- public int getCaretPosition()
Indexing is zero based.
SWTException
- public int getCharCount()
SWTException
- public boolean getDoubleClickEnabled()
The double click flag enables or disables the default action of the text widget when the user double clicks.
SWTException
- public char getEchoChar()
The echo character is the character that is displayed when the user enters text or the text is changed by the programmer.
SWTException
- setEchoChar(char)
public boolean getEditable()
SWTException
- public int getLineCount()
SWTException
- public java.lang.String getLineDelimiter()
SWTException
- DELIMITER
public int getLineHeight()
SWTException
- public int getOrientation()
SWT.LEFT_TO_RIGHT
or SWT.RIGHT_TO_LEFT
.
SWTException
- public Point getSelection()
Point
whose x coordinate is the
character position representing the start of the selected
text, and whose y coordinate is the character position
representing the end of the selection. An "empty" selection
is indicated by the x and y coordinates having the same value.
Indexing is zero based. The range of a selection is from 0..N where N is the number of characters in the widget.
SWTException
- public int getSelectionCount()
SWTException
- public java.lang.String getSelectionText()
SWTException
- public java.lang.String getText()
The text for a text widget is the characters in the widget, or an empty string if this has never been set.
SWTException
- public java.lang.String getText(int start, int end)
Indexing is zero based. The range of a selection is from 0..N-1 where N is the number of characters in the widget.
start
- the start of the rangeend
- the end of the range
SWTException
- public int getTextLimit()
If this has not been changed by setTextLimit()
,
it will be the constant Text.LIMIT
.
SWTException
- LIMIT
public int getTopIndex()
This index can change when lines are scrolled or new lines are added or removed.
SWTException
- public int getTopPixel()
The top pixel is the pixel position of the line that is currently at the top of the widget. On some platforms, a text widget can be scrolled by pixels instead of lines so that a partial line is displayed at the top of the widget.
The top pixel changes when the widget is scrolled. The top pixel does not include the widget trimming.
SWTException
- public void insert(java.lang.String string)
The old selection is replaced with the new text.
string
- the string
java.lang.IllegalArgumentException
- null
SWTException
- public void paste()
The selected text is deleted from the widget and new text inserted from the clipboard.
SWTException
- public void removeModifyListener(ModifyListener listener)
listener
- the listener which should no longer be notified
java.lang.IllegalArgumentException
- SWTException
- ModifyListener
,
addModifyListener(org.eclipse.swt.events.ModifyListener)
public void removeSelectionListener(SelectionListener listener)
listener
- the listener which should no longer be notified
java.lang.IllegalArgumentException
- SWTException
- SelectionListener
,
addSelectionListener(org.eclipse.swt.events.SelectionListener)
public void removeVerifyListener(VerifyListener listener)
listener
- the listener which should no longer be notified
java.lang.IllegalArgumentException
- SWTException
- VerifyListener
,
addVerifyListener(org.eclipse.swt.events.VerifyListener)
public void selectAll()
SWTException
- public void setDoubleClickEnabled(boolean doubleClick)
The double click flag enables or disables the default action of the text widget when the user double clicks.
Note: This operation is a hint and is not supported on platforms that do not have this concept.
doubleClick
- the new double click flag
SWTException
- public void setEchoChar(char echo)
The echo character is the character that is displayed when the user enters text or the text is changed by the programmer. Setting the echo character to '\0' clears the echo character and redraws the original text. If for any reason the echo character is invalid, or if the platform does not allow modification of the echo character, the default echo character for the platform is used.
echo
- the new echo character
SWTException
- public void setEditable(boolean editable)
editable
- the new editable state
SWTException
- public void setOrientation(int orientation)
SWT.LEFT_TO_RIGHT
or SWT.RIGHT_TO_LEFT
.
Note: This operation is a hint and is not supported on platforms that do not have this concept.
orientation
- new orientation style
SWTException
- public void setSelection(int start)
Indexing is zero based. The range of a selection is from 0..N where N is the number of characters in the widget.
Text selections are specified in terms of caret positions. In a text widget that contains N characters, there are N+1 caret positions, ranging from 0..N. This differs from other functions that address character position such as getText () that use the regular array indexing rules.
start
- new caret position
SWTException
- public void setSelection(int start, int end)
Indexing is zero based. The range of a selection is from 0..N where N is the number of characters in the widget.
Text selections are specified in terms of caret positions. In a text widget that contains N characters, there are N+1 caret positions, ranging from 0..N. This differs from other functions that address character position such as getText () that use the usual array indexing rules.
start
- the start of the rangeend
- the end of the range
SWTException
- public void setSelection(Point selection)
Indexing is zero based. The range of a selection is from 0..N where N is the number of characters in the widget.
Text selections are specified in terms of caret positions. In a text widget that contains N characters, there are N+1 caret positions, ranging from 0..N. This differs from other functions that address character position such as getText () that use the usual array indexing rules.
selection
- the point
java.lang.IllegalArgumentException
- SWTException
- public void setText(java.lang.String string)
string
- the new text
java.lang.IllegalArgumentException
- SWTException
- public void setTextLimit(int limit)
Instead of trying to set the text limit to zero, consider creating a read-only text widget.
Specifying a limit value larger than Text.LIMIT
sets the
receiver's limit to Text.LIMIT
.
limit
- new text limit
java.lang.IllegalArgumentException
- SWTException
- public void setTopIndex(int index)
index
- the index of the top item
SWTException
- public void showSelection()
If the selection is already showing in the receiver, this method simply returns. Otherwise, lines are scrolled until the selection is visible.
SWTException
-
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |