Jelix 1.7.17

WidgetBase
in package
implements WidgetInterface

Interfaces, Classes and Traits

WidgetInterface
Interface for HTML widgets plugins.

Table of Contents

$_endt  : mixed
$attributes  : array<string|int, mixed>
html attributes for the control.
$builder  : HtmlBuilder
The form builder.
$ctrl  : jFormsControl
The control.
$defaultAttributes  : array<string|int, mixed>
default html attributes for the control.
$labelAttributes  : array<string|int, mixed>
html attributes for the control label.
$parentWidget  : ParentWidgetInterface
the parent widget.
$valuesSeparator  : mixed
__construct()  : mixed
getId()  : mixed
Get the control id.
getName()  : mixed
Get the control name.
getValue()  : mixed
return the value of the HTML element.
outputControl()  : mixed
displays the form field itself.
outputControlValue()  : mixed
displays the value of the form field only.
outputHelp()  : mixed
This function displays the blue question mark near the form field.
outputLabel()  : mixed
This function displays the form field label.
outputMetaContent()  : mixed
add the CSS and javascript link.
setAttributes()  : mixed
set attributes to add on the HTML element.
setDefaultAttributes()  : mixed
setLabelAttributes()  : mixed
_outputAttr()  : mixed
commonGetJsConstraints()  : mixed
commonJs()  : mixed
escJsStr()  : mixed
fillSelect()  : mixed
getControlAttributes()  : mixed
Returns an array containing all the control attributes.
getCSSClass()  : mixed
Get the control class.
getLabelAttributes()  : mixed
Retrieve the label attributes.
getValueAttributes()  : mixed
outputLabelAsFormLabel()  : mixed
outputLabelAsTitle()  : mixed

Properties

$attributes

html attributes for the control.

protected array<string|int, mixed> $attributes = array()

$builder

The form builder.

protected HtmlBuilder $builder

$defaultAttributes

default html attributes for the control.

protected array<string|int, mixed> $defaultAttributes = array()

$labelAttributes

html attributes for the control label.

protected array<string|int, mixed> $labelAttributes = array()

$parentWidget

the parent widget.

protected ParentWidgetInterface $parentWidget

$valuesSeparator

protected mixed $valuesSeparator = ' '

Methods

__construct()

public __construct(mixed $args) : mixed
Parameters
$args : mixed
Return values
mixed

getId()

Get the control id.

public getId() : mixed
Return values
mixed

getName()

Get the control name.

public getName() : mixed
Return values
mixed

getValue()

return the value of the HTML element.

public getValue() : mixed
Return values
mixed

outputControl()

displays the form field itself.

public abstract outputControl() : mixed
Return values
mixed

outputControlValue()

displays the value of the form field only.

public outputControlValue() : mixed
Return values
mixed

outputHelp()

This function displays the blue question mark near the form field.

public outputHelp() : mixed
Return values
mixed

outputLabel()

This function displays the form field label.

public outputLabel([mixed $format = '' ][, mixed $editMode = true ]) : mixed
Parameters
$format : mixed = ''
$editMode : mixed = true
Return values
mixed

outputMetaContent()

add the CSS and javascript link.

public outputMetaContent(mixed $resp) : mixed
Parameters
$resp : mixed

The response used

Return values
mixed

setAttributes()

set attributes to add on the HTML element.

public setAttributes(mixed $attr) : mixed
Parameters
$attr : mixed
Return values
mixed

setDefaultAttributes()

public setDefaultAttributes(mixed $attr) : mixed
Parameters
$attr : mixed
Return values
mixed

setLabelAttributes()

public setLabelAttributes(mixed $attributes) : mixed
Parameters
$attributes : mixed
Return values
mixed

_outputAttr()

protected _outputAttr(mixed &$attributes) : mixed
Parameters
$attributes : mixed
Return values
mixed

commonGetJsConstraints()

protected commonGetJsConstraints() : mixed
Return values
mixed

commonJs()

protected commonJs() : mixed
Return values
mixed

escJsStr()

protected escJsStr(mixed $str) : mixed
Parameters
$str : mixed
Return values
mixed

fillSelect()

protected fillSelect(mixed $ctrl, mixed $value) : mixed
Parameters
$ctrl : mixed
$value : mixed
Return values
mixed

getControlAttributes()

Returns an array containing all the control attributes.

protected getControlAttributes() : mixed
Return values
mixed

getCSSClass()

Get the control class.

protected getCSSClass() : mixed
Return values
mixed

getLabelAttributes()

Retrieve the label attributes.

protected getLabelAttributes(mixed $editMode) : mixed
Parameters
$editMode : mixed
Return values
mixed

getValueAttributes()

protected getValueAttributes() : mixed
Return values
mixed

outputLabelAsFormLabel()

protected outputLabelAsFormLabel(mixed $label, mixed $attr) : mixed
Parameters
$label : mixed
$attr : mixed
Return values
mixed

outputLabelAsTitle()

protected outputLabelAsTitle(mixed $label, mixed $attr) : mixed
Parameters
$label : mixed
$attr : mixed
Return values
mixed

Search results