Package com.helger.html.hc.html.forms

Interface IHCTextArea<IMPLTYPE extends IHCTextArea<IMPLTYPE>>

Type Parameters:

IMPLTYPE - Implementation type

All Superinterfaces:

com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, com.helger.commons.hierarchy.IHasChildren<IHCNode>, com.helger.commons.hierarchy.IHasChildrenRecursive<IHCNode>, com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>, IHCControl<IMPLTYPE>, IHCElement<IMPLTYPE>, IHCHasCSSClasses<IMPLTYPE>, IHCHasCSSStyles<IMPLTYPE>, IHCHasFocus<IMPLTYPE>, IHCHasID<IMPLTYPE>, IHCHasName<IMPLTYPE>, IHCHasState<IMPLTYPE>, IHCNode, Serializable

All Known Implementing Classes:

AbstractHCTextArea, HCTextArea

public interface IHCTextArea<IMPLTYPE extends IHCTextArea<IMPLTYPE>>
extends IHCControl<IMPLTYPE>

Interface for TEXTAREAs

Author:

Philip Helger

Field Summary

Fields inherited from interface com.helger.html.hc.html.IHCElement

DEFAULT_TABINDEX

Method Summary

Modifier and Type	Method	Description
int	getCols()
String	getDirName()
String	getForm()
int	getMaxLength()
int	getMinLength()
String	getPlaceholder()
int	getRows()
String	getValue()
EHCTextAreaWrap	getWrap()
default boolean	hasPlaceholder()
boolean	isAutoCompleteOff()
boolean	isAutoCompleteOn()
boolean	isAutoCompleteUndefined()
boolean	isAutoFocus()
default IMPLTYPE	setAutoComplete(boolean bAutoComplete)
IMPLTYPE	setAutoComplete(com.helger.commons.state.ETriState eAutoComplete)
IMPLTYPE	setAutoFocus(boolean bAutoFocus)	Change the auto focused state of this element.
IMPLTYPE	setCols(int nCols)
IMPLTYPE	setDirName(String sDirName)
IMPLTYPE	setForm(String sForm)
IMPLTYPE	setMaxLength(int nMaxLength)	Set the maximum number of characters to be entered.
IMPLTYPE	setMinLength(int nMinLength)	Set the minimum number of characters to be entered.
IMPLTYPE	setPlaceholder(String sPlaceholder)	Set the new value for the HTML placeholder attribute.
IMPLTYPE	setRows(int nRows)
IMPLTYPE	setValue(String sValue)
IMPLTYPE	setWrap(EHCTextAreaWrap eWrap)

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.commons.hierarchy.IHasChildren

forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getChildCount, getChildren, hasChildren, hasNoChildren

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenRecursive

forAllChildrenRecursive, forAllChildrenRecursive

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenSorted

findFirstChild, findFirstChildMapped, getAllChildren, getChildAtIndex, getFirstChild, getLastChild

Methods inherited from interface com.helger.html.hc.html.forms.IHCControl

isReadOnly, isRequired, setReadOnly, setRequired

Methods inherited from interface com.helger.html.hc.html.IHCElement

addEventHandler, containsEventHandler, customAttrs, getAccessKey, getContentEditable, getDirection, getDraggable, getElement, getEventHandler, getEventMap, getLanguage, getRole, getTabIndex, getTagName, getTitle, getTranslate, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, prependEventHandler, removeAllEventHandler, setAccessKey, setContentEditable, setDirection, setDraggable, setEventHandler, setHidden, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setTranslate, setUnfocusable, withCustomAttrs

Methods inherited from interface com.helger.html.hc.html.IHCHasCSSClasses

addClass, addClasses, addClasses, addClasses, containsClass, getAllClasses, getAllClassesAsString, getAllClassNames, hasAnyClass, removeAllClasses, removeClass

Methods inherited from interface com.helger.html.hc.html.IHCHasCSSStyles

addStyle, addStyle, addStyles, addStyles, addStyles, containsStyle, getAllStyles, getAllStylesAsString, getAllStyleValues, getStyleValue, hasAnyStyle, hasStyle, removeAllStyles, removeStyle

Methods inherited from interface com.helger.html.hc.IHCHasID

ensureID, getID, hasID, hasNoID, setID, setUniqueID

Methods inherited from interface com.helger.html.hc.IHCHasName

getName, setName

Methods inherited from interface com.helger.html.hc.html.IHCHasState

isDisabled, setDisabled

Methods inherited from interface com.helger.html.hc.IHCNode

canConvertToMicroNode, consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, getPlainText, registerExternalResources

Method Detail

isAutoCompleteOn

boolean isAutoCompleteOn()

isAutoCompleteOff

boolean isAutoCompleteOff()

isAutoCompleteUndefined

boolean isAutoCompleteUndefined()

setAutoComplete

@Nonnull
default IMPLTYPE setAutoComplete(boolean bAutoComplete)

setAutoComplete

@Nonnull
IMPLTYPE setAutoComplete(@Nonnull
                         com.helger.commons.state.ETriState eAutoComplete)

isAutoFocus

boolean isAutoFocus()

Specified by:

isAutoFocus in interface IHCHasFocus<IMPLTYPE extends IHCTextArea<IMPLTYPE>>

Returns:

true if this element is focused, false otherwise. By default an element is not focused.

setAutoFocus

@Nonnull
IMPLTYPE setAutoFocus(boolean bAutoFocus)

Description copied from interface: IHCHasFocus

Change the auto focused state of this element.

Specified by:

setAutoFocus in interface IHCHasFocus<IMPLTYPE extends IHCTextArea<IMPLTYPE>>

Parameters:

bAutoFocus - true to auto focus this element, false to not focus the element.

Returns:

this

getCols

int getCols()

setCols

@Nonnull
IMPLTYPE setCols(int nCols)

getDirName

@Nullable
String getDirName()

setDirName

@Nonnull
IMPLTYPE setDirName(@Nullable
                    String sDirName)

getForm

@Nullable
String getForm()

setForm

@Nonnull
IMPLTYPE setForm(@Nullable
                 String sForm)

getMaxLength

int getMaxLength()

Returns:

The currently set max length or -1.

setMaxLength

@Nonnull
IMPLTYPE setMaxLength(int nMaxLength)

Set the maximum number of characters to be entered.

Parameters:

nMaxLength - The max length. Should be > 0.

Returns:

this

getMinLength

int getMinLength()

Returns:

The currently set min length or -1.

setMinLength

@Nonnull
IMPLTYPE setMinLength(int nMinLength)

Set the minimum number of characters to be entered.

Parameters:

nMinLength - The min length. Should be > 0.

Returns:

this

getPlaceholder

@Nullable
String getPlaceholder()

Returns:

The current value of the HTML placeholder attribute. May be null.

hasPlaceholder

default boolean hasPlaceholder()

Returns:

true if a placeholder is present, false otherwise.

setPlaceholder

@Nonnull
IMPLTYPE setPlaceholder(@Nullable
                        String sPlaceholder)

Set the new value for the HTML placeholder attribute.

Parameters:

sPlaceholder - The new value. May be null.

Returns:

this

getRows

int getRows()

setRows

@Nonnull
IMPLTYPE setRows(int nRows)

getValue

@Nullable
String getValue()

setValue

@Nonnull
IMPLTYPE setValue(@Nullable
                  String sValue)

getWrap

@Nullable
EHCTextAreaWrap getWrap()

setWrap

@Nonnull
IMPLTYPE setWrap(@Nullable
                 EHCTextAreaWrap eWrap)