LDAP Account Manager

htmlTableExtendedInputCheckbox extends htmlInputCheckbox
in package

Checkbox with descriptive 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
VALIDATE_NUMERIC  = 'numeric'
validation rule to allow only numbers ([0-9]+)
VALIDATE_NUMERIC_WITH_NEGATIVE  = 'numericWithNegative'
validation rule to allow positive/negative numbers ([-]?[0-9]+)
$alignment  : mixed
alignment when inside a table
$colspan  : mixed
colspan if inside a table
$rowspan  : mixed
rowspan if inside a table
$checked  : mixed
value
$cssClasses  : mixed
CSS classes
$elementsToDisable  : mixed
list of input elements to disable when checked
$elementsToEnable  : mixed
list of input elements to enable when checked
$isEnabled  : mixed
enabled or disabled
$name  : mixed
unique name of input element
$tableCellCssClasses  : mixed
table cell CSS classes
$tableRowsToHide  : mixed
list of enclosing table rows to hide when checked
$tableRowsToShow  : mixed
list of enclosing table rows to show when checked
$dataAttributes  : mixed
data attributes
$helpID  : mixed
help ID
$label  : mixed
descriptive label
$labelFirst  : mixed
specifies if label is printed before the checkbox
$onClick  : mixed
onclick event code
$transient  : mixed
indicates that this field should not automatically be saved in the self service or server profile
__construct()  : mixed
Constructor.
addDataAttribute()  : mixed
Adds a data attribute.
generateHTML()  : array<string|int, mixed>
Prints the HTML code for this element.
getAlignmentString()  : string
Returns the HTML attributes for the alignment.
getColspanString()  : string
Returns the HTML attribute for the colspan.
getCSSClasses()  : array<string|int, mixed>
Returns the CSS classes of this element.
getRowspanString()  : string
Returns the HTML attribute for the rowspan.
getTableCellCSSClasses()  : array<string|int, mixed>
Returns the CSS classes of the surrounding table cell for this element.
setCSSClasses()  : mixed
Adds CSS classes to this element.
setElementsToDisable()  : mixed
This will disable the given input elements when the checkbox is checked.
setElementsToEnable()  : mixed
This will enable the given input elements when the checkbox is checked.
setIsEnabled()  : mixed
Specifies if this component is enabled and accepts user modification.
setOnClick()  : mixed
Sets the onclick code.
setTableCellCSSClasses()  : mixed
Adds CSS classes to the surrounding table cell for this element.
setTableRowsToHide()  : mixed
This will hide the given table rows when the checkbox is checked.
setTableRowsToShow()  : mixed
This will show the given table rows when the checkbox is checked.
setTransient()  : mixed
Specifies that the value should not be automatically saved when used in self service or server profile (default: false).
getDataAttributesAsString()  : string
Returns the data attributes as rendered string.
getShowHideSelector()  : mixed
Returns the CSS selector to use to find show/hide elements.

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

VALIDATE_NUMERIC

validation rule to allow only numbers ([0-9]+)

public mixed VALIDATE_NUMERIC = 'numeric'

VALIDATE_NUMERIC_WITH_NEGATIVE

validation rule to allow positive/negative numbers ([-]?[0-9]+)

public mixed VALIDATE_NUMERIC_WITH_NEGATIVE = 'numericWithNegative'

Properties

$alignment

alignment when inside a table

public mixed $alignment = \null

$colspan

colspan if inside a table

public mixed $colspan = \null

$rowspan

rowspan if inside a table

public mixed $rowspan = \null

$checked

value

protected mixed $checked

$cssClasses

CSS classes

protected mixed $cssClasses = array()

$elementsToDisable

list of input elements to disable when checked

protected mixed $elementsToDisable = array()

$elementsToEnable

list of input elements to enable when checked

protected mixed $elementsToEnable = array()

$isEnabled

enabled or disabled

protected mixed $isEnabled = \true

$name

unique name of input element

protected mixed $name

$tableCellCssClasses

table cell CSS classes

protected mixed $tableCellCssClasses = array()

$tableRowsToHide

list of enclosing table rows to hide when checked

protected mixed $tableRowsToHide = array()

$tableRowsToShow

list of enclosing table rows to show when checked

protected mixed $tableRowsToShow = array()

$dataAttributes

data attributes

private mixed $dataAttributes = array()

$helpID

help ID

private mixed $helpID

$label

descriptive label

