|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.vaadin.terminal.AbstractClientConnector com.vaadin.ui.AbstractComponent com.vaadin.ui.AbstractField<String> com.vaadin.ui.AbstractTextField
public abstract class AbstractTextField
Nested Class Summary | |
---|---|
class |
AbstractTextField.TextChangeEventImpl
|
static class |
AbstractTextField.TextChangeEventMode
Different modes how the TextField can trigger FieldEvents.TextChangeEvent s. |
Nested classes/interfaces inherited from class com.vaadin.ui.AbstractField |
---|
AbstractField.FocusShortcut, AbstractField.ReadOnlyStatusChangeEvent |
Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent |
---|
AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler |
Nested classes/interfaces inherited from interface com.vaadin.terminal.VariableOwner |
---|
VariableOwner.ErrorEvent |
Nested classes/interfaces inherited from interface com.vaadin.ui.Component |
---|
Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener |
Nested classes/interfaces inherited from interface com.vaadin.terminal.Sizeable |
---|
Sizeable.Unit |
Nested classes/interfaces inherited from interface com.vaadin.ui.Field |
---|
Field.ValueChangeEvent |
Nested classes/interfaces inherited from interface com.vaadin.data.Buffered |
---|
Buffered.SourceException |
Nested classes/interfaces inherited from interface com.vaadin.data.Property |
---|
Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.Transactional<T>, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer |
Field Summary |
---|
Fields inherited from interface com.vaadin.terminal.Sizeable |
---|
SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS |
Constructor Summary | |
---|---|
protected |
AbstractTextField()
|
Method Summary | |
---|---|
void |
addListener(FieldEvents.BlurListener listener)
Adds a BlurListener to the Component which gets fired
when a Field loses keyboard focus. |
void |
addListener(FieldEvents.FocusListener listener)
Adds a FocusListener to the Component which gets fired
when a Field receives keyboard focus. |
void |
addListener(FieldEvents.TextChangeListener listener)
|
void |
changeVariables(Object source,
Map<String,Object> variables)
Called when one or more variables handled by the implementing class are changed. |
int |
getColumns()
Gets the number of columns in the editor. |
int |
getCursorPosition()
Returns the last known cursor position of the field. |
String |
getInputPrompt()
Gets the current input prompt. |
int |
getMaxLength()
Returns the maximum number of characters in the field. |
String |
getNullRepresentation()
Gets the null-string representation. |
AbstractTextFieldState |
getState()
Returns the shared state bean with information to be sent from the server to the client. |
AbstractTextField.TextChangeEventMode |
getTextChangeEventMode()
|
int |
getTextChangeTimeout()
Gets the timeout used to fire FieldEvents.TextChangeEvent s when the
getTextChangeEventMode() is AbstractTextField.TextChangeEventMode.LAZY or
AbstractTextField.TextChangeEventMode.TIMEOUT . |
Class<String> |
getType()
Returns the type of the Field. |
protected boolean |
isEmpty()
Is the field empty? In general, "empty" state is same as null. |
boolean |
isNullSettingAllowed()
Is setting nulls with null-string representation allowed. |
void |
paintContent(PaintTarget target)
Paints the Paintable into a UIDL stream. |
void |
removeListener(FieldEvents.BlurListener listener)
Removes a BlurListener from the Component. |
void |
removeListener(FieldEvents.FocusListener listener)
Removes a FocusListener from the Component. |
void |
removeListener(FieldEvents.TextChangeListener listener)
|
void |
selectAll()
Selects all text in the field. |
void |
setColumns(int columns)
Sets the number of columns in the editor. |
void |
setCursorPosition(int pos)
Sets the cursor position in the field. |
void |
setInputPrompt(String inputPrompt)
Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input. |
protected void |
setInternalValue(String newValue)
Sets the internal field value. |
void |
setMaxLength(int maxLength)
Sets the maximum number of characters in the field. |
void |
setNullRepresentation(String nullRepresentation)
Sets the null-string representation. |
void |
setNullSettingAllowed(boolean nullSettingAllowed)
Sets the null conversion mode. |
void |
setSelectionRange(int pos,
int length)
Sets the range of text to be selected. |
void |
setTextChangeEventMode(AbstractTextField.TextChangeEventMode inputEventMode)
Sets the mode how the TextField triggers FieldEvents.TextChangeEvent s. |
void |
setTextChangeTimeout(int timeout)
The text change timeout modifies how often text change events are communicated to the application when getTextChangeEventMode() is
AbstractTextField.TextChangeEventMode.LAZY or AbstractTextField.TextChangeEventMode.TIMEOUT . |
void |
setValue(Object newValue)
Sets the value of the field. |
void |
updateState()
Called before the shared state is sent to the client. |
Methods inherited from class com.vaadin.terminal.AbstractClientConnector |
---|
addExtension, addMethodInvocationToQueue, createState, getAllChildrenIterable, getConnectorId, getExtensions, getRpcManager, getRpcProxy, getStateType, registerRpc, registerRpc, removeExtension, requestRepaintAll, retrievePendingRpcCalls |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.vaadin.terminal.VariableOwner |
---|
isEnabled, isImmediate |
Methods inherited from interface com.vaadin.ui.Component |
---|
addListener, addStyleName, attach, getApplication, getCaption, getDebugId, getIcon, getLocale, getParent, getRoot, getStyleName, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setDebugId, setEnabled, setIcon, setReadOnly, setStyleName, setVisible |
Methods inherited from interface com.vaadin.terminal.gwt.server.ClientConnector |
---|
detach, getExtensions, getStateType, isConnectorEnabled, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setParent |
Methods inherited from interface com.vaadin.terminal.gwt.client.Connector |
---|
getConnectorId |
Methods inherited from interface com.vaadin.terminal.gwt.server.RpcTarget |
---|
getRpcManager |
Methods inherited from interface com.vaadin.terminal.Sizeable |
---|
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setSizeFull, setSizeUndefined, setWidth, setWidth |
Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier |
---|
addShortcutListener, removeShortcutListener |
Constructor Detail |
---|
protected AbstractTextField()
Method Detail |
---|
public AbstractTextFieldState getState()
AbstractComponent
getState
in interface Connector
getState
in interface Component
getState
in class AbstractField<String>
public void updateState()
Component
This method must not alter the component hierarchy in any way.
updateState
in interface Component
updateState
in class AbstractField<String>
public void paintContent(PaintTarget target) throws PaintException
Vaadin6Component
Paints the Paintable into a UIDL stream. This method creates the UIDL sequence describing it and outputs it to the given UIDL stream.
It is called when the contents of the component should be painted in response to the component first being shown or having been altered so that its visual representation is changed.
paintContent
in interface Vaadin6Component
target
- the target UIDL stream where the component should paint itself
to.
PaintException
- if the paint operation failed.public void changeVariables(Object source, Map<String,Object> variables)
VariableOwner
changeVariables
in interface VariableOwner
source
- the Source of the variable change. This is the origin of the
event. For example in Web Adapter this is the request.variables
- the Mapping from variable names to new variable values.public Class<String> getType()
AbstractField
getValue
and
setValue
must be compatible with this type: one must be able
to safely cast the value returned from getValue
to the given
type and pass any variable assignable to this type as an argument to
setValue
.
getType
in interface Property<String>
getType
in class AbstractField<String>
public String getNullRepresentation()
The null-valued strings are represented on the user interface by replacing the null value with this string. If the null representation is set null (not 'null' string), painting null value throws exception.
The default value is string 'null'.
isNullSettingAllowed()
public boolean isNullSettingAllowed()
If this property is true, writing null-representation string to text field always sets the field value to real null. If this property is false, null setting is not made, but the null values are maintained. Maintenance of null-values is made by only converting the textfield contents to real null, if the text field matches the null-string representation and the current value of the field is null.
By default this setting is false
getNullRepresentation()
public void setNullRepresentation(String nullRepresentation)
The null-valued strings are represented on the user interface by replacing the null value with this string. If the null representation is set null (not 'null' string), painting null value throws exception.
The default value is string 'null'
nullRepresentation
- Textual representation for null strings.setNullSettingAllowed(boolean)
public void setNullSettingAllowed(boolean nullSettingAllowed)
If this property is true, writing null-representation string to text field always sets the field value to real null. If this property is false, null setting is not made, but the null values are maintained. Maintenance of null-values is made by only converting the textfield contents to real null, if the text field matches the null-string representation and the current value of the field is null.
By default this setting is false.
nullSettingAllowed
- Should the null-string representation always be converted to
null-values.getNullRepresentation()
protected boolean isEmpty()
AbstractField
isEmpty
in class AbstractField<String>
public int getMaxLength()
public void setMaxLength(int maxLength)
maxLength
- the maxLength to setpublic int getColumns()
public void setColumns(int columns)
columns
- the number of columns to set.public String getInputPrompt()
setInputPrompt(String)
public void setInputPrompt(String inputPrompt)
inputPrompt
- protected void setInternalValue(String newValue)
AbstractField
AbstractField.getInternalValue()
if necessary.
setInternalValue
in class AbstractField<String>
newValue
- the new value to be set.public void setValue(Object newValue) throws Property.ReadOnlyException
AbstractField
setValue
in interface Property<String>
setValue
in class AbstractField<String>
newValue
- the New value of the field.
Property.ReadOnlyException
- if the object is in read-only modepublic void setTextChangeEventMode(AbstractTextField.TextChangeEventMode inputEventMode)
FieldEvents.TextChangeEvent
s.
inputEventMode
- the new modeAbstractTextField.TextChangeEventMode
public AbstractTextField.TextChangeEventMode getTextChangeEventMode()
FieldEvents.TextChangeEvent
s.public void addListener(FieldEvents.TextChangeListener listener)
addListener
in interface FieldEvents.TextChangeNotifier
public void removeListener(FieldEvents.TextChangeListener listener)
removeListener
in interface FieldEvents.TextChangeNotifier
public void setTextChangeTimeout(int timeout)
getTextChangeEventMode()
is
AbstractTextField.TextChangeEventMode.LAZY
or AbstractTextField.TextChangeEventMode.TIMEOUT
.
timeout
- the timeout in millisecondsgetTextChangeEventMode()
public int getTextChangeTimeout()
FieldEvents.TextChangeEvent
s when the
getTextChangeEventMode()
is AbstractTextField.TextChangeEventMode.LAZY
or
AbstractTextField.TextChangeEventMode.TIMEOUT
.
public void selectAll()
public void setSelectionRange(int pos, int length)
pos
- the position of the first character to be selectedlength
- the number of characters to be selectedpublic void setCursorPosition(int pos)
pos
- the position for the cursorpublic int getCursorPosition()
Note that due to the client server nature or the GWT terminal, Vaadin
cannot provide the exact value of the cursor position in most situations.
The value is updated only when the client side terminal communicates to
TextField, like on ValueChangeEvent
s and FieldEvents.TextChangeEvent
s. This may change later if a deep push integration is built to Vaadin.
public void addListener(FieldEvents.FocusListener listener)
FieldEvents.FocusNotifier
FocusListener
to the Component which gets fired
when a Field
receives keyboard focus.
addListener
in interface FieldEvents.FocusNotifier
FieldEvents.FocusListener
public void removeListener(FieldEvents.FocusListener listener)
FieldEvents.FocusNotifier
FocusListener
from the Component.
removeListener
in interface FieldEvents.FocusNotifier
FieldEvents.FocusListener
public void addListener(FieldEvents.BlurListener listener)
FieldEvents.BlurNotifier
BlurListener
to the Component which gets fired
when a Field
loses keyboard focus.
addListener
in interface FieldEvents.BlurNotifier
FieldEvents.BlurListener
public void removeListener(FieldEvents.BlurListener listener)
FieldEvents.BlurNotifier
BlurListener
from the Component.
removeListener
in interface FieldEvents.BlurNotifier
FieldEvents.BlurListener
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |