com.haulmont.cuba.desktop.gui.components

Class DesktopTextArea

java.lang.Object

com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent<C>

com.haulmont.cuba.desktop.gui.components.DesktopAbstractField<T>

com.haulmont.cuba.desktop.gui.components.DesktopAbstractTextField<javax.swing.JTextArea>

com.haulmont.cuba.desktop.gui.components.DesktopTextArea

All Implemented Interfaces:

DesktopComponent, DesktopComponent.HasContextHelpClickHandler, Component, Component.BelongToFrame, Component.Buffered, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasContextHelp, Component.HasIcon, Component.HasInputPrompt, Component.HasValue, Component.HasXmlDescriptor, Component.Validatable, Component.Wrapper, DatasourceComponent, Field, TextArea, TextInputField, TextInputField.CaseConversionSupported, TextInputField.CursorPositionSupported, TextInputField.MaxLengthLimited, TextInputField.TextChangeNotifier, TextInputField.TextSelectionSupported, TextInputField.TrimSupported

Direct Known Subclasses:

DesktopResizableTextArea

public class DesktopTextArea
extends DesktopAbstractTextField<javax.swing.JTextArea>
implements TextArea

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.TextInputField

TextInputField.CaseConversion, TextInputField.CaseConversionSupported, TextInputField.CursorPositionSupported, TextInputField.EnterPressEvent, TextInputField.EnterPressListener, TextInputField.EnterPressNotifier, TextInputField.MaxLengthLimited, TextInputField.TextChangeEvent, TextInputField.TextChangeEventMode, TextInputField.TextChangeListener, TextInputField.TextChangeNotifier, TextInputField.TextSelectionSupported, TextInputField.TrimSupported

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Field

Field.Validator

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.Component

Component.ActionOwner, Component.ActionsHolder, Component.Alignment, Component.BelongToFrame, Component.Buffered, Component.ChildEditableController, Component.Collapsable, Component.Container, Component.ContextHelpIconClickEvent, Component.Disposable, Component.Editable, Component.EditableChangeEvent, Component.EditableChangeListener, Component.EditableChangeNotifier, Component.ExpandedStateChangeEvent, Component.ExpandedStateChangeListener, Component.Focusable, Component.HasBorder, Component.HasButtonsPanel, Component.HasCaption, Component.HasContextHelp, Component.HasFormatter, Component.HasIcon, Component.HasInputPrompt, Component.HasNamedComponents, Component.HasOptionsStyleProvider, Component.HasPresentations, Component.HasRowsCount, Component.HasSettings, Component.HasValue, Component.HasXmlDescriptor, Component.LayoutClickEvent, Component.LayoutClickListener, Component.LayoutClickNotifier, Component.Margin, Component.MouseEventDetails, Component.OptionsStyleProvider, Component.OrderedContainer, Component.OuterMargin, Component.SecuredActionsHolder, Component.ShortcutAction, Component.ShortcutNotifier, Component.ShortcutTriggeredEvent, Component.Spacing, Component.UiPermissionAware, Component.Validatable, Component.ValueChangeEvent, Component.ValueChangeListener, Component.Wrapper

Nested classes/interfaces inherited from interface com.haulmont.cuba.desktop.gui.components.DesktopComponent

DesktopComponent.HasContextHelpClickHandler

Field Summary

Fields inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent

SWING_PROPERTY_CLASS, SWING_PROPERTY_ID

Fields inherited from interface com.haulmont.cuba.gui.components.TextArea

NAME

Fields inherited from interface com.haulmont.cuba.gui.components.Component

AUTO_SIZE, AUTO_SIZE_PX, UNITS_PERCENTAGE, UNITS_PIXELS

Constructor Summary

Constructors

Constructor and Description
DesktopTextArea()

Method Summary

Modifier and Type	Method and Description
void	addTextChangeListener(TextInputField.TextChangeListener listener)
void	commit() Updates all changes since the previous commit to the data source.
void	discard() Discards all changes since last commit.
TextInputField.CaseConversion	getCaseConversion()
int	getColumns()
javax.swing.JComponent	getComposition()
Datatype	getDatatype()
java.lang.String	getInputPrompt()
int	getMaxLength()
java.lang.String	getRawValue() Returns a string representation of the value.
int	getRows()
TextInputField.TextChangeEventMode	getTextChangeEventMode()
int	getTextChangeTimeout() Gets the timeout used to fire TextInputField.TextChangeEvents when the TextInputField.TextChangeNotifier.getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.
boolean	isBuffered()
boolean	isModified() Tests if the value stored in the object has been modified since it was last updated from the data source.
boolean	isTrimming()
boolean	isWordwrap()
void	removeTextChangeListener(TextInputField.TextChangeListener listener)
void	selectAll()
void	setBuffered(boolean buffered) Sets the buffered mode.
void	setCaseConversion(TextInputField.CaseConversion caseConversion) Disable automatic case conversion or enable with chosen mode
void	setColumns(int columns)
void	setCursorPosition(int position) Sets the cursor position in the field.
void	setDatatype(Datatype datatype)
void	setHeight(java.lang.String height) Set component height in Component.getHeightUnits()
void	setInputPrompt(java.lang.String inputPrompt) Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.
void	setMaxLength(int value)
void	setRows(int rows)
void	setSelectionRange(int pos, int length)
void	setTextChangeEventMode(TextInputField.TextChangeEventMode mode) Sets the mode how the TextField triggers TextInputField.TextChangeEvents.
void	setTextChangeTimeout(int timeout) The text change timeout modifies how often text change events are communicated to the application when TextInputField.TextChangeNotifier.getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.
void	setTrimming(boolean trimming)
void	setWordwrap(boolean wordwrap)

