com.github.ilyes4j.gwt.mdl.components.textfields

Interface IsValueBoxBase<T>

Type Parameters:

T - the value type

All Known Implementing Classes:

ExpandingTextField, MultilineTextField, PasswordField, SingleLineTextField, TextField, TextfieldBase

public interface IsValueBoxBase<T>

Interface containing all the methods exposed by ValueBoxBase but not endorsed by any interface.

Author:

Mohamed Ilyes DIMASSI

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelKey() If a keyboard event is currently being handled on this text box, calling this method will suppress it.
int	getCursorPos() Gets the current position of the cursor (this also serves as the beginning of the text selection).
String	getSelectedText() Gets the text currently selected within this text box.
int	getSelectionLength() Gets the length of the current text selection.
T	getValueOrThrow() Return the parsed value, or null if the field is empty.
boolean	isReadOnly() Determines whether or not the widget is read-only.
void	selectAll() Selects all of the text in the box.
void	setAlignment(com.google.gwt.user.client.ui.ValueBoxBase.TextAlignment align)
void	setCursorPos(int pos) Sets the cursor position.
void	setReadOnly(boolean readOnly) Turns read-only mode on or off.
void	setSelectionRange(int pos, int length) Sets the range of text to be selected.

Method Detail

cancelKey

void cancelKey()

If a keyboard event is currently being handled on this text box, calling this method will suppress it. This allows listeners to easily filter keyboard input.

getCursorPos

int getCursorPos()

Gets the current position of the cursor (this also serves as the beginning of the text selection).

Returns:

the cursor's position

getSelectedText

String getSelectedText()

Gets the text currently selected within this text box.

Returns:

the selected text, or an empty string if none is selected

getSelectionLength

int getSelectionLength()

Gets the length of the current text selection.

Returns:

the text selection length

getValueOrThrow

T getValueOrThrow()
                  throws ParseException

Return the parsed value, or null if the field is empty.

Returns:

the value of the textbox

Throws:

ParseException - if the value cannot be parsed

isReadOnly

boolean isReadOnly()

Determines whether or not the widget is read-only.

Returns:

true if the widget is currently read-only, false if the widget is currently editable

selectAll

void selectAll()

Selects all of the text in the box. This will only work when the widget is attached to the document and not hidden.

setAlignment

void setAlignment(com.google.gwt.user.client.ui.ValueBoxBase.TextAlignment align)

Parameters:

align - defines how the text should be horizontally anchored

setCursorPos

void setCursorPos(int pos)

Sets the cursor position. This will only work when the widget is attached to the document and not hidden.

Parameters:

pos - the new cursor position

setReadOnly

void setReadOnly(boolean readOnly)

Turns read-only mode on or off.

Parameters:

readOnly - if true, the widget becomes read-only; if false the widget becomes editable

setSelectionRange

void setSelectionRange(int pos,
                     int length)

Sets the range of text to be selected. This will only work when the widget is attached to the document and not hidden.

Parameters:

pos - the position of the first character to be selected

length - the number of characters to be selected