\Hazaar\View\Widgets
Window

Window widget class

Tags

Since

1.1

Summary
Methods Properties Constants
No constants
Properties
$buttons
$buttons
$content
$content
$title
$title
Inherited
$name
$name
Inherited
$script
$script
Methods
__construct()
__construct($name, $content = null, $title = null)

Window widget constructor

Tags

Since

1.1

Parameters

$namestring

The unique name of the widget

$contentmixed

Any content to add to the window

$titlemixed

Can be either a string or an array with an image and a string in it.

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

Sets or gets window’s close and show animation type.

Possible Values: * ‘none’ * ‘fade’ * ‘slide’ * ‘combined’

Tags

Since

1.1

Parameters

$valuestring

No description

Returns

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

Sets or gets whether the window will be shown after it’s creation.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

No description

Returns

\\Hazaar\\Widget\\Window
bringToFront()
bringToFront() : string

Bringing the window to the front.

Tags

Since

1.1

Returns

string
cancelButton()
cancelButton($value) : \\Hazaar\\Widget\\Window

Sets or gets cancel button. When a cancel button is specified you can use this button to interact with the user. When any user press the cacel button window is going to be closed and the dialog result will be in the following format: { OK: false, Cancel: true, None: false }.

Tags

Since

1.1

Parameters

$valuemixed

This can be either a button widget to add to the content, or the name of an existing button that is in the content already.

Returns

\\Hazaar\\Widget\\Window
close()
close() : string

Hiding/closing the current window (the action – hide or close depends on the closeButtonAction).

Tags

Since

1.1

Returns

string
closeAll()
closeAll() : string

Closing all open windows which are not modal.

Tags

Since

1.1

Returns

string
closeAnimationDuration()
closeAnimationDuration($value) : \\Hazaar\\Widget\\Window

Sets or gets window’s close animation duration.

Tags

Since

1.1

Parameters

$valueint

No description

Returns

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

This setting specifies what happens when the user clicks the jqxWindow’s close button.

Possible Values:

  • ‘hide’
  • ‘close’-clicking the close button removes the window from the DOM

Tags

Since

1.1

Parameters

$valuestring

No description

Returns

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

Sets or gets window’s close button size.

Tags

Since

1.1

Parameters

$valueint

No description

Returns

\\Hazaar\\Widget\\Window
collapse()
collapse() : string

Collapse the current window.

Tags

Since

1.1

Returns

string
collapseAnimationDuration()
collapseAnimationDuration($value) : \\Hazaar\\Widget\\Window

Determines the duration in milliseconds of the expand/collapse animation.

Tags

Since

1.1

Parameters

$valueint

No description

Returns

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

Determines whether the window is collapsed.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

No description

Returns

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

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

No description

Returns

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

Sets or gets the screen area which is available for dragging(moving) the jqxWindow.

Example value:

  • array(‘left’ => 300, ‘top’ => 300, ‘width’ => 600, ‘height’ => 600)

By default, the dragArea is null which means that the users will be able to drag the window in the document’s body bounds.

Tags

Since

1.1

Parameters

$valuearray

No description

Returns

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

Sets or gets whether the window is draggable.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

No description

Returns

\\Hazaar\\Widget\\Window
enable()
enable() : string

Enabling the window

Tags

Since

1.1

Returns

string
expand()
expand() : string

Expand the current window.

Tags

Since

1.1

Returns

string
initContent()
initContent($value) : \\Hazaar\\Widget\\Window

Initializes the jqxWindow’s content.

Tags

Since

1.1

Parameters

$value

No description

Returns

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

Sets or gets whether the window is displayed as a modal dialog. If the jqxWindow’s mode is set to modal, the window blocks user interaction with the underlying user interface.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

No description

Returns

\\Hazaar\\Widget\\Window
isOpen()
isOpen() : string

Returns true when jqxWindow is opened and false when the jqxWindow is closed.

Tags

Since

1.1

