Class Image

Responsibility: init, pre-dispatch and render submit button based on <input> HTML element with type image.

MvcCore\Ext\Forms\Field implements MvcCore\Ext\Forms\IField uses MvcCore\Ext\Forms\Field\Props, MvcCore\Ext\Forms\Field\Getters, MvcCore\Ext\Forms\Field\Setters, MvcCore\Ext\Forms\Field\Rendering

Extended by

MvcCore\Ext\Forms\Fields\Image implements MvcCore\Ext\Forms\Fields\IVisibleField, MvcCore\Ext\Forms\Fields\ISubmit uses MvcCore\Ext\Forms\Field\Props\VisibleField, MvcCore\Ext\Forms\Field\Props\Submit, MvcCore\Ext\Forms\Field\Props\FormAttrs, MvcCore\Ext\Forms\Field\Props\WidthHeight

Namespace: MvcCore\Ext\Forms\Fields
Located at ext-form-field-button/src/MvcCore/Ext/Forms/Fields/Image.php

Methods summary
`public string\|null`	# `GetSrc( )` Get displayed image as button background, relative or absolute path. Get displayed image as button background, relative or absolute path. Returns string\|null See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-src
`public MvcCore\Ext\Forms\Field`	# `SetSrc( string $src )` Set displayed image as button background, relative or absolute path. Set displayed image as button background, relative or absolute path. Parameters `$src` Returns `MvcCore\Ext\Forms\Field` See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-src Requires
`public string\|null`	# `GetAlt( )` Get alternative button text for `alt` attribute. Get alternative button text for `alt` attribute. Returns string\|null See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-alt
`public MvcCore\Ext\Forms\Field`	# `SetAlt( string $alt )` Set alternative button text for `alt` attribute. Set alternative button text for `alt` attribute. Parameters `$alt` Returns `MvcCore\Ext\Forms\Field` See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-alt
`public MvcCore\Ext\Forms\Fields\Image`	# `__construct( array $cfg = [] )` Create new form `<input type="image" />` control instance. Create new form `<input type="image" />` control instance. Parameters `$cfg` Config array with public properties and it's values which you want to configure, presented in camel case properties names syntax. Returns `MvcCore\Ext\Forms\Fields\Image` Throws InvalidArgumentException Overrides `MvcCore\Ext\Forms\Field::__construct()`
`public MvcCore\Ext\Forms\Fields\Image`	# `SetForm( MvcCore\Ext\IForm $form )` This INTERNAL method is called from `\MvcCore\Ext\Form` after field is added into form instance by `$form->AddField();` method. Do not use this method even if you don't develop any form field. - Check if field has any name, which is required. - Set up form and field id attribute by form id and field name. - Set up required. - Set up translate boolean property. - Check if there is defined any value for `src` attribute. This INTERNAL method is called from `\MvcCore\Ext\Form` after field is added into form instance by `$form->AddField();` method. Do not use this method even if you don't develop any form field. - Check if field has any name, which is required. - Set up form and field id attribute by form id and field name. - Set up required. - Set up translate boolean property. - Check if there is defined any value for `src` attribute. Parameters `$form` Returns `MvcCore\Ext\Forms\Fields\Image` Throws InvalidArgumentException Overrides `MvcCore\Ext\Forms\Field::SetForm()`
`public`	# `PreDispatch( )` This INTERNAL method is called from `\MvcCore\Ext\Form` just before field is naturally rendered. It sets up field for rendering process. Do not use this method even if you don't develop any form field. - Set up field render mode if not defined. - Translate label text if necessary. - Set up tab-index if necessary. - Translate `alt` attribute text if necessary. This INTERNAL method is called from `\MvcCore\Ext\Form` just before field is naturally rendered. It sets up field for rendering process. Do not use this method even if you don't develop any form field. - Set up field render mode if not defined. - Translate label text if necessary. - Set up tab-index if necessary. - Translate `alt` attribute text if necessary. Overrides `MvcCore\Ext\Forms\Field::PreDispatch()`
`public string`	# `RenderControl( )` This INTERNAL method is called from `\MvcCore\Ext\Forms\Field\Rendering` in rendering process. Do not use this method even if you don't develop any form field. This INTERNAL method is called from `\MvcCore\Ext\Forms\Field\Rendering` in rendering process. Do not use this method even if you don't develop any form field. Render control tag only without label or specific errors, including all select `<option>` tags or `<optgroup>` tags if there are options configured for. Returns string Overrides `MvcCore\Ext\Forms\Field\Rendering::RenderControl()`

Methods inherited from MvcCore\Ext\Forms\Field
`AddValidationError(), CreateInstance(), GetValidatorData(), Submit(), __call(), __get(), __set(), throwNewInvalidArgumentException(), translateAndFormatValidationError()`

