com.whitestein.lsps.vaadin.forms

Class WTextArea

java.lang.Object

com.whitestein.lsps.vaadin.forms.FormComponent

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

com.whitestein.lsps.vaadin.forms.WInputComponentWithValue<String>

com.whitestein.lsps.vaadin.forms.WAbstractTextField

com.whitestein.lsps.vaadin.forms.WTextArea

All Implemented Interfaces:

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

public class WTextArea
extends WAbstractTextField

Expandable textarea.

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
WTextArea()

Method Summary

Modifier and Type	Method and Description
protected com.vaadin.ui.AbstractTextField	createWidget() Called once, to create the actual Vaadin component.
Decimal	getMaxRows() Returns the maximum allowed number of rows that the textarea in expandable mode will grow to.
Decimal	getMinRows() Returns the minimum allowed number of rows that the textarea in expandable mode will shrink to.Default is null that means that the limit is 1.
Decimal	getRowsCount() Gets the number of rows in the text area.
com.whitestein.lsps.vaadin.extensions.ExpandingTextArea	getWidget() Gets the Vaadin representation of this component.
boolean	isAppendExtraRow() Should last row always be an empty row?
boolean	isExpandable()
protected void	restoreInternalState(Map<String,Object> state) Restores the UI state of this component which was previously written by FormComponent.writeInternalState(Map).
void	setAppendExtraRow(boolean appendExtraRow) Should last row always be an empty row? The value is ignored if the textarea is not in expandable mode
void	setExpandable(boolean isExpandable) Switch between expandable and normal mode.
void	setMaxRows(Decimal maxRows) Sets the maximum allowed number of rows that the textarea in expandable mode will grow to.
void	setMinRows(Decimal minRows) Sets the minimum allowed number of rows that the textarea in expandable mode will shrink to.
void	setRowsCount(Decimal rows) Sets the number of rows in the text area.
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.WAbstractTextField

getInputPrompt, getMaxLength, setInputPrompt, setMaxLength

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

addValidator, fireValueChanged, focus, getOnChange, getValidationErrors, inferValidator, isConvertible, isImmediate, isRequired, isValid, preventGC, removeAllValidators, setImmediate, setOnChange, setRequired

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

getBinding, getProperty, isFullyInitialized, onPropertyValueSet, 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

WTextArea

public WTextArea()

Method Detail

createWidget

protected com.vaadin.ui.AbstractTextField createWidget()

Description copied from class: FormComponent

Called once, to create the actual Vaadin component.

Specified by:

createWidget in class WAbstractTextField

Returns:

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

getWidget

public com.whitestein.lsps.vaadin.extensions.ExpandingTextArea getWidget()

Description copied from class: FormComponent

Gets the Vaadin representation of this component.

Overrides:

getWidget in class WAbstractTextField

Returns:

the Vaadin representation of this form component.

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 WAbstractTextField

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 WAbstractTextField

Parameters:

state - a map of attributes and their values

See Also:

FormComponent.writeInternalState(Map)

setRowsCount

public void setRowsCount(Decimal rows)

Sets the number of rows in the text area. If the number of rows is 0, the default number determined by the component is used. Note: this setter does nothing if the textarea is in expandable mode

Parameters:

rows - the number of rows for this text area.

getRowsCount

public Decimal getRowsCount()

Gets the number of rows in the text area.

Returns:

number of explicitly set rows.

setMaxRows

public void setMaxRows(Decimal maxRows)

Sets the maximum allowed number of rows that the textarea in expandable mode will grow to. Default is null that means that there is no limit for growing. Note: the value is ignored if the textarea is not in expandable mode

Parameters:

maxRows - null or number

getMaxRows

public Decimal getMaxRows()

Returns the maximum allowed number of rows that the textarea in expandable mode will grow to. Default is null that means that there is no limit for growing.

Returns:

maximum allowed number of rows for expandable mode

getMinRows

public Decimal getMinRows()

Returns the minimum allowed number of rows that the textarea in expandable mode will shrink to.Default is null that means that the limit is 1. Note: the value is ignored if the textarea is not in expandable mode

Returns:

minimum allowed number of rows for expandable mode

setMinRows

public void setMinRows(Decimal minRows)

Sets the minimum allowed number of rows that the textarea in expandable mode will shrink to.

Parameters:

minRows - null or number

setAppendExtraRow

public void setAppendExtraRow(boolean appendExtraRow)

Should last row always be an empty row? The value is ignored if the textarea is not in expandable mode

Parameters:

appendExtraRow - true to append extra row, false otherwise

isAppendExtraRow

public boolean isAppendExtraRow()

Should last row always be an empty row?

Returns:

true if text are in expandable mode adds an extra empty row to the end

setExpandable

public void setExpandable(boolean isExpandable)

Switch between expandable and normal mode. Textarea in expandable mode grows/shrinks with content within getMaxRows() and getMinRows() boundaries.

Parameters:

isExpandable -

isExpandable

public boolean isExpandable()

Returns:

true if the textarea is in expandable mode, false otherwise