Methods inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractTextField

getDatasource, getDescription, getMetaProperty, getMetaPropertyPath, getValue, setDatasource, setDescription, setValue, updateEnabled, updateMissingValueState

Methods inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractField

addListener, addValidator, addValueChangeListener, fireContextHelpIconClickEvent, getContextHelpIconClickHandler, getContextHelpText, getRequiredMessage, getValidators, isContextHelpTextHtmlEnabled, isEditable, isRequired, isValid, removeListener, removeValidator, removeValueChangeListener, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled, setEditable, setParent, setRequired, setRequiredMessage, validate

Methods inherited from class com.haulmont.cuba.desktop.gui.components.DesktopAbstractComponent

addStyleName, assignAutoDebugId, getAlignment, getCaption, getComponent, getDebugId, getFrame, getHeight, getHeightUnits, getIcon, getId, getParent, getStyleName, getTabIndex, getWidth, getWidthUnits, getXmlDescriptor, isComponentVisible, isEnabled, isEnabledItself, isParentEnabled, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setCaption, setContainer, setDebugId, setEnabled, setExpanded, setFrame, setIcon, setIconFromSet, setId, setParentEnabled, setResponsive, setStyleName, setTabIndex, setVisible, setWidth, setXmlDescriptor, unwrap, unwrapComposition

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.haulmont.cuba.gui.components.Field

addValidator, getRequiredMessage, getValidators, isRequired, removeValidator, setRequired, setRequiredMessage

Methods inherited from interface com.haulmont.cuba.gui.components.DatasourceComponent

getDatasource, getMetaProperty, getMetaPropertyPath, setDatasource

Methods inherited from interface com.haulmont.cuba.gui.components.Component

addStyleName, getAlignment, getDebugId, getHeight, getHeightUnits, getId, getParent, getStyleName, getWidth, getWidthUnits, isEnabled, isEnabledItself, isResponsive, isVisible, isVisibleItself, removeStyleName, requestFocus, setAlignment, setDebugId, setEnabled, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasCaption

getCaption, getDescription, setCaption, setDescription

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Validatable

isValid, isValidateOnCommit, validate

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface com.haulmont.cuba.gui.components.Component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface com.haulmont.cuba.gui.components.Component.Focusable

getTabIndex, isFocusable, setFocusable, setTabIndex

Constructor Detail

DesktopTextArea

public DesktopTextArea()

Method Detail

getComposition

public javax.swing.JComponent getComposition()

Specified by:

getComposition in interface Component.Wrapper

Overrides:

getComposition in class DesktopAbstractComponent<javax.swing.JTextArea>

getRows

public int getRows()

Specified by:

getRows in interface TextArea

setRows

public void setRows(int rows)

Specified by:

setRows in interface TextArea

setHeight

public void setHeight(java.lang.String height)

Description copied from interface: Component

Set component height in Component.getHeightUnits()

Specified by:

setHeight in interface Component

Overrides:

setHeight in class DesktopAbstractComponent<javax.swing.JTextArea>

getColumns

public int getColumns()

Specified by:

getColumns in interface TextArea

setColumns

public void setColumns(int columns)

Specified by:

setColumns in interface TextArea

isWordwrap

public boolean isWordwrap()

Specified by:

isWordwrap in interface TextArea

setWordwrap

public void setWordwrap(boolean wordwrap)

Specified by:

setWordwrap in interface TextArea

getMaxLength

public int getMaxLength()

Specified by:

getMaxLength in interface TextInputField.MaxLengthLimited

setMaxLength

public void setMaxLength(int value)

Specified by:

setMaxLength in interface TextInputField.MaxLengthLimited

isTrimming

public boolean isTrimming()

Specified by:

isTrimming in interface TextInputField.TrimSupported

setTrimming

public void setTrimming(boolean trimming)

Specified by:

setTrimming in interface TextInputField.TrimSupported

setCursorPosition

public void setCursorPosition(int position)

Description copied from interface: TextInputField.CursorPositionSupported