Methods inherited from MvcCore\Ext\Forms\IField
AddControlAttrs(), AddCssClasses(), AddError(), AddValidators(), GetControlAttr(), GetControlAttrs(), GetCssClasses(), GetCssSupportingFile(), GetId(), GetJsClassName(), GetJsSupportingFile(), GetName(), GetTemplates(), GetTitle(), GetType(), GetValidators(), GetValue(), GetViewScript(), HasValidator(), RemoveValidator(), Render(), RenderControlInsideLabel(), RenderErrors(), RenderLabel(), RenderLabelAndControl(), RenderNaturally(), RenderTemplate(), SetControlAttr(), SetControlAttrs(), SetCssClasses(), SetCssSupportingFile(), SetId(), SetJsClassName(), SetJsSupportingFile(), SetName(), SetTemplate(), SetTemplates(), SetTitle(), SetTranslate(), SetType(), SetValidators(), SetValue(), SetViewScript()

Methods inherited from MvcCore\Ext\Forms\Fields\IVisibleField
`GetAccessKey(), GetAutoFocus(), GetDisabled(), GetReadOnly(), GetRequired(), GetTabIndex(), SetAccessKey(), SetAutoFocus(), SetDisabled(), SetReadOnly(), SetRequired(), SetTabIndex()`

Methods inherited from MvcCore\Ext\Forms\Fields\ISubmit
`GetCustomResultState(), SetCustomResultState()`

Methods used from MvcCore\Ext\Forms\Field\Props\Submit
`GetCustomResultState(), SetCustomResultState()`

Methods used from MvcCore\Ext\Forms\Field\Props\FormAttrs
`GetFormAction(), GetFormEnctype(), GetFormMethod(), GetFormNoValidate(), GetFormTarget(), SetFormAction(), SetFormEnctype(), SetFormMethod(), SetFormNoValidate(), SetFormTarget()`

Methods used from MvcCore\Ext\Forms\Field\Props\WidthHeight
`GetHeight(), GetWidth(), SetHeight(), SetWidth()`

Methods used from MvcCore\Ext\Forms\Field\Getters
`GetControlAttr(), GetControlAttrs(), GetCssClasses(), GetCssSupportingFile(), GetId(), GetJsClassName(), GetJsSupportingFile(), GetName(), GetTemplates(), GetTitle(), GetTranslate(), GetType(), GetValidators(), GetValue(), GetViewScript(), HasValidator()`

Methods used from MvcCore\Ext\Forms\Field\Setters
`AddControlAttrs(), AddCssClasses(), AddError(), AddValidators(), RemoveValidator(), SetControlAttr(), SetControlAttrs(), SetCssClasses(), SetCssSupportingFile(), SetId(), SetJsClassName(), SetJsSupportingFile(), SetName(), SetTemplate(), SetTemplates(), SetTitle(), SetTranslate(), SetType(), SetValidators(), SetValue(), SetViewScript()`

Methods used from MvcCore\Ext\Forms\Field\Rendering
`Render(), RenderControlInsideLabel(), RenderErrors(), RenderLabel(), RenderLabelAndControl(), RenderNaturally(), RenderTemplate(), renderAttrsWithFieldVars(), renderControlAttrsWithFieldVars(), renderLabelAttrsWithFieldVars()`

Constants inherited from MvcCore\Ext\Forms\IField
`AUTOFOCUS_DUPLICITY_EXCEPTION, AUTOFOCUS_DUPLICITY_QUIETLY_SET_NEW, AUTOFOCUS_DUPLICITY_UNSET_OLD_SET_NEW, LABEL_SIDE_LEFT, LABEL_SIDE_RIGHT`

Properties summary
`protected string`	`$type` Possible values: `image` (this type has for all browsers the same behaviour as type `submit`). Possible values: `image` (this type has for all browsers the same behaviour as type `submit`).	# `'image'`
`protected string\|null`	`$src` Displayed image as button background, relative or absolute path. Displayed image as button background, relative or absolute path. See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#attr-src Requires	# `NULL`
`protected string`	`$alt` Alternative button text in `alt` attribute, default value is: `Submit`. Alternative button text in `alt` attribute, default value is: `Submit`.	# `'Submit'`
`protected static string`	`$templates` Standard field control natural template string. Standard field control natural template string.	# `[ 'control' => '<input type="image" id="{id}" name="{name}" src="{src}"{attrs} />', ]`

Properties used from MvcCore\Ext\Forms\Field\Props
`$controlAttrs, $cssClasses, $cssSupportingFile, $declaredProtectedProperties, $errors, $form, $id, $jsClassName, $jsSupportingFile, $name, $title, $translate, $translateTitle, $validators, $value, $view, $viewScript`

Properties used from MvcCore\Ext\Forms\Field\Props\Submit
`$customResultState`

Properties used from MvcCore\Ext\Forms\Field\Props\FormAttrs
`$formAction, $formEnctype, $formMethod, $formNoValidate, $formTarget`

Properties used from MvcCore\Ext\Forms\Field\Props\WidthHeight
`$height, $width`