Package de.espirit.firstspirit.access.store.templatestore.gom

Class GomTextarea

java.lang.Object

de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement

de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement

de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomTextualFormElement

de.espirit.firstspirit.access.store.templatestore.gom.GomTextarea

All Implemented Interfaces:

GomCheckable, GomElement, GomFormElement, GomHideable, GomLangInfoProvider, GomSearchRelevancy, GomTransferHandling, LineBreakable, Serializable

@NonExtendable
public class GomTextarea
extends AbstractGomTextualFormElement
implements GomTransferHandling

GuiXML implementation for text areas.

Since:

2.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomCheckable

GomCheckable.Context

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TAG	The tag of this component

Constructor Summary

Constructors

Constructor	Description
GomTextarea()

Method Summary

Modifier and Type	Method	Description
int	columns(int fallback)	Convenience API for getColumns() returning a fallback if unset
PositiveInteger	getColumns()	Number of columns
protected String	getDefaultTag()	Return the default tag for a gom element.
YesNo	getHtmlMode()	Deprecated. since 5.0.35 - no replacement
PositiveInteger	getRows()	Number of rows
@Nullable List<TransferType<?>>	getTransferTypes(SpecialistsBroker broker)	Returns a list of supported TransferType's, or null if transfer is not supported.
boolean	htmlMode()	Deprecated. since 5.0.35 with no replacement, will always return false
int	rows()	Convenience API for getRows() returning a default of 4 if unset
int	rows(int fallback)	Convenience API for getRows() returning a fallback if unset
void	setColumns(PositiveInteger columns)	Sets the number of columns
void	setHtmlMode(YesNo htmlMode)	Sets if to switch to HTML mode when using ContentCreator
void	setRows(PositiveInteger rows)	Sets the number of rows

Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomTextualFormElement

getLength, getMaxInputLength, length, maxInputLength, setLength, setMaxInputLength

Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement

allowsEmpty, breaks, clone, convertEntities, description, fillsHorizontally, getAllowEmpty, getConvertEntities, getDefaultValue, getHFill, getHidden, getLabel, getLangInfos, getName, getNoBreak, getPreset, getSearchRelevancy, getUseLanguages, isHidden, label, name, preset, setAllowEmpty, setConvertEntities, setDefaultValue, setHFill, setHidden, setLabel, setLabelAndDescription, setName, setNoBreak, setPreset, setSearchRelevancy, setUseLanguages, usesLanguages, validate, verify

Methods inherited from class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.gom.GomElement

getGomElementTag, getIncludeConfiguration, hasRepresentation, setGomElementTag, setIncludeConfiguration

Field Details

TAG

public static final String TAG

The tag of this component

Since:

4.2

See Also:

• Constant Field Values

Constructor Details

GomTextarea

public GomTextarea()

Method Details

getDefaultTag

protected String getDefaultTag()

Description copied from class: AbstractGomElement

Return the default tag for a gom element.

Specified by:

getDefaultTag in class AbstractGomElement

Returns:

The elements default tag.

getColumns

public PositiveInteger getColumns()

Number of columns

Since:

2.0

setColumns

public void setColumns(PositiveInteger columns)

Sets the number of columns

Since:

2.0

getRows

public PositiveInteger getRows()

Number of rows

Since:

2.0

setRows

public void setRows(PositiveInteger rows)

Sets the number of rows

Since:

2.0

getHtmlMode

@Deprecated(since="5.0.35")
public YesNo getHtmlMode()

Deprecated.

since 5.0.35 - no replacement

Switch to HTML mode when using ContentCreator

Since:

3.1

setHtmlMode

public void setHtmlMode(YesNo htmlMode)

Sets if to switch to HTML mode when using ContentCreator

Since:

3.1

getTransferTypes

@Nullable
public @Nullable List<TransferType<?>> getTransferTypes(SpecialistsBroker broker)

Description copied from interface: GomTransferHandling

Returns a list of supported TransferType's, or null if transfer is not supported.

Specified by:

getTransferTypes in interface GomTransferHandling

Parameters:

broker - Broker for requesting services or providers.

Returns:

supported transfer types, or null.

rows

public int rows(int fallback)

Convenience API for getRows() returning a fallback if unset

Parameters:

fallback - the fallback to return if the number of rows is unset

Returns:

the number of rows or the specified fallback if unset

Since:

2.0

rows

public int rows()

Convenience API for getRows() returning a default of 4 if unset

Returns:

the number of rows or 4 if unset

Since:

4.1.3

columns

public int columns(int fallback)

Convenience API for getColumns() returning a fallback if unset

Parameters:

fallback - the fallback to return if the number of columns is unset

Returns:

the number of columns or the specified fallback if unset

Since:

2.0

htmlMode

@Deprecated(since="5.0.35")
public boolean htmlMode()

Deprecated.

since 5.0.35 with no replacement, will always return false

Convenience API for getHtmlMode().

Returns:

false