Sets the cursor position in the field.

Specified by:

setCursorPosition in interface TextInputField.CursorPositionSupported

Parameters:

position - new cursor position

getInputPrompt

public java.lang.String getInputPrompt()

Specified by:

getInputPrompt in interface Component.HasInputPrompt

Returns:

current input prompt.

setInputPrompt

public void setInputPrompt(java.lang.String inputPrompt)

Description copied from interface: Component.HasInputPrompt

Sets the input prompt - a textual prompt that is displayed when the field would otherwise be empty, to prompt the user for input.

Specified by:

setInputPrompt in interface Component.HasInputPrompt

Parameters:

inputPrompt - input prompt

getCaseConversion

public TextInputField.CaseConversion getCaseConversion()

Specified by:

getCaseConversion in interface TextInputField.CaseConversionSupported

Returns:

conversion mode or null if automatic conversion is disabled

setCaseConversion

public void setCaseConversion(TextInputField.CaseConversion caseConversion)

Description copied from interface: TextInputField.CaseConversionSupported

Disable automatic case conversion or enable with chosen mode

Specified by:

setCaseConversion in interface TextInputField.CaseConversionSupported

selectAll

public void selectAll()

Specified by:

selectAll in interface TextInputField.TextSelectionSupported

setSelectionRange

public void setSelectionRange(int pos,
                              int length)

Specified by:

setSelectionRange in interface TextInputField.TextSelectionSupported

addTextChangeListener

public void addTextChangeListener(TextInputField.TextChangeListener listener)

Specified by:

addTextChangeListener in interface TextInputField.TextChangeNotifier

removeTextChangeListener

public void removeTextChangeListener(TextInputField.TextChangeListener listener)

Specified by:

removeTextChangeListener in interface TextInputField.TextChangeNotifier

setTextChangeTimeout

public void setTextChangeTimeout(int timeout)

Description copied from interface: TextInputField.TextChangeNotifier

The text change timeout modifies how often text change events are communicated to the application when TextInputField.TextChangeNotifier.getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.

Specified by:

setTextChangeTimeout in interface TextInputField.TextChangeNotifier

Parameters:

timeout - timeout in milliseconds

getTextChangeTimeout

public int getTextChangeTimeout()

Description copied from interface: TextInputField.TextChangeNotifier

Gets the timeout used to fire TextInputField.TextChangeEvents when the TextInputField.TextChangeNotifier.getTextChangeEventMode() is TextInputField.TextChangeEventMode.LAZY or TextInputField.TextChangeEventMode.TIMEOUT.

Specified by:

getTextChangeTimeout in interface TextInputField.TextChangeNotifier

Returns:

timeout in milliseconds

getTextChangeEventMode

public TextInputField.TextChangeEventMode getTextChangeEventMode()

Specified by:

getTextChangeEventMode in interface TextInputField.TextChangeNotifier

Returns:

the mode used to trigger TextInputField.TextChangeEvents.

setTextChangeEventMode

public void setTextChangeEventMode(TextInputField.TextChangeEventMode mode)

Description copied from interface: TextInputField.TextChangeNotifier

Sets the mode how the TextField triggers TextInputField.TextChangeEvents.

Specified by:

setTextChangeEventMode in interface TextInputField.TextChangeNotifier

Parameters:

mode - the new mode

commit

public void commit()

Description copied from interface: Component.Buffered

Updates all changes since the previous commit to the data source.

Specified by:

commit in interface Component.Buffered

discard

public void discard()

Description copied from interface: Component.Buffered

Discards all changes since last commit. The object updates its value from the data source.

Specified by:

discard in interface Component.Buffered

isBuffered

public boolean isBuffered()

Specified by:

isBuffered in interface Component.Buffered

Returns:

true if buffered mode is on, false otherwise

setBuffered

public void setBuffered(boolean buffered)

Description copied from interface: Component.Buffered

Sets the buffered mode.

When in buffered mode, an internal buffer will be used to store changes until Component.Buffered.commit() is called. Calling Component.Buffered.discard() will revert the internal buffer to the value of the data source.

When in non-buffered mode both read and write operations will be done directly on the data source. In this mode the Component.Buffered.commit() and Component.Buffered.discard() methods serve no purpose.

Specified by:

setBuffered in interface Component.Buffered

Parameters:

buffered - true if buffered mode should be turned on, false otherwise

isModified

public boolean isModified()

Description copied from interface: Component.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 interface Component.Buffered

Returns:

true if the value in the object has been modified since the last data source update, false if not.

setDatatype

public void setDatatype(Datatype datatype)

Specified by:

setDatatype in interface TextArea

getRawValue

public java.lang.String getRawValue()

Description copied from interface: TextArea

Returns a string representation of the value.

Specified by:

getRawValue in interface TextArea

getDatatype

public Datatype getDatatype()

Specified by:

getDatatype in interface TextArea