\Hazaar\View\Widgets
Editor

Window widget class

Tags

Since

1.1

Summary
Methods Properties Constants
set
val
No constants
Properties
Inherited
$element
$element
Inherited
$name
$name
Inherited
$script
$script
Methods
__construct()
__construct($name, $content = null, $params = null)

Editor widget constructor

Tags

Since

2.0.0

Parameters

$namestring

The name of the editor widget.

$contentstring

The initial contents of the editor

$paramsarray

Any additional parameters to set on the DIV container

content()
content($value) : \\Hazaar\\Widget\\Window

Sets or gets window’s content’s html content.

Tags

Since

1.1

Parameters

$valuestring

No description

Returns

\\Hazaar\\Widget\\Window
disabled()
disabled($value) : \\Hazaar\\Widget\\Window

Sets or gets whether the editor is disabled.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

No description

Returns

\\Hazaar\\Widget\\Window
imageBrowser()
imageBrowser($value)

Parameters

$value

No description

onChange()
onChange($code) : \\Hazaar\\Widget\\Window

This event is triggered when the user create new window.

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

\\Hazaar\\Widget\\Window
onExecute()
onExecute($code) : \\Hazaar\\Widget\\Window

This event is triggered when the window is dragging by the user.

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

\\Hazaar\\Widget\\Window
onKeydown()
onKeydown($code) : \\Hazaar\\Widget\\Window

This event is triggered when the window is dropped by the user.

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

\\Hazaar\\Widget\\Window
onKeyup()
onKeyup($code) : \\Hazaar\\Widget\\Window

This event is triggered when the window is displayed.

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

\\Hazaar\\Widget\\Window
onModeChange()
onModeChange($code) : \\Hazaar\\Widget\\Window

This event is triggered when the window is collapsed.

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

\\Hazaar\\Widget\\Window
onSave()
onSave($code) : \\Hazaar\\Widget\\Window

This event is triggered when the window is closed.

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

\\Hazaar\\Widget\\Window
onSelect()
onSelect($code) : \\Hazaar\\Widget\\Window

This event is triggered when the window is expanded.

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

\\Hazaar\\Widget\\Window
save()
save()
tools()
tools($value) : \\Hazaar\\Widget\\Window

Sets the tools that are visible to the user

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

No description

Returns

\\Hazaar\\Widget\\Window
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.