htmlResponsiveInputTextarea
extends htmlInputTextarea
in package
Responsive text area with label and help link.
Table of Contents
- ALIGN_BOTTOM = 3
- align to bottom
- ALIGN_CENTER = 4
- align to center
- ALIGN_LEFT = 1
- align to left
- ALIGN_RIGHT = 2
- align to right
- ALIGN_TOP = 0
- align to top
- $alignment : int|null
- alignment when inside a table
- $colspan : int|null
- colspan if inside a table
- $rowspan : int|null
- rowspan if inside a table
- $cssClasses : array<string|int, mixed>|null
- $name : string
- unique name of input element
- $required : bool
- required field
- $richEdit : bool
- specifies if LAM should display this field with a WYSIWYG editor
- $tableCellCssClasses : array<string|int, mixed>|null
- $accessibilityLabel : string|null
- accessibility label
- $colCount : string
- column count
- $dataAttributes : array<string|int, mixed>
- $helpID : string|null
- help ID
- $helpModule : string|null
- help module
- $isEnabled : bool
- enabled or disabled
- $label : string
- descriptive label
- $renderParentHtml : bool
- render HTML of parent class
- $rowCount : string
- row count
- $shortLabel : bool
- short label
- $value : string
- value
- __construct() : mixed
- Constructor.
- addDataAttribute() : void
- Adds a data attribute.
- generateHTML() : array<string, string>
- Prints the HTML code for this element.
- getAccessibilityMarkup() : string
- Returns the markup for the accessibility data.
- getAlignmentString() : string
- Returns the HTML attributes for the alignment.
- getColspanString() : string
- Returns the HTML attribute for the colspan.
- getCSSClasses() : array<string|int, string>|null
- Returns the CSS classes of this element.
- getRowspanString() : string
- Returns the HTML attribute for the rowspan.
- getTableCellCSSClasses() : array<string|int, string>|null
- Returns the CSS classes of the surrounding table cell for this element.
- setAccessibilityLabel() : void
- Sets the accessibility label.
- setCSSClasses() : void
- Adds CSS classes to this element.
- setHelpId() : void
- Sets the help ID.
- setHelpModule() : void
- Sets the help module.
- setIsEnabled() : void
- Specifies if this component is enabled and accepts user modification.
- setIsRichEdit() : void
- Specifies if the textarea should be displayed with a WYSIWYG editor.
- setRequired() : void
- Specifies if the input field is required.
- setShortLabel() : void
- Use a short label (4 columns instead of 6) for tablet/desktop.
- setTableCellCSSClasses() : void
- Adds CSS classes to the surrounding table cell for this element.
- getDataAttributesAsString() : string
- Returns the data attributes as rendered string.
Constants
ALIGN_BOTTOM
align to bottom
public
mixed
ALIGN_BOTTOM
= 3
ALIGN_CENTER
align to center
public
mixed
ALIGN_CENTER
= 4
ALIGN_LEFT
align to left
public
mixed
ALIGN_LEFT
= 1
ALIGN_RIGHT
align to right
public
mixed
ALIGN_RIGHT
= 2
ALIGN_TOP
align to top
public
mixed
ALIGN_TOP
= 0
Properties
$alignment
alignment when inside a table
public
int|null
$alignment
= \null
$colspan
colspan if inside a table
public
int|null
$colspan
= \null
$rowspan
rowspan if inside a table
public
int|null
$rowspan
= \null
$cssClasses
protected
array<string|int, mixed>|null
$cssClasses
= []
CSS classes
$name
unique name of input element
protected
string
$name
$required
required field
protected
bool
$required
= \false
$richEdit
specifies if LAM should display this field with a WYSIWYG editor
protected
bool
$richEdit
= \false
$tableCellCssClasses
protected
array<string|int, mixed>|null
$tableCellCssClasses
= []
table cell CSS classes
$accessibilityLabel
accessibility label
private
string|null
$accessibilityLabel
= \null
$colCount
column count
private
string
$colCount
$dataAttributes
private
array<string|int, mixed>
$dataAttributes
= []
data attributes
$helpID
help ID
private
string|null
$helpID
= \null
$helpModule
help module
private
string|null
$helpModule
= \null
$isEnabled
enabled or disabled
private
bool
$isEnabled
= \true
$label
descriptive label
private
string
$label
$renderParentHtml
render HTML of parent class
private
bool
$renderParentHtml
= \false
$rowCount
row count
private
string
$rowCount
$shortLabel
short label
private
bool
$shortLabel
= \false
$value
value
private
string
$value
Methods
__construct()
Constructor.
public
__construct(string $name, string $value, int $colCount, int $rowCount, string $label[, string|array<string|int, string> $helpID = null ]) : mixed
Parameters
- $name : string
-
unique name
- $value : string
-
value
- $colCount : int
-
number of characters per line
- $rowCount : int
-
number of rows
- $label : string
-
descriptive label
- $helpID : string|array<string|int, string> = null
-
help ID
Return values
mixed —addDataAttribute()
Adds a data attribute.
public
addDataAttribute(string $key, string $value) : void
Parameters
- $key : string
-
attribute name (without "data-")
- $value : string
-
attribute value
Return values
void —generateHTML()
Prints the HTML code for this element.
public
generateHTML(mixed $module, mixed $input, mixed $values, mixed $restricted) : array<string, string>
Parameters
- $module : mixed
-
Name of account module
- $input : mixed
-
List of meta-HTML elements
- $values : mixed
-
List of values which override the defaults in $input (name => value)
- $restricted : mixed
-
If true then no buttons will be displayed
Return values
array<string, string> —List of input field names and their type (name => type)
getAccessibilityMarkup()
Returns the markup for the accessibility data.
public
getAccessibilityMarkup() : string
Return values
string —markup to be included in HTML tag (starting with space)
getAlignmentString()
Returns the HTML attributes for the alignment.
public
getAlignmentString() : string
Return values
string —alignment HTML attributes (e.g. align="right" valign="top")
getColspanString()
Returns the HTML attribute for the colspan.
public
getColspanString() : string
Return values
string —colspan HTML attribute (e.g. colspan=3)
getCSSClasses()
Returns the CSS classes of this element.
public
getCSSClasses() : array<string|int, string>|null
Return values
array<string|int, string>|null —$classes CSS class names
getRowspanString()
Returns the HTML attribute for the rowspan.
public
getRowspanString() : string
Return values
string —rowspan HTML attribute (e.g. rowspan=3)
getTableCellCSSClasses()
Returns the CSS classes of the surrounding table cell for this element.
public
getTableCellCSSClasses() : array<string|int, string>|null
Return values
array<string|int, string>|null —CSS classes
setAccessibilityLabel()
Sets the accessibility label.
public
setAccessibilityLabel(string|null $accessibilityLabel) : void
Parameters
- $accessibilityLabel : string|null
-
label
Return values
void —setCSSClasses()
Adds CSS classes to this element.
public
setCSSClasses(array<string|int, string>|null $classes) : void
Parameters
- $classes : array<string|int, string>|null
-
CSS class names
Return values
void —setHelpId()
Sets the help ID.
public
setHelpId(string|null $helpID) : void
Parameters
- $helpID : string|null
-
help ID
Return values
void —setHelpModule()
Sets the help module.
public
setHelpModule(string|null $helpModule) : void
Parameters
- $helpModule : string|null
-
help module name
Return values
void —setIsEnabled()
Specifies if this component is enabled and accepts user modification.
public
setIsEnabled(bool $isEnabled) : void
Parameters
- $isEnabled : bool
-
enabled if true
Return values
void —setIsRichEdit()
Specifies if the textarea should be displayed with a WYSIWYG editor.
public
setIsRichEdit(bool $richEdit) : void
This requires that the page which displays the textarea also includes the JS for the rich editing.
Rich editing is disabled by default.
Parameters
- $richEdit : bool
-
rich edit or standard
Return values
void —setRequired()
Specifies if the input field is required.
public
setRequired(bool $required) : void
Parameters
- $required : bool
-
required
Return values
void —setShortLabel()
Use a short label (4 columns instead of 6) for tablet/desktop.
public
setShortLabel() : void
Return values
void —setTableCellCSSClasses()
Adds CSS classes to the surrounding table cell for this element.
public
setTableCellCSSClasses(array<string|int, string>|null $classes) : void
Parameters
- $classes : array<string|int, string>|null
-
CSS class names
Return values
void —getDataAttributesAsString()
Returns the data attributes as rendered string.
protected
getDataAttributesAsString() : string
Return values
string —data attributes