Class AbstractField<T>
- java.lang.Object
-
- com.vaadin.server.AbstractClientConnector
-
- com.vaadin.ui.AbstractComponent
-
- com.vaadin.v7.ui.AbstractLegacyComponent
-
- com.vaadin.v7.ui.AbstractField<T>
-
- All Implemented Interfaces:
Action.ShortcutNotifier
,ContextClickEvent.ContextClickNotifier
,MethodEventSource
,SerializableEventListener
,ClientConnector
,Sizeable
,com.vaadin.shared.Connector
,Component
,Component.Focusable
,Buffered
,BufferedValidatable
,Property<T>
,Property.Editor
,Property.ReadOnlyStatusChangeListener
,Property.ReadOnlyStatusChangeNotifier
,Property.ValueChangeListener
,Property.ValueChangeNotifier
,Property.Viewer
,Validatable
,Field<T>
,Serializable
,EventListener
- Direct Known Subclasses:
AbstractSelect
,AbstractTextField
,CheckBox
,CustomField
,DateField
,Form
,ProgressBar
,RichTextArea
,Slider
@Deprecated public abstract class AbstractField<T> extends AbstractLegacyComponent implements Field<T>, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Action.ShortcutNotifier
Deprecated.This class is, apart from the rename, identical to the Vaadin 7com.vaadin.ui.AbstractField
. It is provided for compatibility and migration purposes. As of 8.0, new field implementations should extend the newAbstractField
instead.Abstract field component for implementing buffered property editors. The field may hold an internal value, or it may be connected to any data source that implements the
Property
interface.AbstractField
implements that interface itself, too, so accessing the Property value represented by it is straightforward.AbstractField also provides the
Buffered
interface for buffering the data source value. By default the Field is in write through-mode andBuffered.setBuffered(boolean)
should be called to enable buffering.The class also supports
validators
to make sure the value contained in the field is valid.- Since:
- 3.0
- Author:
- Vaadin Ltd.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
AbstractField.FocusShortcut
Deprecated.Replaced in 8.0 withFocusShortcut
static class
AbstractField.ReadOnlyStatusChangeEvent
Deprecated.-
Nested classes/interfaces inherited from interface com.vaadin.v7.data.Buffered
Buffered.SourceException
-
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.v7.ui.Field
Field.ValueChangeEvent
-
Nested classes/interfaces inherited from interface com.vaadin.v7.data.Property
Property.Editor, Property.ReadOnlyException, Property.ReadOnlyStatusChangeListener, Property.ReadOnlyStatusChangeNotifier, Property.Transactional<T>, Property.ValueChangeListener, Property.ValueChangeNotifier, Property.Viewer
-
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 AbstractField()
Deprecated.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addListener(Property.ReadOnlyStatusChangeListener listener)
Deprecated.As of 7.0, replaced byaddReadOnlyStatusChangeListener(Property.ReadOnlyStatusChangeListener)
void
addListener(Property.ValueChangeListener listener)
Deprecated.As of 7.0, replaced byaddValueChangeListener(Property.ValueChangeListener)
void
addReadOnlyStatusChangeListener(Property.ReadOnlyStatusChangeListener listener)
Deprecated.Registers a new read-only status change listener for this Property.void
addValidator(Validator validator)
Deprecated.Adds a new validator for the field's value.void
addValueChangeListener(Property.ValueChangeListener listener)
Deprecated.Registers a new value change listener for this Property.void
attach()
Deprecated.Notifies the component that it is connected to an application.void
beforeClientResponse(boolean initial)
Deprecated.void
clear()
Deprecated.Clears the value of the field.void
commit()
Deprecated.Updates all changes since the previous commit to the data source.void
detach()
Deprecated.void
discard()
Deprecated.Discards all changes since last commit.protected void
fireReadOnlyStatusChange()
Deprecated.Emits the read-only status change event.protected void
fireValueChange(boolean repaintIsNotNeeded)
Deprecated.Emits the value change event.void
focus()
Deprecated.String
getConversionError()
Deprecated.Gets the error that is shown if the field value cannot be converted to the data source type.protected String
getConversionError(Class<?> dataSourceType, Converter.ConversionException e)
Deprecated.Returns the conversion error with {0} replaced by the data source type and {1} replaced by the exception (localized) message.Object
getConvertedValue()
Deprecated.Returns the current value (as returned bygetValue()
) converted to the data source type.Converter<T,Object>
getConverter()
Deprecated.Gets the converter used to convert the property data source value to the field value.protected Buffered.SourceException
getCurrentBufferedSourceException()
Deprecated.Gets the current buffered source exception.protected Collection<String>
getCustomAttributes()
Deprecated.ErrorMessage
getErrorMessage()
Deprecated.Error messages shown by the fields are composites of the error message thrown by the superclasses (that is the component error message), validation errors and buffered source errors.protected T
getInternalValue()
Deprecated.Returns the internal field value, which might not match the data source value e.g.protected Class<?>
getModelType()
Deprecated.Retrieves the type of the currently used data model.Property
getPropertyDataSource()
Deprecated.Gets the current data source of the field, if any.String
getRequiredError()
Deprecated.Gets the error message that is to be displayed if a required field is empty.protected AbstractFieldState
getState()
Deprecated.protected AbstractFieldState
getState(boolean markAsDirty)
Deprecated.int
getTabIndex()
Deprecated.abstract Class<? extends T>
getType()
Deprecated.Returns the type of the Field.Collection<Validator>
getValidators()
Deprecated.Gets the validators of the field.T
getValue()
Deprecated.Gets the current value of the field.boolean
isBuffered()
Deprecated.Checks the buffered mode of this Field.boolean
isEmpty()
Deprecated.Is the field empty? In general, "empty" state is same as null.boolean
isInvalidAllowed()
Deprecated.Fields allow invalid values by default.boolean
isInvalidCommitted()
Deprecated.Tests if the invalid data is committed to datasource.boolean
isModified()
Deprecated.Tests if the value stored in the object has been modified since it was last updated from the data source.boolean
isReadOnly()
Deprecated.The abstract field is read only also if the data source is in read only mode.boolean
isRequired()
Deprecated.Is this field required.boolean
isValid()
Deprecated.Tests the current value against registered validators if the field is not empty.boolean
isValidationVisible()
Deprecated.Is automatic, visible validation enabled? If automatic validation is enabled, any validators connected to this component are evaluated while painting the component and potential error messages are sent to client.void
readDesign(org.jsoup.nodes.Element design, DesignContext designContext)
Deprecated.void
readOnlyStatusChange(Property.ReadOnlyStatusChangeEvent event)
Deprecated.React to read only status changes of the property by requesting a repaint.void
removeAllValidators()
Deprecated.Removes all validators from the field.void
removeListener(Property.ReadOnlyStatusChangeListener listener)
Deprecated.As of 7.0, replaced byremoveReadOnlyStatusChangeListener(Property.ReadOnlyStatusChangeListener)
void
removeListener(Property.ValueChangeListener listener)
Deprecated.As of 7.0, replaced byremoveValueChangeListener(Property.ValueChangeListener)
void
removeReadOnlyStatusChangeListener(Property.ReadOnlyStatusChangeListener listener)
Deprecated.Removes a previously registered read-only status change listener.void
removeValidator(Validator validator)
Deprecated.Removes the validator from the field.void
removeValueChangeListener(Property.ValueChangeListener listener)
Deprecated.Removes a previously registered value change listener.void
setBuffered(boolean buffered)
Deprecated.Sets the buffered mode of this Field.void
setConversionError(String valueConversionError)
Deprecated.Sets the error that is shown if the field value cannot be converted to the data source type.void
setConvertedValue(Object value)
Deprecated.Sets the value of the field using a value of the data source type.void
setConverter(Converter<T,?> converter)
Deprecated.Sets the converter used to convert the field value to property data source type.void
setConverter(Class<?> datamodelType)
Deprecated.Retrieves a converter for the field from the converter factory defined for the application.void
setCurrentBufferedSourceException(Buffered.SourceException currentBufferedSourceException)
Deprecated.Sets the current buffered source exception.protected void
setInternalValue(T newValue)
Deprecated.Sets the internal field value.void
setInvalidAllowed(boolean invalidAllowed)
Deprecated.Fields allow invalid values by default.void
setInvalidCommitted(boolean isCommitted)
Deprecated.Sets if the invalid data should be committed to datasource.void
setLocale(Locale locale)
Deprecated.void
setPropertyDataSource(Property newDataSource)
Deprecated.Sets the specified Property as the data source for the field.void
setReadOnly(boolean readOnly)
Deprecated.Changes the readonly state and throw read-only status change events.void
setRequired(boolean required)
Deprecated.Sets the field required.void
setRequiredError(String requiredMessage)
Deprecated.Set the error that is show if this field is required, but empty.void
setTabIndex(int tabIndex)
Deprecated.void
setValidationVisible(boolean validateAutomatically)
Deprecated.Enable or disable automatic, visible validation.void
setValue(T newFieldValue)
Deprecated.Sets the value of the field.protected void
setValue(T newFieldValue, boolean repaintIsNotNeeded)
Deprecated.Sets the value of the field.protected void
setValue(T newFieldValue, boolean repaintIsNotNeeded, boolean ignoreReadOnly)
Deprecated.Sets the value of the field.protected boolean
shouldHideErrors()
Deprecated.Returns true if the error indicator be hidden when painting the component even when there are errors.void
validate()
Deprecated.Checks the validity of the Field.protected void
validate(T fieldValue)
Deprecated.Validates that the given value pass the validators for the field.void
valueChange(Property.ValueChangeEvent event)
Deprecated.This method listens to data source value changes and passes the changes forwards.void
writeDesign(org.jsoup.nodes.Element design, DesignContext designContext)
Deprecated.-
Methods inherited from class com.vaadin.v7.ui.AbstractLegacyComponent
getExplicitImmediateValue, isImmediate, setImmediate
-
Methods inherited from class com.vaadin.ui.AbstractComponent
addContextClickListener, addListener, addShortcutListener, addStyleName, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isRequiredIndicatorVisible, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setParent, setPrimaryStyleName, setRequiredIndicatorVisible, 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.event.Action.ShortcutNotifier
addShortcutListener, removeShortcutListener
-
Methods inherited from interface com.vaadin.server.ClientConnector
addAttachListener, addDetachListener, 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, 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.server.Sizeable
getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined
-
-
-
-
Method Detail
-
shouldHideErrors
protected boolean shouldHideErrors()
Deprecated.Returns true if the error indicator be hidden when painting the component even when there are errors. This is a mostly internal method, but can be overridden in subclasses e.g. if the error indicator should also be shown for empty fields in some cases.- Returns:
- true to hide the error indicator, false to use the normal logic to show it when there are errors
-
getType
public abstract Class<? extends T> getType()
Deprecated.Returns the type of the Field. The methodsgetValue
andsetValue
must be compatible with this type: one must be able to safely cast the value returned fromgetValue
to the given type and pass any variable assignable to this type as an argument tosetValue
.
-
isReadOnly
public boolean isReadOnly()
Deprecated.The abstract field is read only also if the data source is in read only mode.- Specified by:
isReadOnly
in interfaceProperty<T>
- Overrides:
isReadOnly
in classAbstractLegacyComponent
- Returns:
true
if the component or any of its parents is in read-only mode,false
if not.- See Also:
AbstractLegacyComponent.setReadOnly(boolean)
-
setReadOnly
public void setReadOnly(boolean readOnly)
Deprecated.Changes the readonly state and throw read-only status change events.- Specified by:
setReadOnly
in interfaceProperty<T>
- Overrides:
setReadOnly
in classAbstractLegacyComponent
- Parameters:
readOnly
- a boolean value specifying whether the component is put read-only mode or not- See Also:
AbstractLegacyComponent.setReadOnly(boolean)
-
isInvalidCommitted
public boolean isInvalidCommitted()
Deprecated.Tests if the invalid data is committed to datasource.- Specified by:
isInvalidCommitted
in interfaceBufferedValidatable
- See Also:
BufferedValidatable.isInvalidCommitted()
-
setInvalidCommitted
public void setInvalidCommitted(boolean isCommitted)
Deprecated.Sets if the invalid data should be committed to datasource.- Specified by:
setInvalidCommitted
in interfaceBufferedValidatable
- See Also:
BufferedValidatable.setInvalidCommitted(boolean)
-
commit
public void commit() throws Buffered.SourceException, Validator.InvalidValueException
Deprecated.Description copied from interface:Buffered
Updates all changes since the previous commit to the data source. The value stored in the object will always be updated into the data source whencommit
is called.- Specified by:
commit
in interfaceBuffered
- Throws:
Buffered.SourceException
- if the operation fails because of an exception is thrown by the data source. The cause is included in the exception.Validator.InvalidValueException
- if the operation fails because validation is enabled and the values do not validate
-
discard
public void discard() throws Buffered.SourceException
Deprecated.Description copied from interface:Buffered
Discards all changes since last commit. The object updates its value from the data source.- Specified by:
discard
in interfaceBuffered
- Throws:
Buffered.SourceException
- if the operation fails because of an exception is thrown by the data source. The cause is included in the exception.
-
isModified
public boolean isModified()
Deprecated.Description copied from interface:Buffered
Tests if the value stored in the object has been modified since it was last updated from the data source.- Specified by:
isModified
in interfaceBuffered
- Returns:
true
if the value in the object has been modified since the last data source update,false
if not.
-
setBuffered
public void setBuffered(boolean buffered)
Deprecated.Sets the buffered mode of this Field.When the field is in buffered mode, changes will not be committed to the property data source until
commit()
is called.Setting buffered mode from true to false will commit any pending changes.
- Specified by:
setBuffered
in interfaceBuffered
- Parameters:
buffered
- true if buffered mode should be turned on, false otherwise- Since:
- 7.0.0
-
isBuffered
public boolean isBuffered()
Deprecated.Checks the buffered mode of this Field.- Specified by:
isBuffered
in interfaceBuffered
- Returns:
- true if buffered mode is on, false otherwise
-
getValue
public T getValue()
Deprecated.Gets the current value of the field.This is the visible, modified and possible invalid value the user have entered to the field.
Note that the object returned is compatible with getType(). For example, if the type is String, this returns Strings even when the underlying datasource is of some other type. In order to access the converted value, use
getConvertedValue()
and to access the value of the property data source, useProperty.getValue()
for the property data source.Since Vaadin 7.0, no implicit conversions between other data types and String are performed, but a converter is used if set.
-
setValue
public void setValue(T newFieldValue) throws Property.ReadOnlyException, Converter.ConversionException
Deprecated.Sets the value of the field.- Specified by:
setValue
in interfaceProperty<T>
- Parameters:
newFieldValue
- the New value of the field.- Throws:
Property.ReadOnlyException
Converter.ConversionException
-
setValue
protected void setValue(T newFieldValue, boolean repaintIsNotNeeded)
Deprecated.Sets the value of the field.- Parameters:
newFieldValue
- the New value of the field.repaintIsNotNeeded
- True if caller is sure that repaint is not needed.- Throws:
Property.ReadOnlyException
Converter.ConversionException
Validator.InvalidValueException
-
setValue
protected void setValue(T newFieldValue, boolean repaintIsNotNeeded, boolean ignoreReadOnly) throws Property.ReadOnlyException, Converter.ConversionException, Validator.InvalidValueException
Deprecated.Sets the value of the field.- Parameters:
newFieldValue
- the New value of the field.repaintIsNotNeeded
- True if caller is sure that repaint is not needed.ignoreReadOnly
- True if the read-only check should be ignored- Throws:
Property.ReadOnlyException
Converter.ConversionException
Validator.InvalidValueException
- Since:
- 7.5.7
-
getPropertyDataSource
public Property getPropertyDataSource()
Deprecated.Gets the current data source of the field, if any.- Specified by:
getPropertyDataSource
in interfaceProperty.Viewer
- Returns:
- the current data source as a Property, or
null
if none defined.
-
setPropertyDataSource
public void setPropertyDataSource(Property newDataSource)
Deprecated.Sets the specified Property as the data source for the field. All uncommitted changes are replaced with a value from the new data source.
If the datasource has any validators, the same validators are added to the field. Because the default behavior of the field is to allow invalid values, but not to allow committing them, this only adds visual error messages to fields and do not allow committing them as long as the value is invalid. After the value is valid, the error message is not shown and the commit can be done normally.
If the data source implements
Property.ValueChangeNotifier
and/orProperty.ReadOnlyStatusChangeNotifier
, the field registers itself as a listener and updates itself according to the events it receives. To avoid memory leaks caused by references to a field no longer in use, the listener registrations are removed ondetach
and re-added onattach
.Note: before 6.5 we actually called discard() method in the beginning of the method. This was removed to simplify implementation, avoid excess calls to backing property and to avoid odd value change events that were previously fired (developer expects 0-1 value change events if this method is called). Some complex field implementations might now need to override this method to do housekeeping similar to discard().
- Specified by:
setPropertyDataSource
in interfaceProperty.Viewer
- Parameters:
newDataSource
- the new data source Property.
-
setConverter
public void setConverter(Class<?> datamodelType)
Deprecated.Retrieves a converter for the field from the converter factory defined for the application. Clears the converter if no application reference is available or if the factory returns null.- Parameters:
datamodelType
- The type of the data model that we want to be able to convert from
-
getModelType
protected Class<?> getModelType()
Deprecated.Retrieves the type of the currently used data model. If the field has no data source then the model type of the converter is used.- Returns:
- The type of the currently used data model or null if no data source or converter is set.
- Since:
- 7.1
-
getConversionError
protected String getConversionError(Class<?> dataSourceType, Converter.ConversionException e)
Deprecated.Returns the conversion error with {0} replaced by the data source type and {1} replaced by the exception (localized) message.- Parameters:
dataSourceType
- the type of the data sourcee
- a conversion exception which can provide additional information- Returns:
- The value conversion error string with parameters replaced.
- Since:
- 7.1
-
getConvertedValue
public Object getConvertedValue()
Deprecated.Returns the current value (as returned bygetValue()
) converted to the data source type.This returns the same as
getValue()
if no converter has been set. The value is not necessarily the same as the data source value e.g. if the field is in buffered mode and has been modified.- Returns:
- The converted value that is compatible with the data source type
-
setConvertedValue
public void setConvertedValue(Object value)
Deprecated.Sets the value of the field using a value of the data source type. The value given is converted to the field type and then assigned to the field. This will update the property data source in the same way as whensetValue(Object)
is called.- Parameters:
value
- The value to set. Must be the same type as the data source.
-
addValidator
public void addValidator(Validator validator)
Deprecated.Adds a new validator for the field's value. All validators added to a field are checked each time the its value changes.- Specified by:
addValidator
in interfaceValidatable
- Parameters:
validator
- the new validator to be added.
-
getValidators
public Collection<Validator> getValidators()
Deprecated.Gets the validators of the field.- Specified by:
getValidators
in interfaceValidatable
- Returns:
- An unmodifiable collection that holds all validators for the field.
-
removeValidator
public void removeValidator(Validator validator)
Deprecated.Removes the validator from the field.- Specified by:
removeValidator
in interfaceValidatable
- Parameters:
validator
- the validator to remove.
-
removeAllValidators
public void removeAllValidators()
Deprecated.Removes all validators from the field.- Specified by:
removeAllValidators
in interfaceValidatable
-
isValid
public boolean isValid()
Deprecated.Tests the current value against registered validators if the field is not empty. If the field is empty it is considered valid if it is not required and invalid otherwise. Validators are never checked for empty fields. In most cases,validate()
should be used instead ofisValid()
to also get the error message.- Specified by:
isValid
in interfaceValidatable
- Returns:
true
if all registered validators claim that the current value is valid or if the field is empty and not required,false
otherwise.
-
validate
public void validate() throws Validator.InvalidValueException
Deprecated.Checks the validity of the Field. A field is invalid if it is set as required (usingsetRequired(boolean)
and is empty, if one or several of the validators added to the field indicate it is invalid or if the value cannot be converted provided a converter has been set. The "required" validation is a built-in validation feature. If the field is required and empty this method throws an EmptyValueException with the error message set usingsetRequiredError(String)
.- Specified by:
validate
in interfaceValidatable
- Throws:
Validator.InvalidValueException
- if the value is not valid- See Also:
Validatable.validate()
-
validate
protected void validate(T fieldValue) throws Validator.InvalidValueException
Deprecated.Validates that the given value pass the validators for the field.This method does not check the requiredness of the field.
- Parameters:
fieldValue
- The value to check- Throws:
Validator.InvalidValueException
- if one or several validators fail
-
isInvalidAllowed
public boolean isInvalidAllowed()
Deprecated.Fields allow invalid values by default. In most cases this is wanted, because the field otherwise visually forget the user input immediately.- Specified by:
isInvalidAllowed
in interfaceValidatable
- Returns:
- true if invalid values are allowed.
- See Also:
Validatable.isInvalidAllowed()
-
setInvalidAllowed
public void setInvalidAllowed(boolean invalidAllowed) throws UnsupportedOperationException
Deprecated.Fields allow invalid values by default. In most cases this is wanted, because the field otherwise visually forget the user input immediately.In common setting where the user wants to assure the correctness of the datasource, but allow temporarily invalid contents in the field, the user should add the validators to datasource, that should not allow invalid values. The validators are automatically copied to the field when the datasource is set.
- Specified by:
setInvalidAllowed
in interfaceValidatable
- Throws:
UnsupportedOperationException
- if the setInvalidAllowed is not supported.- See Also:
Validatable.setInvalidAllowed(boolean)
-
getErrorMessage
public ErrorMessage getErrorMessage()
Deprecated.Error messages shown by the fields are composites of the error message thrown by the superclasses (that is the component error message), validation errors and buffered source errors.- Overrides:
getErrorMessage
in classAbstractComponent
- See Also:
AbstractComponent.getErrorMessage()
-
addValueChangeListener
public void addValueChangeListener(Property.ValueChangeListener listener)
Deprecated.Description copied from interface:Property.ValueChangeNotifier
Registers a new value change listener for this Property.- Specified by:
addValueChangeListener
in interfaceProperty.ValueChangeNotifier
- Parameters:
listener
- the new Listener to be registered
-
addListener
@Deprecated public void addListener(Property.ValueChangeListener listener)
Deprecated.As of 7.0, replaced byaddValueChangeListener(Property.ValueChangeListener)
- Specified by:
addListener
in interfaceProperty.ValueChangeNotifier
-
removeValueChangeListener
public void removeValueChangeListener(Property.ValueChangeListener listener)
Deprecated.Description copied from interface:Property.ValueChangeNotifier
Removes a previously registered value change listener.- Specified by:
removeValueChangeListener
in interfaceProperty.ValueChangeNotifier
- Parameters:
listener
- listener to be removed
-
removeListener
@Deprecated public void removeListener(Property.ValueChangeListener listener)
Deprecated.As of 7.0, replaced byremoveValueChangeListener(Property.ValueChangeListener)
- Specified by:
removeListener
in interfaceProperty.ValueChangeNotifier
-
fireValueChange
protected void fireValueChange(boolean repaintIsNotNeeded)
Deprecated.Emits the value change event. The value contained in the field is validated before the event is created.
-
readOnlyStatusChange
public void readOnlyStatusChange(Property.ReadOnlyStatusChangeEvent event)
Deprecated.React to read only status changes of the property by requesting a repaint.- Specified by:
readOnlyStatusChange
in interfaceProperty.ReadOnlyStatusChangeListener
- Parameters:
event
- Read-only status change event object- See Also:
Property.ReadOnlyStatusChangeListener
-
addReadOnlyStatusChangeListener
public void addReadOnlyStatusChangeListener(Property.ReadOnlyStatusChangeListener listener)
Deprecated.Description copied from interface:Property.ReadOnlyStatusChangeNotifier
Registers a new read-only status change listener for this Property.- Specified by:
addReadOnlyStatusChangeListener
in interfaceProperty.ReadOnlyStatusChangeNotifier
- Parameters:
listener
- the new Listener to be registered
-
addListener
@Deprecated public void addListener(Property.ReadOnlyStatusChangeListener listener)
Deprecated.As of 7.0, replaced byaddReadOnlyStatusChangeListener(Property.ReadOnlyStatusChangeListener)
- Specified by:
addListener
in interfaceProperty.ReadOnlyStatusChangeNotifier
-
removeReadOnlyStatusChangeListener
public void removeReadOnlyStatusChangeListener(Property.ReadOnlyStatusChangeListener listener)
Deprecated.Description copied from interface:Property.ReadOnlyStatusChangeNotifier
Removes a previously registered read-only status change listener.- Specified by:
removeReadOnlyStatusChangeListener
in interfaceProperty.ReadOnlyStatusChangeNotifier
- Parameters:
listener
- listener to be removed
-
removeListener
@Deprecated public void removeListener(Property.ReadOnlyStatusChangeListener listener)
Deprecated.As of 7.0, replaced byremoveReadOnlyStatusChangeListener(Property.ReadOnlyStatusChangeListener)
- Specified by:
removeListener
in interfaceProperty.ReadOnlyStatusChangeNotifier
-
fireReadOnlyStatusChange
protected void fireReadOnlyStatusChange()
Deprecated.Emits the read-only status change event. The value contained in the field is validated before the event is created.
-
valueChange
public void valueChange(Property.ValueChangeEvent event)
Deprecated.This method listens to data source value changes and passes the changes forwards. Changes are not forwarded to the listeners of the field during internal operations of the field to avoid duplicate notifications.- Specified by:
valueChange
in interfaceProperty.ValueChangeListener
- Parameters:
event
- the value change event telling the data source contents have changed.
-
focus
public void focus()
Deprecated.- Specified by:
focus
in interfaceComponent.Focusable
- Overrides:
focus
in classAbstractComponent
-
getTabIndex
public int getTabIndex()
Deprecated.- Specified by:
getTabIndex
in interfaceComponent.Focusable
-
setTabIndex
public void setTabIndex(int tabIndex)
Deprecated.- Specified by:
setTabIndex
in interfaceComponent.Focusable
-
getInternalValue
protected T getInternalValue()
Deprecated.Returns the internal field value, which might not match the data source value e.g. if the field has been modified and is not in write-through mode. This method can be overridden by subclasses together withsetInternalValue(Object)
to compute internal field value at runtime. When doing so, typically alsoisModified()
needs to be overridden and care should be taken in the management of the empty state and buffering support.- Returns:
- internal field value
-
setInternalValue
protected void setInternalValue(T newValue)
Deprecated.Sets the internal field value. This is purely used by AbstractField to change the internal Field value. It does not trigger valuechange events. It can be overridden by the inheriting classes to update all dependent variables. Subclasses can also overridegetInternalValue()
if necessary.- Parameters:
newValue
- the new value to be set.
-
attach
public void attach()
Deprecated.Notifies the component that it is connected to an application.- Specified by:
attach
in interfaceClientConnector
- Specified by:
attach
in interfaceComponent
- Overrides:
attach
in classAbstractComponent
- See Also:
Component.attach()
-
setLocale
public void setLocale(Locale locale)
Deprecated.- Overrides:
setLocale
in classAbstractComponent
-
detach
public void detach()
Deprecated.- Specified by:
detach
in interfaceClientConnector
- Overrides:
detach
in classAbstractComponent
-
isRequired
public boolean isRequired()
Deprecated.Description copied from interface:Field
Is this field required. Required fields must filled by the user.- Specified by:
isRequired
in interfaceField<T>
- Returns:
true
if the field is required,otherwisefalse
.
-
setRequired
public void setRequired(boolean required)
Deprecated.Description copied from interface:Field
Sets the field required. Required fields must filled by the user.- Specified by:
setRequired
in interfaceField<T>
- Parameters:
required
- Is the field required.
-
setRequiredError
public void setRequiredError(String requiredMessage)
Deprecated.Set the error that is show if this field is required, but empty. When setting requiredMessage to be "" or null, no error pop-up or exclamation mark is shown for a empty required field. This faults to "". Even in those cases isValid() returns false for empty required fields.- Specified by:
setRequiredError
in interfaceField<T>
- Parameters:
requiredMessage
- Message to be shown when this field is required, but empty.
-
getRequiredError
public String getRequiredError()
Deprecated.Description copied from interface:Field
Gets the error message that is to be displayed if a required field is empty.- Specified by:
getRequiredError
in interfaceField<T>
- Returns:
- Error message.
-
getConversionError
public String getConversionError()
Deprecated.Gets the error that is shown if the field value cannot be converted to the data source type.- Returns:
- The error that is shown if conversion of the field value fails
-
setConversionError
public void setConversionError(String valueConversionError)
Deprecated.Sets the error that is shown if the field value cannot be converted to the data source type. If {0} is present in the message, it will be replaced by the simple name of the data source type. If {1} is present in the message, it will be replaced by the ConversionException message.- Parameters:
valueConversionError
- Message to be shown when conversion of the value fails
-
isEmpty
public boolean isEmpty()
Deprecated.Description copied from interface:Field
Is the field empty? In general, "empty" state is same as null. As an exception, TextField also treats empty string as "empty".
-
clear
public void clear()
Deprecated.Description copied from interface:Field
Clears the value of the field.The field value is typically reset to the initial value of the field. Calling
Field.isEmpty()
on a cleared field must always returns true.
-
isValidationVisible
public boolean isValidationVisible()
Deprecated.Is automatic, visible validation enabled? If automatic validation is enabled, any validators connected to this component are evaluated while painting the component and potential error messages are sent to client. If the automatic validation is turned off, isValid() and validate() methods still work, but one must show the validation in their own code.- Returns:
- True, if automatic validation is enabled.
-
setValidationVisible
public void setValidationVisible(boolean validateAutomatically)
Deprecated.Enable or disable automatic, visible validation. If automatic validation is enabled, any validators connected to this component are evaluated while painting the component and potential error messages are sent to client. If the automatic validation is turned off, isValid() and validate() methods still work, but one must show the validation in their own code.- Parameters:
validateAutomatically
- True, if automatic validation is enabled.
-
setCurrentBufferedSourceException
public void setCurrentBufferedSourceException(Buffered.SourceException currentBufferedSourceException)
Deprecated.Sets the current buffered source exception.- Parameters:
currentBufferedSourceException
-
-
getCurrentBufferedSourceException
protected Buffered.SourceException getCurrentBufferedSourceException()
Deprecated.Gets the current buffered source exception.- Returns:
- The current source exception
-
getConverter
public Converter<T,Object> getConverter()
Deprecated.Gets the converter used to convert the property data source value to the field value.- Returns:
- The converter or null if none is set.
-
setConverter
public void setConverter(Converter<T,?> converter)
Deprecated.Sets the converter used to convert the field value to property data source type. The converter must have a presentation type that matches the field type.- Parameters:
converter
- The new converter to use.
-
getState
protected AbstractFieldState getState()
Deprecated.- Overrides:
getState
in classAbstractLegacyComponent
-
getState
protected AbstractFieldState getState(boolean markAsDirty)
Deprecated.- Overrides:
getState
in classAbstractLegacyComponent
-
beforeClientResponse
public void beforeClientResponse(boolean initial)
Deprecated.- Specified by:
beforeClientResponse
in interfaceClientConnector
- Overrides:
beforeClientResponse
in classAbstractLegacyComponent
-
readDesign
public void readDesign(org.jsoup.nodes.Element design, DesignContext designContext)
Deprecated.- Specified by:
readDesign
in interfaceComponent
- Overrides:
readDesign
in classAbstractLegacyComponent
-
getCustomAttributes
protected Collection<String> getCustomAttributes()
Deprecated.- Overrides:
getCustomAttributes
in classAbstractComponent
-
writeDesign
public void writeDesign(org.jsoup.nodes.Element design, DesignContext designContext)
Deprecated.- Specified by:
writeDesign
in interfaceComponent
- Overrides:
writeDesign
in classAbstractLegacyComponent
-
-