\Hazaar\View\Widgets
MaskedInput
Basic button widget.

Tags

Since

1.1

Summary
Methods Properties Constants
val
set
val
No constants
Properties
Inherited
$element
$element
Inherited
$name
$name
Inherited
$script
$script
Methods
__construct()
__construct($name, $value = null)
Initialise a MaskedInput widget

Parameters

$namestring

The name (ID) of the widget to create.

$valuestring

The initial value of the input.

clear()
clear() : \\Hazaar\\Widgets\\MaskedInput
Clears the value.

Tags

Since

1.1

inputValue()
inputValue($value) : \\Hazaar\\Widgets\\MaskedInput
Sets the editable input value without mask characters.

For example: If your mask string is set to ‘(###)###’ and you invoke the inputValue method passing ‘4444’ as parameter, the jqxMaskedInput widget should display ‘(444)4__’.

Tags

Since

1.1

Parameters

$valuestring

The input value to set

Returns

\\Hazaar\\Widgets\\MaskedInput
mask()
mask($value) : \\Hazaar\\Widgets\\MaskedInput
Sets or gets the masked input's mask.

eg. “(##)####-####” would be nice for a phone number.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\MaskedInput
maskedValue()
maskedValue($value) : \\Hazaar\\Widgets\\MaskedInput
Sets the editable input value without mask characters.

For example: If your mask string is set to ‘(###)###’ and you invoke the maskedValue method passing ‘4444’ as parameter, the jqxMaskedInput widget should display ‘(444)___’.

Tags

Since

1.1

Parameters

$valuestring

The masked value to set

Returns

\\Hazaar\\Widgets\\MaskedInput
onChange()
onChange($code) : \\Hazaar\\Widgets\\MaskedInput
This event is triggered when the value is changed and the control's focus is lost.

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\MaskedInput
onTextchanged()
onTextchanged($code) : \\Hazaar\\Widgets\\MaskedInput
This event is triggered when the text is changed.

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\MaskedInput
onValuechanged()
onValuechanged($code) : \\Hazaar\\Widgets\\MaskedInput
This event is triggered when the value is changed.

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

\\Hazaar\\Widgets\\MaskedInput
promptChar()
promptChar($value) : \\Hazaar\\Widgets\\MaskedInput
Sets or gets the prompt char displayed when an editable char is empty.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\MaskedInput
readOnly()
readOnly($value) : \\Hazaar\\Widgets\\MaskedInput
Sets or gets the readOnly state of the input.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

The value to set

Returns

\\Hazaar\\Widgets\\MaskedInput
textAlign()
textAlign($value) : \\Hazaar\\Widgets\\MaskedInput
Sets or gets the text alignment.

Possible Values:

  • ‘right’
  • ‘left’

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\MaskedInput
val()
val() : \\Hazaar\\Widgets\\MaskedInput
Sets or gets the value.

Tags

Since

1.1

value()
value($value) : \\Hazaar\\Widgets\\MaskedInput
Sets or gets the masked input's value.

Tags

Since

1.1

Parameters

$valuestring

The value to set

Returns

\\Hazaar\\Widgets\\MaskedInput
Inherited
method()
method($name) : \Hazaar\View\Widgets\Widget

Call a jqWidgets method using the jqWidgets interface. Methods are called using this interface by specifying the first argument as the method being called and subsequent arguments are the actual arguments for the method call.

Parameters

$namestring

The method to call.

Returns

\Hazaar\View\Widgets\Widget
Inherited
name()
name() : string

Returns the name of the object class. This is used to generate the jqxWidget plugin method name.

Returns

string
Inherited
onClick()
onClick($value) : \Hazaar\View\Widgets\Widget

Adds a click event to a widget

Parameters

$valuemixed

The code as a string or JavaScript object, or array of objects to execute.

Returns

\Hazaar\View\Widgets\Widget
Inherited
render()
render() : string

Execute the render method on a widget

Returns

string

JavaScript code to execute the render method.

Inherited
renderObject()
renderObject() : string

Method to render the widget into HTML.

Returns

string

The widget rendererd as HTML.

Inherited
set()
set($key, $value = null, $type = null) : \Hazaar\View\Widgets\Widget

Sets a parameter that is sent to the DOM object.

This method can be used to set a single parameter, with the $key and $value arguments, or multiple parameters by just using the $key argument which is an array of key/value pairs of parameters that are to be set.

Parameters

$keymixed

The name of the parameter to be set, or an array of key/value pairs listing multiple parameters to be set.

$valuemixed

(Optional) The value of the parameter if only specifying one parameter.

$typestring

(Optional) The data type of the value. If set then this will be set explicitly.

Returns

\Hazaar\View\Widgets\Widget

A reference to the current object.

Inherited
setContent()
setContent($content) : string

Sets or gets the value.

Parameters

$content

No description

Returns

string
Inherited
style()
style($value)

Parameters

$value

No description

Inherited
theme()
theme($value) : \Hazaar\View\Widgets\Widget

Specifies the theme to use when initialising the widget. This is not normally needed as the default theme is set when creating each widget. However you may want to override the theme on a per widget basis and this allows for that.

Keep in mind that the theme file used will have to included manually.

Parameters

$valuestring

The name of the theme.

Returns

\Hazaar\View\Widgets\Widget

A reference to the current object.

Inherited
val()
val($value = null) : string

Sets or gets the value.

Parameters

$valuestring

The value to set

Returns

string
Inherited
width()
width($value) : \Hazaar\View\Widgets\Widget

Specifies the width of the widget in pixels.

Parameters

$valuemixed

The width value. Either an integer or string (with px suffix);

Returns

\Hazaar\View\Widgets\Widget

A reference to the current object.