We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.ui.
Class TextField
-
All Implemented Interfaces:
HasValue<String>,ContextClickEvent.ContextClickNotifier,FieldEvents.BlurNotifier,FieldEvents.FocusNotifier,MethodEventSource,ClientConnector,Sizeable,Connector,Component,Component.Focusable,HasValueChangeMode,SerializableDirect Known Subclasses:
public class TextField extends AbstractTextFieldA component for editing textual data that fits on a single line. For a multi-line textarea, see the
TextAreacomponent.Author:
Vaadin Ltd.
See Also:
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector
ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener
-
Nested classes/interfaces inherited from interface com.vaadin.ui.Component
Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener
-
Nested classes/interfaces inherited from interface com.vaadin.data.HasValue
HasValue.ValueChangeEvent<V>, HasValue.ValueChangeListener<V>
-
Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable
Sizeable.Unit
-
-
Field Summary
-
Fields inherited from class com.vaadin.ui.AbstractComponent
DESIGN_ATTR_PLAIN_TEXT
-
Fields inherited from interface com.vaadin.server.Sizeable
SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS
-
-
Constructor Summary
Constructors Constructor Description TextField()Constructs an empty
TextFieldwith no caption.TextField(HasValue.ValueChangeListener<String> valueChangeListener)Constructs a new
TextFieldwith a value change listener.TextField(String caption)Constructs an empty
TextFieldwith given caption.TextField(String caption, HasValue.ValueChangeListener<String> valueChangeListener)Constructs a new
TextFieldwith the given caption and a value change listener.TextField(String caption, String value)Constructs a new
TextFieldwith the given caption and initial text contents.TextField(String caption, String value, HasValue.ValueChangeListener<String> valueChangeListener)Constructs a new
TextFieldwith the given caption, initial text contents and a value change listener.
-
Method Summary
All Methods Modifier and Type Method Description protected TextFieldStategetState()Returns the shared state bean with information to be sent from the server to the client.
protected TextFieldStategetState(boolean markAsDirty)Returns the shared state for this connector.
voidreadDesign(org.jsoup.nodes.Element design, DesignContext designContext)Reads the component state from the given design.
voidwriteDesign(org.jsoup.nodes.Element design, DesignContext designContext)Writes the component state to the given design.
-
Methods inherited from class com.vaadin.ui.AbstractTextField
addBlurListener, addFocusListener, doSetValue, getCursorPosition, getCustomAttributes, getEmptyValue, getMaxLength, getPlaceholder, getValue, getValueChangeMode, getValueChangeTimeout, selectAll, setCursorPosition, setMaxLength, setPlaceholder, setSelection, setValue, setValueChangeMode, setValueChangeTimeout
-
Methods inherited from class com.vaadin.ui.AbstractField
addValueChangeListener, createValueChange, focus, getTabIndex, isDifferentValue, isReadOnly, isRequiredIndicatorVisible, setReadOnly, setRequiredIndicatorVisible, setTabIndex, setValue
-
Methods inherited from class com.vaadin.ui.AbstractComponent
addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidth, setWidthFull, setWidthUndefined
-
Methods inherited from class com.vaadin.server.AbstractClientConnector
addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.vaadin.server.ClientConnector
addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler
-
Methods inherited from interface com.vaadin.ui.Component
addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible
-
Methods inherited from interface com.vaadin.shared.Connector
getConnectorId
-
Methods inherited from interface com.vaadin.data.HasValue
clear, getDefaultValidator, getOptionalValue, isEmpty
-
Methods inherited from interface com.vaadin.server.Sizeable
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined
-
-
-
-
Constructor Detail
-
TextField
public TextField()Constructs an empty
TextFieldwith no caption.
-
TextField
public TextField(String caption)Constructs an empty
TextFieldwith given caption.Parameters:
caption- the captionStringfor the editor.
-
TextField
public TextField(String caption, String value)Constructs a new
TextFieldwith the given caption and initial text contents.Parameters:
caption- the captionStringfor the editor.value- the initial text content of the editor, notnull
-
TextField
public TextField(HasValue.ValueChangeListener<String> valueChangeListener)Constructs a new
TextFieldwith a value change listener. The listener is called when the value of thisTextFieldis changed either by the user or programmatically.Parameters:
valueChangeListener- the value change listener, notnull
-
TextField
public TextField(String caption, HasValue.ValueChangeListener<String> valueChangeListener)Constructs a new
TextFieldwith the given caption and a value change listener.The listener is called when the value of this
TextFieldis changed either by the user or programmatically.Parameters:
caption- the captionStringfor the editor.valueChangeListener- the value change listener, notnull
-
TextField
public TextField(String caption, String value, HasValue.ValueChangeListener<String> valueChangeListener)Constructs a new
TextFieldwith the given caption, initial text contents and a value change listener.The listener is called when the value of this
TextFieldis changed either by the user or programmatically.Parameters:
caption- the captionStringfor the editor.value- the initial text content of the editor, notnullvalueChangeListener- the value change listener, notnull
-
-
Method Detail
-
getState
protected TextFieldState getState()Description copied from class:
AbstractComponentReturns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().
Overrides:
getStatein classAbstractTextFieldReturns:
updated component shared state
-
getState
protected TextFieldState getState(boolean markAsDirty)Description copied from class:
AbstractClientConnectorReturns the shared state for this connector.
Overrides:
getStatein classAbstractTextFieldParameters:
markAsDirty- true if the connector should automatically be marked dirty, false otherwiseReturns:
The shared state for this connector. Never null.
See Also:
-
readDesign
public void readDesign(org.jsoup.nodes.Element design, DesignContext designContext)Description copied from interface:
ComponentReads the component state from the given design.
The component is responsible not only for updating its own state but also for ensuring that its children update their state based on the design.
It is assumed that the component is in its default state when this method is called. Reading should only take into consideration attributes specified in the design and not reset any unspecified attributes to their defaults.
This method must not modify the design.
Specified by:
readDesignin interfaceComponentOverrides:
readDesignin classAbstractTextFieldParameters:
design- The element to obtain the state fromdesignContext- The DesignContext instance used for parsing the design
-
writeDesign
public void writeDesign(org.jsoup.nodes.Element design, DesignContext designContext)Description copied from interface:
ComponentWrites the component state to the given design.
The component is responsible not only for writing its own state but also for ensuring that its children write their state to the design.
This method must not modify the component state.
Specified by:
writeDesignin interfaceComponentOverrides:
writeDesignin classAbstractTextFieldParameters:
design- The element to write the component state to. Any previous attributes or child nodes are not cleared.designContext- The DesignContext instance used for writing the design
-
-