com.whitestein.lsps.vaadin.ui.components

Class UITextBox

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractField<String>

com.vaadin.ui.AbstractTextField

com.vaadin.ui.TextField

com.whitestein.lsps.vaadin.ui.components.UITextBox

All Implemented Interfaces:

com.vaadin.data.Buffered, com.vaadin.data.BufferedValidatable, com.vaadin.data.Property<String>, com.vaadin.data.Property.Editor, com.vaadin.data.Property.ReadOnlyStatusChangeListener, com.vaadin.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.data.Property.ValueChangeListener, com.vaadin.data.Property.ValueChangeNotifier, com.vaadin.data.Property.Viewer, com.vaadin.data.Validatable, com.vaadin.event.Action.ShortcutNotifier, com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.FieldEvents.BlurNotifier, com.vaadin.event.FieldEvents.FocusNotifier, com.vaadin.event.FieldEvents.TextChangeNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.server.VariableOwner, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Field<String>, com.vaadin.ui.LegacyComponent, UIComponent, UIField, UIComponentWithHints2, UIComponentWithInputPrompt, Serializable, EventListener

public class UITextBox
extends com.vaadin.ui.TextField
implements UIComponentWithHints2, UIComponentWithInputPrompt, UIField

Standard Vaadin component for "ui::TextBox".

Author:

mbj

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractTextField

com.vaadin.ui.AbstractTextField.TextChangeEventImpl, com.vaadin.ui.AbstractTextField.TextChangeEventMode

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractField

com.vaadin.ui.AbstractField.FocusShortcut, com.vaadin.ui.AbstractField.ReadOnlyStatusChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Nested classes/interfaces inherited from interface com.vaadin.ui.Field

com.vaadin.ui.Field.ValueChangeEvent

Nested classes/interfaces inherited from interface com.vaadin.data.Buffered

com.vaadin.data.Buffered.SourceException

Nested classes/interfaces inherited from interface com.vaadin.data.Property

com.vaadin.data.Property.Editor, com.vaadin.data.Property.ReadOnlyException, com.vaadin.data.Property.ReadOnlyStatusChangeListener, com.vaadin.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.data.Property.Transactional<T>, com.vaadin.data.Property.ValueChangeListener, com.vaadin.data.Property.ValueChangeNotifier, com.vaadin.data.Property.Viewer

Field Summary

Fields

Modifier and Type	Field and Description
protected com.whitestein.lsps.vaadin.extensions.SuffixLabel	suffix

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 and Description
UITextBox(UIComponentData componentData)

Method Summary

Modifier and Type	Method and Description
boolean	applyHint(String hintName, Variant<Object> newValue, Variant<Object> oldValue) Applies the given hint to this component.
UIComponentData	getComponentData() Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.
com.vaadin.ui.AbstractComponent	getWidget() Returns the Vaadin widget which implements the UI part of this component.
void	refresh() This method is called from LSPS rendering engine.
protected boolean	shouldHideErrors()
String	toString()
boolean	unapplyHint(String hintName, Variant<Object> oldValue) The hint has been removed from the hint map.
void	validate()

Methods inherited from class com.vaadin.ui.TextField

clear, readDesign, writeDesign

Methods inherited from class com.vaadin.ui.AbstractTextField

addBlurListener, addFocusListener, addListener, addListener, addListener, addTextChangeListener, beforeClientResponse, changeVariables, getColumns, getCursorPosition, getCustomAttributes, getInputPrompt, getMaxLength, getNullRepresentation, getState, getState, getTextChangeEventMode, getTextChangeTimeout, getType, isEmpty, isNullSettingAllowed, paintContent, removeBlurListener, removeFocusListener, removeListener, removeListener, removeListener, removeTextChangeListener, selectAll, setColumns, setCursorPosition, setInputPrompt, setInternalValue, setMaxLength, setNullRepresentation, setNullSettingAllowed, setSelectionRange, setTextChangeEventMode, setTextChangeTimeout, setValue

Methods inherited from class com.vaadin.ui.AbstractField

