com.whitestein.lsps.vaadin.forms

Class WLabel

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

com.whitestein.lsps.vaadin.forms.ComponentWithValue<Object>

com.whitestein.lsps.vaadin.forms.WLabel

All Implemented Interfaces:

com.vaadin.event.ConnectorEventListener, com.vaadin.server.ClientConnector.AttachListener, Serializable, EventListener

public class WLabel
extends ComponentWithValue<Object>

Author:

mvy

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.whitestein.lsps.vaadin.forms.ComponentWithValue

ComponentWithValue.ValueChangeListenerImpl, ComponentWithValue.ValueProperty<T>

Field Summary

Fields inherited from class com.whitestein.lsps.vaadin.forms.ComponentWithValue

refreshing

Fields inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

form, INTERNAL_STATE_RECORD_PROPERTY

Fields inherited from interface com.vaadin.server.ClientConnector.AttachListener

attachMethod

Constructor Summary

Constructors

Constructor and Description
WLabel() Creates a new instance of the label.

Method Summary

Modifier and Type	Method and Description
protected com.vaadin.ui.Label	createWidget() Called once, to create the actual Vaadin component.
EnumerationImpl	getContentMode() Gets the content mode of the label.
ListHolder	getValidationErrors() Returns all validation errors produced by the validators attached to this component.
com.vaadin.ui.Label	getWidget() Gets the Vaadin representation of this component.
boolean	isConvertible() Indicates if the field value is convertible or not.
boolean	isValid() Tests the current value against registered validators if the field is not empty.
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setContentMode(EnumerationImpl contentMode) Sets the content mode of the label.
protected void	writeInternalState(Map<String,Object> state) Writes the UI state of this component to the provided map.

Methods inherited from class com.whitestein.lsps.vaadin.forms.ComponentWithValue

getBinding, getProperty, isFullyInitialized, onPropertyValueSet, preventGC, refresh, refreshBinding, setProperty

Methods inherited from class com.whitestein.lsps.vaadin.forms.FormComponent

addDataErrorMessage, addStyleName, attach, call, clearDataErrorMessages, createEvent, equals, getCaption, getComponentAlignment, getContextClickHandler, getCustomErrorMessage, getDataErrorMessages, getDescription, getExpandRatio, getHasChildrenAdapter, getHeight, getIcon, getModelingId, getNamespace, getStyleName, getTabIndex, getWidth, hashCode, isEnabled, isReadOnly, isVisible, localize, markAsDirty, removeStyleName, restoreState, saveState, setCaption, setComponentAlignment, setContextClickHandler, setContextMenuItems, setCustomErrorMessage, setDescription, setEnabled, setExpandRatio, setHeight, setIcon, setReadOnly, setStyleName, setTabIndex, setVisible, setWidth, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WLabel

public WLabel()

Creates a new instance of the label.

Method Detail

createWidget

protected com.vaadin.ui.Label createWidget()

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class FormComponent

Returns:

the actual Vaadin component, may be null if the component has no UI counterpart.

getWidget

public com.vaadin.ui.Label getWidget()

Description copied from class: FormComponent

Gets the Vaadin representation of this component.

Overrides:

getWidget in class FormComponent

Returns:

the Vaadin representation of this form component.

setContentMode

public void setContentMode(EnumerationImpl contentMode)

Sets the content mode of the label.

Parameters:

contentMode - the content mode to set.

getContentMode

public EnumerationImpl getContentMode()

Gets the content mode of the label.

Returns:

the content mode of the label

writeInternalState

protected void writeInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Writes the UI state of this component to the provided map. The written state is later used to restore the UI when a saved document or saved Todo is reopened.

Many UI attributes such as size, caption, etc. are not held in the records but are stored exclusively in the Vaadin components. In the records the getter/setter methods of such attributes directly delegate to the underlying component. For the purposes of the Save Document/Todo use case the state of such attributes has to be preserved.

Subclasses should override this method. The overriding method should call super.writeInternalState(state) to store the state form the super class as well. The attributes should be written to the provided state parameter. The type of the values written to the state can only by Java representation of LSPS types. That is java.util.Date, java.lang.String, Decimal, RecordHolder, ListHolder, ... The name of the attributes stored in the map should be unique and should not collide with the names used by any of the superclass. It is the responsibility of the overridden method to ensure that.

Subclasses overriding this method should also override FormComponent.restoreInternalState(Map) and restore the state written by this method.

Overrides:

writeInternalState in class ComponentWithValue<Object>

Parameters:

state - a map to which this method should write the component's UI state.

See Also:

FormComponent.restoreInternalState(Map), FormComponent.saveState()

restoreInternalState

protected void restoreInternalState(Map<String,Object> state)

Description copied from class: FormComponent

Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map). Subclasses should override and call super.restoreInternalState(state);

Overrides:

restoreInternalState in class ComponentWithValue<Object>

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)

isConvertible

public boolean isConvertible()

Description copied from class: ComponentWithValue

Indicates if the field value is convertible or not.

Specified by:

isConvertible in class ComponentWithValue<Object>

Returns:

true if the field value is convertible.

isValid

public boolean isValid()

Description copied from class: ComponentWithValue

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.

Specified by:

isValid in class ComponentWithValue<Object>

Returns:

true if all registered validators claim that the current value is valid or if the field is empty and not required, false otherwise.

getValidationErrors

public ListHolder getValidationErrors()

Description copied from class: ComponentWithValue

Returns all validation errors produced by the validators attached to this component. If there are no validators or all of them pass, returns an empty list (never null). Note: does NOT contain error set by from FormComponent.setCustomErrorMessage(java.lang.String) method.

Specified by:

getValidationErrors in class ComponentWithValue<Object>

Returns:

list of validation errors