Returns

string
keyboardCloseKey()
keyboardCloseKey($value) : \\Hazaar\\Widget\\Window

Sets or gets the key which could be used for closing the window when it’s on focus. Possible value is every keycode and the ‘esc’ strig (for the escape key).

Tags

Since

1.1

Parameters

$valuemixed

No description

Returns

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

Determines whether the keyboard navigation is enabled or disabled.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

No description

Returns

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

Sets or gets window’s maximum height.

Tags

Since

1.1

Parameters

$valuemixed

No description

Returns

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

Sets or gets window’s maximum width.

Tags

Since

1.1

Parameters

$valuemixed

No description

Returns

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

Sets or gets window’s minimum height.

Tags

Since

1.1

Parameters

$valuemixed

No description

Returns

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

Sets or gets window’s minimum width.

Tags

Since

1.1

Parameters

$valuemixed

No description

Returns

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

Sets or gets the jqxWindow’s background displayed over the underlying user interface when the window is in modal dialog mode.

Tags

Since

1.1

Parameters

$valueint

No description

Returns

\\Hazaar\\Widget\\Window
move()
move($top, $left) : string

Moving the current window.

Tags

Since

1.1

Parameters

$topint

The top position of the window

$leftint

The left position of the window

Returns

string
okButton()
okButton($value) : \\Hazaar\\Widget\\Window

Sets or gets submit button. When a ok/submit button is specified you can use this button to interact with the user. When any user presses the submit button window is going to be closed and the dialog result will be in the following format: { OK: true, Cancel: false, None: false }.

Tags

Since

1.1

Parameters

$valuemixed

This can be either a button widget to add to the content, or the name of an existing button that is in the content already.

Returns

\\Hazaar\\Widget\\Window
onClose()
onClose($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
onCollapse()
onCollapse($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
onCreated()
onCreated($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
onExpand()
onExpand($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
onMoved()
onMoved($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
onMoving()
onMoving($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
onOpen()
onOpen($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
onResized()
onResized($code) : \\Hazaar\\Widget\\Window

This event is triggered when the end-user has resized the window.

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

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

This event is triggered when the end-user is resizing the window.

Tags

Since

1.1

Parameters

$codestring

The JavaScript code to execute when the event is triggered.

Returns

\\Hazaar\\Widget\\Window
open()
open() : string

Opening/showing the current window.

Tags

Since

1.1

Returns

string
position()
position($value) : \\Hazaar\\Widget\\Window

Sets or gets window’s position.

The value could be in the following formats:

  • ‘center’
  • ‘top, left’
  • array(‘x’ => 300, ‘y’ => 500 )
  • array(300, 500)

Tags

Since

1.1

Parameters

$valuemixed

No description

Returns

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

Enables or disables whether the end-user can resize the window.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

No description

Returns

\\Hazaar\\Widget\\Window
resize()
resize($width, $height) : string

Resizes the window. The ‘resizable’ property is expected to be set to “true”.

Tags

Since

1.1

Parameters

$widthint

The new width of the window

$heightint

The new height of the window

Returns

string
setContent()
setContent($content) : string

Setting window’s content.

Tags

Since

1.1

Parameters

$content

No description

Returns

string
setTitle()
setTitle($value) : string

Setting window’s title

Tags

Since

1.1

Parameters

$valuestring

The title to set

Returns

string
showAnimationDuration()
showAnimationDuration($value) : \\Hazaar\\Widget\\Window

Sets or gets window’s show animation duration.

Tags

Since

1.1

Parameters

$valueint

No description

Returns

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

Sets or gets whether a close button will be visible.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

No description

Returns

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

Sets or gets whether the collapse button will be visible.

Tags

Since

1.1

Parameters

$value\Hazaar\View\Widgets\bool

No description

Returns

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

Sets or gets window’s title content.

Tags

Since

1.1

Parameters

$valuestring

No description

Returns

\\Hazaar\\Widget\\Window