addListener, addListener, addReadOnlyStatusChangeListener, addValidator, addValueChangeListener, attach, commit, detach, discard, fireReadOnlyStatusChange, fireValueChange, focus, getConversionError, getConversionError, getConvertedValue, getConverter, getCurrentBufferedSourceException, getErrorMessage, getInternalValue, getModelType, getPropertyDataSource, getRequiredError, getTabIndex, getValidators, getValue, isBuffered, isImmediate, isInvalidAllowed, isInvalidCommitted, isModified, isReadOnly, isRequired, isValid, isValidationVisible, readOnlyStatusChange, removeAllValidators, removeListener, removeListener, removeReadOnlyStatusChangeListener, removeValidator, removeValueChangeListener, setBuffered, setConversionError, setConvertedValue, setConverter, setConverter, setCurrentBufferedSourceException, setInvalidAllowed, setInvalidCommitted, setLocale, setPropertyDataSource, setReadOnly, setRequired, setRequiredError, setTabIndex, setValidationVisible, setValue, setValue, validate, valueChange

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getExplicitImmediateValue, 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, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, 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, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.whitestein.lsps.vaadin.ui.UIComponentWithInputPrompt

getInputPrompt, setInputPrompt

Methods inherited from interface com.whitestein.lsps.vaadin.ui.components.UIField

isRequired, setRequired

Methods inherited from interface com.vaadin.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled, isImmediate

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier

addShortcutListener, removeShortcutListener

Field Detail

suffix

protected com.whitestein.lsps.vaadin.extensions.SuffixLabel suffix

Constructor Detail

UITextBox

public UITextBox(UIComponentData componentData)

Parameters:

componentData -

Method Detail

refresh

public void refresh()

Description copied from interface: UIComponent

This method is called from LSPS rendering engine. It should load all information needed from component definition record holder and apply them accordingly.

Note that this method should not attempt to apply any hints - hints are applied automatically after the component is refreshed. You however may read the hints value here - it is guaranteed that you will receive freshly updated hint value by reading UIComponentData.getHints().

Specified by:

refresh in interface UIComponent

validate

public void validate()
              throws com.vaadin.data.Validator.InvalidValueException

Specified by:

validate in interface com.vaadin.data.Validatable

Overrides:

validate in class com.vaadin.ui.AbstractField<String>

Throws:

com.vaadin.data.Validator.InvalidValueException

applyHint

public boolean applyHint(String hintName,
                         Variant<Object> newValue,
                         Variant<Object> oldValue)

Description copied from interface: UIComponentWithHints2

Applies the given hint to this component.

Specified by:

applyHint in interface UIComponentWithHints2

Parameters:

hintName - the hint name, not null.

newValue - variant containing the new hint value, never null, may contain null value.

oldValue - variant containing the previous hint value, never null, may contain null value if the hint was missing or the old value was null.

Returns:

true if the hint is supported and was applied, false if the hint is not known to this component.

unapplyHint

public boolean unapplyHint(String hintName,
                           Variant<Object> oldValue)

Description copied from interface: UIComponentWithHints2

The hint has been removed from the hint map. Unapply from the component and revert the value to the default one.

Specified by:

unapplyHint in interface UIComponentWithHints2

Parameters:

hintName - the the hint name, not null.

oldValue - variant containing the previous hint value, never null, may contain null value if the old value was null.

Returns:

true if the hint is supported and was applied, false if the hint is not known to this component.

shouldHideErrors

protected boolean shouldHideErrors()

Overrides:

shouldHideErrors in class com.vaadin.ui.AbstractField<String>

getComponentData

public UIComponentData getComponentData()

Description copied from interface: UIComponent

Returns the component definition (LSPS RecordHolder instance which is subtype of "ui::Component") associated with this Vaadin component.

Specified by:

getComponentData in interface UIComponent

Returns:

component definition. The definition record instance must be present in root scope (screen context).

toString

public String toString()

Overrides:

toString in class com.vaadin.ui.AbstractField<String>

getWidget

public com.vaadin.ui.AbstractComponent getWidget()

Description copied from interface: UIComponent

Returns the Vaadin widget which implements the UI part of this component.

Specified by:

getWidget in interface UIComponent

Returns:

the widget, not null.