Responsibility: define getters and setters for properties/attributes: accessKey, autoFocus, disabled, readOnly, required and tabIndex.
Interface for all field classes:
- \MvcCore\Ext\Forms\Field - \MvcCore\Ext\Forms\Field\Rendering
- \MvcCore\Ext\Forms\Fields\Button - \MvcCore\Ext\Forms\Fields\SubmitButton - \MvcCore\Ext\Forms\Fields\ResetButton
- \MvcCore\Ext\Forms\Fields\Color
- \MvcCore\Ext\Forms\Fields\Date - \MvcCore\Ext\Forms\Fields\DateTime - \MvcCore\Ext\Forms\Fields\Month - \MvcCore\Ext\Forms\Fields\Time - \MvcCore\Ext\Forms\Fields\Week
- \MvcCore\Ext\Forms\Fields\File
- \MvcCore\Ext\Forms\Fields\Checkbox
- \MvcCore\Ext\Forms\Fields\Image
- \MvcCore\Ext\Forms\Fields\Number - \MvcCore\Ext\Forms\Fields\Range
- \MvcCore\Ext\Forms\Fields\ResetInput
- \MvcCore\Ext\Forms\Fields\Select - \MvcCore\Ext\Forms\Fields\CountrySelect
- \MvcCore\Ext\Forms\Fields\SubmitInput
- \MvcCore\Ext\Forms\Fields\Text - \MvcCore\Ext\Forms\Fields\Email - \MvcCore\Ext\Forms\Fields\Password - \MvcCore\Ext\Forms\Fields\Search - \MvcCore\Ext\Forms\Fields\Tel - \MvcCore\Ext\Forms\Fields\Url
- \MvcCore\Ext\Forms\Fields\Textarea
- \MvcCore\Ext\Forms\FieldsGroup - \MvcCore\Ext\Forms\CheckboxGroup - \MvcCore\Ext\Forms\RadioGroup
Methods summary
public
string|null
|
#
GetAccessKey( )
Returns
string|null
See
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/accesskey
|
public
MvcCore\Ext\Forms\Field
|
#
SetAccessKey( string $accessKey )
Parameters
Returns
See
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/accesskey
|
public
boolean|null
|
#
GetAutoFocus( )
This Boolean attribute lets you specify that a form control should have input
focus when the page loads. Only one form-associated element in a document can
have this attribute specified.
This Boolean attribute lets you specify that a form control should have input
focus when the page loads. Only one form-associated element in a document can
have this attribute specified.
Returns
boolean|null
See
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-autofocus
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select#attr-autofocus
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea#attr-autofocus
|
public
MvcCore\Ext\Forms\Field
|
#
SetAutoFocus( boolean|null $autoFocus = TRUE, integer $duplicateBehaviour = \MvcCore\Ext\Forms\IField::AUTOFOCUS_DUPLICITY_EXCEPTION )
This Boolean attribute lets you specify that a form control should have input
focus when the page loads. Only one form-associated element in a document can
have this attribute specified. If there is already defined any previously configured
autofocused form field, you can use second argument $duplicateBehaviour to solve the problem.
Second argument possible values:
- 0 (\MvcCore\Ext\Forms\IField::AUTOFOCUS_DUPLICITY_EXCEPTION)
Default value, an exception is thrown when there is already defined other autofocused form element.
- 1 (\MvcCore\Ext\Forms\IField::AUTOFOCUS_DUPLICITY_UNSET_OLD_SET_NEW)
There will be removed previously defined autofocused element and configured new given one.
- -1 (\MvcCore\Ext\Forms\IField::AUTOFOCUS_DUPLICITY_QUIETLY_SET_NEW)
There will be quietly configured another field autofocused. Be careful!!! This is not standard behaviour!
This Boolean attribute lets you specify that a form control should have input
focus when the page loads. Only one form-associated element in a document can
have this attribute specified. If there is already defined any previously configured
autofocused form field, you can use second argument $duplicateBehaviour to solve the problem.
Second argument possible values:
- 0 (\MvcCore\Ext\Forms\IField::AUTOFOCUS_DUPLICITY_EXCEPTION) Default value, an exception is thrown when there is already defined other autofocused form element.
- 1 (\MvcCore\Ext\Forms\IField::AUTOFOCUS_DUPLICITY_UNSET_OLD_SET_NEW) There will be removed previously defined autofocused element and configured new given one.
- -1 (\MvcCore\Ext\Forms\IField::AUTOFOCUS_DUPLICITY_QUIETLY_SET_NEW) There will be quietly configured another field autofocused. Be careful!!! This is not standard behaviour!
Parameters
- $autoFocus
- $duplicateBehaviour
Returns
See
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-autofocus
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select#attr-autofocus
https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea#attr-autofocus
|
public
boolean|null
|
#
GetDisabled( )
Get form field attribute disabled, determination if field value will be
possible to change by user and if user will be graphically informed about it
by default browser behaviour or not. Default value is FALSE.
This flag is also used for sure for submit checking. But if any field is
marked as disabled, browsers always don't send any value under this field name
in submit. If field is configured as disabled, no value sent under field name
from user will be accepted in submit process and value for this field will
be used by server side form initialization.
Disabled attribute has more power than required. If disabled is true and
required is true and if there is no or invalid submitted value, there is no
required error and it's used value from server side assigned by
$form->SetValues(); or from session.
Get form field attribute disabled, determination if field value will be
possible to change by user and if user will be graphically informed about it
by default browser behaviour or not. Default value is FALSE.
This flag is also used for sure for submit checking. But if any field is
marked as disabled, browsers always don't send any value under this field name
in submit. If field is configured as disabled, no value sent under field name
from user will be accepted in submit process and value for this field will
be used by server side form initialization.
Disabled attribute has more power than required. If disabled is true and
required is true and if there is no or invalid submitted value, there is no
required error and it's used value from server side assigned by
$form->SetValues(); or from session.
Returns
boolean|null
|
public
MvcCore\Ext\Forms\Field
|
#
SetDisabled( boolean|null $disabled )
Set form field attribute disabled, determination if field value will be
possible to change by user and if user will be graphically informed about it
by default browser behaviour or not. Default value is FALSE.
This flag is also used for sure for submit checking. But if any field is
marked as disabled, browsers always don't send any value under this field name
in submit. If field is configured as disabled, no value sent under field name
from user will be accepted in submit process and value for this field will
be used by server side form initialization.
Disabled attribute has more power than required. If disabled is true and
required is true and if there is no or invalid submitted value, there is no
required error and it's used value from server side assigned by
$form->SetValues(); or from session.
Set form field attribute disabled, determination if field value will be
possible to change by user and if user will be graphically informed about it
by default browser behaviour or not. Default value is FALSE.
This flag is also used for sure for submit checking. But if any field is
marked as disabled, browsers always don't send any value under this field name
in submit. If field is configured as disabled, no value sent under field name
from user will be accepted in submit process and value for this field will
be used by server side form initialization.
Disabled attribute has more power than required. If disabled is true and
required is true and if there is no or invalid submitted value, there is no
required error and it's used value from server side assigned by
$form->SetValues(); or from session.
Parameters
Returns
|
public
boolean|null
|
#
GetReadOnly( )
Get form field attribute readonly, determination if field value will be
possible to read only or if value will be possible to change by user.
Default value is FALSE. This flag is also used for submit checking.
If any field is marked as read only, browsers always send value in submit.
If field is configured as read only, no value sent under field name
from user will be accepted in submit process and value for this field
will be used by server side form initialization.
Readonly attribute has more power than required. If readonly is true and
required is true and if there is invalid submitted value, there is no required
error and it's used value from server side assigned by
$form->SetValues(); or from session.
Get form field attribute readonly, determination if field value will be
possible to read only or if value will be possible to change by user.
Default value is FALSE. This flag is also used for submit checking.
If any field is marked as read only, browsers always send value in submit.
If field is configured as read only, no value sent under field name
from user will be accepted in submit process and value for this field
will be used by server side form initialization.
Readonly attribute has more power than required. If readonly is true and
required is true and if there is invalid submitted value, there is no required
error and it's used value from server side assigned by
$form->SetValues(); or from session.
Returns
boolean|null
|
public
MvcCore\Ext\Forms\Field
|
#
SetReadOnly( boolean|null $readOnly = TRUE )
Set form field attribute readonly, determination if field value will be
possible to read only or if value will be possible to change by user.
Default value is FALSE. This flag is also used for submit checking.
If any field is marked as read only, browsers always send value in submit.
If field is configured as read only, no value sent under field name
from user will be accepted in submit process and value for this field
will be used by server side form initialization.
Readonly attribute has more power than required. If readonly is true and
required is true and if there is invalid submitted value, there is no required
error and it's used value from server side assigned by
$form->SetValues(); or from session.
Set form field attribute readonly, determination if field value will be
possible to read only or if value will be possible to change by user.
Default value is FALSE. This flag is also used for submit checking.
If any field is marked as read only, browsers always send value in submit.
If field is configured as read only, no value sent under field name
from user will be accepted in submit process and value for this field
will be used by server side form initialization.
Readonly attribute has more power than required. If readonly is true and
required is true and if there is invalid submitted value, there is no required
error and it's used value from server side assigned by
$form->SetValues(); or from session.
Parameters
Returns
|
public
boolean|null
|
#
GetRequired( )
Get form field attribute required, determination
if field will be required to complete any value by user.
This flag is also used for submit checking. Default value is NULL
to not require any field value. If form has configured it's property
$form->GetDefaultRequired() to TRUE and this value is NULL, field
will be automatically considered as required by default form configuration.
But this method return only value stored inside this field instance.
Get form field attribute required, determination
if field will be required to complete any value by user.
This flag is also used for submit checking. Default value is NULL
to not require any field value. If form has configured it's property
$form->GetDefaultRequired() to TRUE and this value is NULL, field
will be automatically considered as required by default form configuration.
But this method return only value stored inside this field instance.
Returns
boolean|null
|
public
MvcCore\Ext\Forms\Field
|
#
SetRequired( boolean|null $required = TRUE )
Set form field attribute required, determination
if field will be required to complete any value by user.
This flag is also used for submit checking. Default value is NULL
to not require any field value. If form has configured it's property
$form->GetDefaultRequired() to TRUE and this value is NULL, field
will be automatically considered required by default form configuration.
Set form field attribute required, determination
if field will be required to complete any value by user.
This flag is also used for submit checking. Default value is NULL
to not require any field value. If form has configured it's property
$form->GetDefaultRequired() to TRUE and this value is NULL, field
will be automatically considered required by default form configuration.
Parameters
Returns
|
public
integer|null
|
#
GetTabIndex( )
Get an integer attribute indicating if the element can take input focus (is focusable),
if it should participate to sequential keyboard navigation, and if so, at what
position. Tab-index for every field in form could be indexed as you wish or it could
be indexed from value 1 and moved to specific higher value by place, where form is
currently rendered by form instance method $form->SetBaseTabIndex() to move tab-index
for each field into final values. Tab-index can takes several values:
- a negative value means that the element should be focusable, but should not be
reachable via sequential keyboard navigation;
- 0 means that the element should be focusable and reachable via sequential
keyboard navigation, but its relative order is defined by the platform convention;
- a positive value means that the element should be focusable and reachable via
sequential keyboard navigation; the order in which the elements are focused is
the increasing value of the tab-index. If several elements share the same tab-index,
their relative order follows their relative positions in the document.
Get an integer attribute indicating if the element can take input focus (is focusable),
if it should participate to sequential keyboard navigation, and if so, at what
position. Tab-index for every field in form could be indexed as you wish or it could
be indexed from value 1 and moved to specific higher value by place, where form is
currently rendered by form instance method $form->SetBaseTabIndex() to move tab-index
for each field into final values. Tab-index can takes several values:
- a negative value means that the element should be focusable, but should not be reachable via sequential keyboard navigation;
- 0 means that the element should be focusable and reachable via sequential keyboard navigation, but its relative order is defined by the platform convention;
- a positive value means that the element should be focusable and reachable via sequential keyboard navigation; the order in which the elements are focused is the increasing value of the tab-index. If several elements share the same tab-index, their relative order follows their relative positions in the document.
Returns
integer|null
See
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#attr-tab-index
|
public
MvcCore\Ext\Forms\Field
|
#
SetTabIndex( integer $tabIndex )
Set an integer attribute indicating if the element can take input focus (is focusable),
if it should participate to sequential keyboard navigation, and if so, at what
position. Tab-index for every field in form could be indexed as you wish or it could
be indexed from value 1 and moved to specific higher value by place, where form is
currently rendered by form instance method $form->SetBaseTabIndex() to move tab-index
for each field into final values. Tab-index can takes several values:
- a negative value means that the element should be focusable, but should not be
reachable via sequential keyboard navigation;
- 0 means that the element should be focusable and reachable via sequential
keyboard navigation, but its relative order is defined by the platform convention;
- a positive value means that the element should be focusable and reachable via
sequential keyboard navigation; the order in which the elements are focused is
the increasing value of the tab-index. If several elements share the same tab-index,
their relative order follows their relative positions in the document.
Set an integer attribute indicating if the element can take input focus (is focusable),
if it should participate to sequential keyboard navigation, and if so, at what
position. Tab-index for every field in form could be indexed as you wish or it could
be indexed from value 1 and moved to specific higher value by place, where form is
currently rendered by form instance method $form->SetBaseTabIndex() to move tab-index
for each field into final values. Tab-index can takes several values:
- a negative value means that the element should be focusable, but should not be reachable via sequential keyboard navigation;
- 0 means that the element should be focusable and reachable via sequential keyboard navigation, but its relative order is defined by the platform convention;
- a positive value means that the element should be focusable and reachable via sequential keyboard navigation; the order in which the elements are focused is the increasing value of the tab-index. If several elements share the same tab-index, their relative order follows their relative positions in the document.
Parameters
Returns
See
https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes#attr-tab-index
|