to.etc.domui.dom.html

Class TextArea

java.lang.Object

to.etc.domui.dom.css.CssBase

to.etc.domui.dom.html.NodeBase

to.etc.domui.dom.html.NodeContainer

to.etc.domui.dom.html.InputNodeContainer

to.etc.domui.dom.html.TextArea

All Implemented Interfaces:

Iterable<NodeBase>, INodeErrorDelegate, IActionControl, IControl<String>, IHasChangeListener, IHasModifiedIndication, IHtmlInput, INativeChangeListener

Direct Known Subclasses:

CKEditor, HtmlEditor, TextDisplayArea

public class TextArea
extends InputNodeContainer
implements INativeChangeListener, IControl<String>, IHasModifiedIndication, IHtmlInput

Field Summary

Fields

Modifier and Type	Field and Description
static String	HINT Hint to use in property meta data to select this component.

Constructor Summary

Constructors

Constructor and Description
TextArea()
TextArea(int cols, int rows)

Method Summary

Modifier and Type	Method and Description
boolean	acceptRequestParameter(String[] values)
static TextArea	create(PropertyMetaModel<?> pmm)
String	getBindValue() Bind-capable version of getValue().
int	getCols()
String	getDisabledBecause()
int	getMaxByteLength() When > 0, this sets the max length in UTF-8 bytes for the text area.
int	getMaxLength() This sets the max input length for the text area, or unlimited when <= 0.
String	getRawValue()
int	getRows()
String	getValue() Returns the current value of this input component.
String	getValueSafe() Like IControl.getValue() this returns the value of the component, but this returns null if the value was invalid.
boolean	hasError() Return T if this node currently has an error associated with it.
boolean	isDisabled() Returns T if the control is currently in disabled.
boolean	isModified() Returns the modified-by-user flag.
void	setBindValue(String value)
void	setCols(int cols)
void	setDisabled(boolean disabled) Set the input to disabled mode.
void	setDisabledBecause(String msg)
void	setMaxByteLength(int maxByteLength)
void	setMaxLength(int maxLength)
void	setModified(boolean as) Set or clear the modified by user flag.
void	setReadOnly(boolean readOnly) Sets the input to readonly-mode.
void	setRows(int rows)
void	setValue(String v) Set a new value into this control.
void	visit(INodeVisitor v) This must visit the appropriate method in the node visitor.

Methods inherited from class to.etc.domui.dom.html.InputNodeContainer

callOnValueChanged, getOnValueChanged, immediate, immediate, isImmediate, isMandatory, isReadOnly, setMandatory, setOnValueChanged

Methods inherited from class to.etc.domui.dom.html.NodeContainer

add, add, add, addTable, addTableForLayout, addTableForLayout, appendTreeErrors, canContain, createFrame, delegateTo, disableAllChildControlsDeep, findChildIndex, forceRebuild, getChild, getChildCount, getChildren, getDeepChildren, getDelegate, getErrorFence, getTextContents, internalAdd, internalCheckNotDirty, internalClearDelta, internalClearDeltaFully, internalCreateFrame, internalGetNodeCount, internalGetOldChildren, internalOnBeforeRender, internalShelve, internalUnshelve, iterator, onRefresh, removeAllChildren, removeChild, removeChild, replaceChild, setErrorFence, setErrorFence, setText, setValue, undelegatedAdd, undelegatedGetChild

Methods inherited from class to.etc.domui.dom.html.NodeBase

