org.vaadin.hene.expandingtextarea

Class ExpandingTextArea

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.v7.ui.AbstractLegacyComponent

com.vaadin.v7.ui.AbstractField<String>

com.vaadin.v7.ui.AbstractTextField

com.vaadin.v7.ui.TextArea

org.vaadin.hene.expandingtextarea.ExpandingTextArea

All Implemented Interfaces:

com.vaadin.event.Action.ShortcutNotifier, com.vaadin.event.ConnectorEventListener, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.event.SerializableEventListener, 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.LegacyComponent, com.vaadin.v7.data.Buffered, com.vaadin.v7.data.BufferedValidatable, com.vaadin.v7.data.Property<String>, com.vaadin.v7.data.Property.Editor, com.vaadin.v7.data.Property.ReadOnlyStatusChangeListener, com.vaadin.v7.data.Property.ReadOnlyStatusChangeNotifier, com.vaadin.v7.data.Property.ValueChangeListener, com.vaadin.v7.data.Property.ValueChangeNotifier, com.vaadin.v7.data.Property.Viewer, com.vaadin.v7.data.Validatable, com.vaadin.v7.event.FieldEvents.BlurNotifier, com.vaadin.v7.event.FieldEvents.FocusNotifier, com.vaadin.v7.event.FieldEvents.TextChangeNotifier, com.vaadin.v7.ui.Field<String>, Serializable, EventListener

public class ExpandingTextArea
extends com.vaadin.v7.ui.TextArea

An extended version of TextArea that adapts its height to the textual content.

Author:

Henri Kerola / Vaadin

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ExpandingTextArea.RowsChangeEvent
static interface	ExpandingTextArea.RowsChangeListener Listener for row count changes.

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

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

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

com.vaadin.v7.ui.AbstractField.FocusShortcut, com.vaadin.v7.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.v7.ui.Field

com.vaadin.v7.ui.Field.ValueChangeEvent

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

com.vaadin.v7.data.Buffered.SourceException

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

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

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 and Description
ExpandingTextArea() Constructs an empty ExpandingTextArea with no caption.
ExpandingTextArea(com.vaadin.v7.data.Property dataSource) Constructs a new ExpandingTextArea that's bound to the specified Property and has no caption.
ExpandingTextArea(String caption) Constructs an empty ExpandingTextArea with given caption.
ExpandingTextArea(String caption, com.vaadin.v7.data.Property dataSource) Constructs a new ExpandingTextArea that's bound to the specified Property and has the given caption String.
ExpandingTextArea(String caption, String value) Constructs a new ExpandingTextArea with the given caption and initial text contents.

Method Summary

Modifier and Type	Method and Description
void	addRowsChangeListener(ExpandingTextArea.RowsChangeListener listener) Adds a ExpandingTextArea.RowsChangeListener to the component.
int	getMaxRows() Returns the maximum allowed number of rows that the ExpandingTextArea will grow to, default is null that means that there is no limit for growing.
int	getRows()
void	paintContent(com.vaadin.server.PaintTarget target)
void	removeRowsChangeListener(ExpandingTextArea.RowsChangeListener listener) Removes a ExpandingTextArea.RowsChangeListener from the component.
void	setHeight(float height, com.vaadin.server.Sizeable.Unit unit)
void	setMaxRows(Integer maxRows) Sets the maximum allowed number of rows that the ExpandingTextArea will grow to, default is null that means that there is no limit for growing.
void	setRows(int rows)

Methods inherited from class com.vaadin.v7.ui.TextArea

clear, getState, getState, isWordwrap, readDesign, setWordwrap, writeDesign

Methods inherited from class com.vaadin.v7.ui.AbstractTextField

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

Methods inherited from class com.vaadin.v7.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, 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, shouldHideErrors, validate, validate, valueChange

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, setHeightUndefined, setIcon, setId, setParent, setPrimaryStyleName, setRequiredIndicatorVisible, setResponsive, setSizeFull, setSizeUndefined, 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, updateDiffstate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.LegacyComponent

markAsDirty

Methods inherited from interface com.vaadin.server.VariableOwner

isEnabled

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.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, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

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

addShortcutListener, removeShortcutListener

Constructor Detail

ExpandingTextArea

public ExpandingTextArea()

Constructs an empty ExpandingTextArea with no caption.

ExpandingTextArea

public ExpandingTextArea(String caption)

Constructs an empty ExpandingTextArea with given caption.

Parameters:

caption - the caption String for the editor.

ExpandingTextArea

public ExpandingTextArea(com.vaadin.v7.data.Property dataSource)

Constructs a new ExpandingTextArea that's bound to the specified Property and has no caption.

Parameters:

dataSource - the Property to be edited with this editor.

ExpandingTextArea

public ExpandingTextArea(String caption,
                         com.vaadin.v7.data.Property dataSource)

Constructs a new ExpandingTextArea that's bound to the specified Property and has the given caption String.

Parameters:

caption - the caption String for the editor.

dataSource - the Property to be edited with this editor.

ExpandingTextArea

public ExpandingTextArea(String caption,
                         String value)

Constructs a new ExpandingTextArea with the given caption and initial text contents. The editor constructed this way will not be bound to a Property unless com.vaadin.data.Property.Viewer#setPropertyDataSource(Property) is called to bind it.

Parameters:

caption - the caption String for the editor.

value - the initial text content of the editor.

Method Detail

paintContent

public void paintContent(com.vaadin.server.PaintTarget target)
                  throws com.vaadin.server.PaintException

Specified by:

paintContent in interface com.vaadin.ui.LegacyComponent

Overrides:

paintContent in class com.vaadin.v7.ui.AbstractTextField

Throws:

com.vaadin.server.PaintException

setRows

public void setRows(int rows)

Overrides:

setRows in class com.vaadin.v7.ui.TextArea

getRows

public int getRows()

Overrides:

getRows in class com.vaadin.v7.ui.TextArea

setHeight

public void setHeight(float height,
                      com.vaadin.server.Sizeable.Unit unit)

Specified by:

setHeight in interface com.vaadin.server.Sizeable

Overrides:

setHeight in class com.vaadin.ui.AbstractComponent

setMaxRows

public void setMaxRows(Integer maxRows)

Sets the maximum allowed number of rows that the ExpandingTextArea will grow to, default is null that means that there is no limit for growing. Please note that max rows doesn't work very well with IE8.

Parameters:

maxRows - null or >= 2.

getMaxRows

public int getMaxRows()

Returns the maximum allowed number of rows that the ExpandingTextArea will grow to, default is null that means that there is no limit for growing. Please note that max rows doesn't work very well with IE8.

addRowsChangeListener

public void addRowsChangeListener(ExpandingTextArea.RowsChangeListener listener)

Adds a ExpandingTextArea.RowsChangeListener to the component.

removeRowsChangeListener

public void removeRowsChangeListener(ExpandingTextArea.RowsChangeListener listener)

Removes a ExpandingTextArea.RowsChangeListener from the component.