private mixed $label

$labelFirst

specifies if label is printed before the checkbox

private mixed $labelFirst

$onClick

onclick event code

private mixed $onClick

$transient

indicates that this field should not automatically be saved in the self service or server profile

private mixed $transient = \false

Methods

__construct()

Constructor.

public __construct(string $name, bool $checked, string $label[, string $helpID = null ][, bool $labelFirst = true ]) : mixed
Parameters
$name : string

unique name

$checked : bool

checked

$label : string

descriptive label

$helpID : string = null

help ID

$labelFirst : bool = true

specifies if the label is at the beginning or at the end (optional, default beginning)

Return values
mixed

addDataAttribute()

Adds a data attribute.

public addDataAttribute(string $key, string $value) : mixed
Parameters
$key : string

attribute name (without "data-")

$value : string

attribute value

Return values
mixed

generateHTML()

Prints the HTML code for this element.

public generateHTML(string $module, array<string|int, mixed> $input, array<string|int, mixed> $values, bool $restricted, int &$tabindex, string $scope) : array<string|int, mixed>
Parameters
$module : string

Name of account module

$input : array<string|int, mixed>

List of meta-HTML elements

$values : array<string|int, mixed>

List of values which override the defaults in $input (name => value)

$restricted : bool

If true then no buttons will be displayed

$tabindex : int

Start value of tabulator index for input fields

$scope : string

Account type

Return values
array<string|int, mixed>

List of input field names and their type (name => type)

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, mixed>
Return values
array<string|int, mixed>

$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, mixed>
Return values
array<string|int, mixed>

CSS classes

setCSSClasses()

Adds CSS classes to this element.

public setCSSClasses(array<string|int, mixed> $classes) : mixed
Parameters
$classes : array<string|int, mixed>

CSS class names

Return values
mixed

setElementsToDisable()

This will disable the given input elements when the checkbox is checked.

public setElementsToDisable(array<string|int, mixed> $elements) : mixed

The given IDs can be of any input element (e.g. select, checkbox, ...).

Parameters
$elements : array<string|int, mixed>

IDs of elements to disable

Return values
mixed

setElementsToEnable()

This will enable the given input elements when the checkbox is checked.

public setElementsToEnable(array<string|int, mixed> $elements) : mixed

The given IDs can be of any input element (e.g. select, checkbox, ...).

Parameters
$elements : array<string|int, mixed>

IDs of elements to enable

Return values
mixed

setIsEnabled()

Specifies if this component is enabled and accepts user modification.

public setIsEnabled(bool $isEnabled) : mixed
Parameters
$isEnabled : bool

enabled if true

Return values
mixed

setOnClick()

Sets the onclick code.

public setOnClick(string $code) : mixed
Parameters
$code : string

JS code

Return values
mixed

setTableCellCSSClasses()

Adds CSS classes to the surrounding table cell for this element.

public setTableCellCSSClasses(array<string|int, mixed> $classes) : mixed
Parameters
$classes : array<string|int, mixed>

CSS class names

Return values
mixed

setTableRowsToHide()

This will hide the given table rows when the checkbox is checked.

public setTableRowsToHide(array<string|int, mixed> $tableRowsToHide) : mixed

The given IDs can be of any e.g. input element. Starting from this element the first parent "" element will be used to show/hide.


Example:
Using "mycheckbox" will use this "tr" to hide/show.

Parameters
$tableRowsToHide : array<string|int, mixed>

IDs of child elements to hide

Return values
mixed

setTableRowsToShow()

This will show the given table rows when the checkbox is checked.

public setTableRowsToShow(array<string|int, mixed> $tableRowsToShow) : mixed

The given IDs can be of any e.g. input element. Starting from this element the first parent "" element will be used to show/hide.


Example:
Using "mycheckbox" will use this "tr" to hide/show.

Parameters
$tableRowsToShow : array<string|int, mixed>

IDs of child elements to show

Return values
mixed

setTransient()

Specifies that the value should not be automatically saved when used in self service or server profile (default: false).

public setTransient(bool $transient) : mixed
Parameters
$transient : bool

transient field

Return values
mixed

getDataAttributesAsString()

Returns the data attributes as rendered string.

protected getDataAttributesAsString() : string
Return values
string

data attributes

getShowHideSelector()

Returns the CSS selector to use to find show/hide elements.

protected getShowHideSelector() : mixed
Return values
mixed

Search results