$, addBinding, addCssClass, addGlobalMessage, addNotificationListener, afterCreateContent, alignToLeft, alignToLeft, alignToMiddle, alignToMiddle, alignTopToBottom, alignTopToBottom, alignToRight, alignToRight, alignToTop, alignToTop, appendAfterMe, appendBeforeMe, appendCreateJS, appendJavascript, appendJQuerySelector, appendJsCustomUpdatesContributor, appendShowOverflowTextAsTitleJs, appendStatement, beforeCreateContent, bind, bind, bindErrors, build, calcTestID, changed, changedJavascriptState, clearFocusRequested, clearGlobalMessage, clearGlobalMessage, clearGlobalMessage, clearMessage, clearValidationFailure, componentHandleWebAction, componentHandleWebDataRequest, createContent, createStatement, findComponentBundle, findParent, getActualID, getAllocationTracepoint, getBindingErrors, getBindingList, getBrowserWindowSize, getCalculatedTestID, getClicked, getClientBounds, getComponentBundle, getComponentDataURL, getComponentDataURL, getComponentInfo, getComponentJSONURL, getCreateJS, getCssClass, getErrorList, getErrorLocation, getFocusID, getMessage, getOnClickJS, getOnMouseDownJS, getOnSizeAndPositionChange, getPage, getParent, getParent, getParent, getParentOfTypes, getSharedContext, getSharedContextFactory, getSpecialAttribute, getSpecialAttributeList, getTag, getTestID, getTestRepeatId, getThemedResourceRURL, getTitle, getUserObject, handleDrop, hasCssClass, hasParent, internalGetOldParent, internalGetParent, internalHasChangedAttributes, internalNeedClickHandler, internalOnClicked, internalOnValueChanged, internalRenderJavascriptDelta, internalRenderJavascriptState, internalSetHasChangedAttributes, internalSetHasChangedAttributes, internalSetLogAllocations, internalSetTag, isAttached, isBuilt, isFocusable, isFocusRequested, isRendersOwnClose, isStretchHeight, lc, notify, notifyParentOrOpenerPage, onAddedToPage, onBeforeFullRender, onBeforeRender, onForceRebuild, onHeaderContributors, onRemoveFromPage, onShelve, onUnshelve, refresh, remove, removeBinding, removeCssClass, renderJavascriptDelta, renderJavascriptState, renderJavascriptState, replaceWith, setBrowserWindowSize, setCalculcatedId, setCalculcatedId, setClicked, setClientBounds, setComponentBundle, setCssClass, setErrorLocation, setFocus, setMessage, setOnClickJS, setOnMouseDownJS, setOnSizeAndPositionChange, setOverrideTitle, setSpecialAttribute, setStretchHeight, setTestID, setTestRepeatID, setTitle, setUserObject, toString

Methods inherited from class to.etc.domui.dom.css.CssBase

getBackgroundAttachment, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorderBottomColor, getBorderBottomStyle, getBorderBottomWidth, getBorderLeftColor, getBorderLeftStyle, getBorderLeftWidth, getBorderRightColor, getBorderRightStyle, getBorderRightWidth, getBorderTopColor, getBorderTopStyle, getBorderTopWidth, getBottom, getCachedStyle, getClear, getColor, getDisplay, getFloat, getFontFamily, getFontSize, getFontSizeAdjust, getFontStyle, getFontVariant, getFontWeight, getHeight, getLeft, getLineHeight, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOverflow, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getPosition, getRight, getTextAlign, getTop, getTransform, getVerticalAlign, getVisibility, getWidth, getZIndex, internalSetDisplay, setBackgroundAttachment, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorder, setBorderBottomColor, setBorderBottomStyle, setBorderBottomWidth, setBorderColor, setBorderLeftColor, setBorderLeftStyle, setBorderLeftWidth, setBorderRightColor, setBorderRightStyle, setBorderRightWidth, setBorderStyle, setBorderTopColor, setBorderTopStyle, setBorderTopWidth, setBorderWidth, setBottom, setBottom, setCachedStyle, setClear, setColor, setDisplay, setFloat, setFontFamily, setFontSize, setFontSizeAdjust, setFontStyle, setFontVariant, setFontWeight, setHeight, setLeft, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPosition, setRight, setRight, setTextAlign, setTop, setTop, setTransform, setVerticalAlign, setVisibility, setWidth, setZIndex

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface to.etc.domui.dom.html.INativeChangeListener

getOnValueChanged

Methods inherited from interface to.etc.domui.dom.html.IControl

getErrorLocation, isMandatory, isReadOnly, setErrorLocation, setMandatory

Methods inherited from interface to.etc.domui.dom.html.IActionControl

setTestID

Methods inherited from interface to.etc.domui.dom.html.IHasChangeListener

getOnValueChanged, setOnValueChanged

Methods inherited from interface to.etc.domui.dom.errors.INodeErrorDelegate

clearMessage, getMessage, setMessage

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

HINT

public static final String HINT

Hint to use in property meta data to select this component.

See Also:

Constant Field Values

Constructor Detail

TextArea

public TextArea()

TextArea

public TextArea(int cols,
                int rows)

Method Detail

visit

public void visit(INodeVisitor v)
           throws Exception

Description copied from class: NodeBase

This must visit the appropriate method in the node visitor. It should NOT recurse it's children.

Specified by:

visit in class InputNodeContainer

Throws:

Exception

getCols

public int getCols()

setCols

public void setCols(int cols)

getRows

public int getRows()

setRows

public void setRows(int rows)

getBindValue

@Nullable
public String getBindValue()

Bind-capable version of getValue(). If called (usually from binding) this will act as follows:

• If this component has an input error: throw the ValidationException for that error
• On no error this returns the value.

Returns:

setBindValue

public void setBindValue(@Nullable
                         String value)

getValue

public String getValue()

Description copied from interface: IControl

Returns the current value of this input component. If the component contains no value this returns null. All text input components will return null when their value is the empty string! If the component, during conversion or validation of the input value, discovers that the input is invalid it will set itself in "error" mode, post an error message up the form, and throw a ValidationException. This means that this call either delivers correct input (as defined by it's converter and validators), null (when empty) or throws an exception. When a ValidationException occurs the framework mostly ignores it - it does not produce a stacktrace or error in the client. Instead the resulting error as posted by the error handling framework gets displayed on the form when the request completes.

To get the value of a component while ignoring exceptions call IControl.getValueSafe().

Specified by:

getValue in interface IControl<String>

Returns:

See Also:

IControl.getValue()

getValueSafe

public String getValueSafe()

Description copied from interface: IControl

Like IControl.getValue() this returns the value of the component, but this returns null if the value was invalid. For this method NULL either means the value was invalid OR it's content was empty. To distinguish between the two call IControl.hasError() or use IControl.getValue() instead of this call.

Specified by:

getValueSafe in interface IControl<String>

Returns:

See Also:

IControl.getValueSafe()

hasError

public boolean hasError()

Description copied from class: NodeBase

Return T if this node currently has an error associated with it.

Specified by:

hasError in interface IControl<String>

Overrides:

hasError in class NodeContainer

Returns:

See Also:

IControl.hasError()

getRawValue

public String getRawValue()

isDisabled

public boolean isDisabled()

Description copied from interface: IControl

Returns T if the control is currently in disabled. Controls that do not have a readonly ability (comboboxes) will use disabled as the readonly state. For those controls the readonly state mirrors the disabled state.

Specified by:

isDisabled in interface IControl<String>

Specified by:

isDisabled in interface IHtmlInput

setDisabled

public void setDisabled(boolean disabled)

Description copied from interface: IActionControl

Set the input to disabled mode.

Specified by:

setDisabled in interface IActionControl

Specified by:

setDisabled in interface IHtmlInput

getDisabledBecause

@Nullable
public String getDisabledBecause()

setDisabledBecause

public void setDisabledBecause(@Nullable
                               String msg)

setValue

public void setValue(@Nullable
                     String v)

Description copied from interface: IControl

Set a new value into this control. Setting a value to null means the control holds no value. This value is converted to a presentable form using any (implicitly) defined converters; it will not be validated though! This means that if you set an invalid value for a validator this will not be seen until the value is gotten from the control again.

Specified by:

setValue in interface IControl<String>

acceptRequestParameter

public boolean acceptRequestParameter(@Nonnull
                                      String[] values)
                               throws Exception

Overrides:

acceptRequestParameter in class NodeBase

Throws:

Exception

isModified

public boolean isModified()

Returns the modified-by-user flag.

Specified by:

isModified in interface IHasModifiedIndication

See Also:

IHasModifiedIndication.isModified()

setModified

public void setModified(boolean as)

Set or clear the modified by user flag.

Specified by:

setModified in interface IHasModifiedIndication

See Also:

IHasModifiedIndication.setModified(boolean)

create

@Nonnull
public static TextArea create(@Nonnull
                                       PropertyMetaModel<?> pmm)

setReadOnly

public void setReadOnly(boolean readOnly)

Description copied from interface: IControl

Sets the input to readonly-mode. Components that do not implement readonly mode (comboboxes) will usually set themselves to disabled which works much the same.

Specified by:

setReadOnly in interface IControl<String>

Overrides:

setReadOnly in class InputNodeContainer

getMaxLength

public int getMaxLength()

This sets the max input length for the text area, or unlimited when <= 0. This is not a valid HTML attribute for html < 5; the handling is done in Javascript.

Returns:

setMaxLength

public void setMaxLength(int maxLength)

getMaxByteLength

public int getMaxByteLength()

When > 0, this sets the max length in UTF-8 bytes for the text area. This is a workaround for Oracle's 4000 byte varchar2 limit in versions < 12c. When set, the text area will first apply the limit set by maxLength; if that still delivers more bytes than set in this property it will limit to the number of bytes here by removing characters.

Returns:

setMaxByteLength

public void setMaxByteLength(int maxByteLength)