API Docs for: 1.8.0
Show:

photonui.Window Class

Extends photonui.BaseWindow
Defined in: src/container/window.js:46
Module: Container
Parent Module: PhotonUI

Window.

wEvents:

  • close-button-clicked:
    • description: called when the close button was clicked.
    • callback: function(widget)

Constructor

photonui.Window

()

Defined in src/container/window.js:46

Methods

__internalDragging

(
  • offsetX
  • offsetY
  • pageX
  • pageY
)
private

Defined in src/container/window.js:372

Move the window.

Parameters:

__onContextMenu

(
  • event
)
private

Inherited from photonui.Widget: src/widget.js:445

Called when the context menu should be displayed.

Parameters:

__onLocaleChanged

() private

Inherited from photonui.Widget but overwritten in src/container/window.js:477

Called when the locale is changed.

_bindEvent

(
  • id
  • element
  • evName
  • callback
  • [options]
)
private

Inherited from photonui.Base: src/base.js:229

Javascript event binding (for internal use).

Parameters:

  • id String
    An unique id for the event.
  • element DOMElement
    The element on which the event will be bind.
  • evName String
    The event name (e.g. "mousemove", "click",...).
  • callback Function
    The function that will be called when the event occured.
  • [options] Object optional
    options for addEventListener

_buildHtml

() private

Inherited from photonui.Widget but overwritten in src/container/window.js:273

Build the widget HTML.

_callCallbacks

(
  • wEvent
  • params
)
private

Inherited from photonui.Base: src/base.js:292

Call all callbacks for the given wEvent. NOTE: the first argument passed to the callback is the current widget. NOTE²: if the thisArg of the callback is null, this will be binded to the current widget.

Parameters:

  • wEvent String
    The widget event.
  • params Array
    Parametters that will be sent to the callbacks.

_closeButtonClicked

(
  • event
)
private

Defined in src/container/window.js:466

Close button clicked.

Parameters:

_moveDragEnd

(
  • event
)
private

Defined in src/container/window.js:359

Stop moving the window.

Parameters:

_moveDragging

(
  • offsetX
  • offsetY
  • event
)
private

Defined in src/container/window.js:346

Move the window.

Parameters:

_moveDragStart

(
  • event
)
private

Defined in src/container/window.js:328

Start moving the window.

Parameters:

_moveTouchEnd

(
  • event
)
private

Defined in src/container/window.js:429

Stop moving the window.

Parameters:

_moveTouchEnd

(
  • event
)
private

Defined in src/container/window.js:443

Gets the first touch event and normalizes pageX/Y and offsetX/Y properties.

Parameters:

_moveTouchMove

(
  • offsetX
  • offsetY
  • event
)
private

Defined in src/container/window.js:415

Move the window.

Parameters:

_moveTouchStart

(
  • event
)
private

Defined in src/container/window.js:392

Start moving the window.

Parameters:

_registerWEvents

(
  • wEvents
)
private

Inherited from photonui.Base: src/base.js:276

Register available wEvent.

Parameters:

_unbindEvent

(
  • id
)
private

Inherited from photonui.Base: src/base.js:257

Unbind javascript event.

Parameters:

  • id String
    The id of the event.

_updateProperties

(
  • properties
)
deprecated private

Inherited from photonui.Base: src/base.js:209

Force the update of the given properties. This method is deprecated. One should use '@photonui-update' abitbol's annotation on concerned properties.

Parameters:

  • properties Array
    The properties to update.

_updateWindowList

() private

Defined in src/container/window.js:303

Update all the windows.

_visibilityChanged

(
  • visibility
)
private

Inherited from photonui.Widget but overwritten in src/container/container.js:208

Called when the visibility changes.

Parameters:

  • visibility Boolean

    Current visibility state (otptional, defaut=this.visible)

addClass

(
  • className
)

Inherited from photonui.Widget: src/widget.js:378

Add a class to the outer HTML element of the widget.

Parameters:

  • className String
    The class to add.

center

()

Inherited from photonui.BaseWindow: src/container/basewindow.js:340

Center the window.

destroy

()

Inherited from photonui.Base but overwritten in src/container/window.js:257

Destroy the widget.

hide

()

Inherited from photonui.Widget: src/widget.js:345

Hide the widget (equivalent to widget.visible = false).

moveToBack

()

Defined in src/container/window.js:243

Bring the window to the back.

moveToFront

()

Defined in src/container/window.js:229

Bring the window to front.

registerCallback

(
  • id
  • wEvent
  • callback
  • thisArg
)

Inherited from photonui.Base: src/base.js:169

Register a callback for any PhotonUI/Widget event (called wEvent). Callback signature: function (Object(Base/Widget) [, arg1 [, arg2 [, ...]]])

Parameters:

  • id String
    An unique id for the callback.
  • wEvent String
    the PhotonUI/Widget event name.
  • callback Function
    The callback function.
  • thisArg Object
    The value of this (optionnal, default = current widget).

removeCallback

(
  • id
)

Inherited from photonui.Base: src/base.js:193

Remove a registered callback.

Parameters:

  • id String
    The id of the callback.

removeChild

(
  • widget
)

Inherited from photonui.Container: src/container/container.js:182

Remove the given child.

Parameters:

removeClass

(
  • className
)

Inherited from photonui.Widget: src/widget.js:395

Remove a class from the outer HTML element of the widget.

Parameters:

  • className String
    The class to remove.

show

()

Inherited from photonui.Widget: src/widget.js:336

Display the widget (equivalent to widget.visible = true).

unparent

()

Inherited from photonui.Widget: src/widget.js:354

Detache the widget from its parent.

Properties

__callbacks

Object private

Inherited from photonui.Base: src/base.js:142

Object containing references to registered callbacks.

__events

Object private

Inherited from photonui.Base: src/base.js:132

Object containing references javascript events binding (for widget internal use).

__html

Object private

Inherited from photonui.Widget: src/widget.js:321

Object containing references to the widget HTML elements

absolutePosition

Object

Inherited from photonui.Widget: src/widget.js:275

Absolute position of the widget on the page. {x: Number, y: Number}

child

photonui.Widget

Inherited from photonui.Container: src/container/container.js:146

The child widget.

Default: null (no child)

childName

String

Inherited from photonui.Container: src/container/container.js:118

The child widget name.

Default: null (no child)

closeButtonVisible

Boolean default: true

Defined in src/container/window.js:144

Determine if the close button in the title bar is displayed or not.

containerNode

HTMLElement

Inherited from photonui.Container but overwritten in src/container/window.js:197

HTML Element that contain the child widget HTML.

contextMenu

photonui.PopupWindow

Inherited from photonui.Widget: src/widget.js:223

The managed contextual menu.

Default: null (= no context menu)

contextMenuName

String

Inherited from photonui.Widget: src/widget.js:206

The name of the managed contextual menu (photonui.PopupWindow().name).

Default: null (= no context menu)

data

Object

Inherited from photonui.Base: src/base.js:113

Arbitrary data

Default: {}

fullscreen

Boolean

Defined in src/container/window.js:122

Fullscreen Window

Default: false

height

Number

Inherited from photonui.BaseWindow: src/container/basewindow.js:174

Height of the container node.

Default: : null (auto)

horizontalChildExpansion

Boolean

Inherited from photonui.Container: src/container/container.js:66

Horizontaly expand the container's child widget.

Default: true

html

HTMLElement

Inherited from photonui.Widget but overwritten in src/container/basewindow.js:311

Html outer element of the widget (if any).

Default: null

layoutOptions

Object

Inherited from photonui.Widget: src/widget.js:243

Layout options.

Default: {}

maxHeight

Number

Inherited from photonui.BaseWindow: src/container/basewindow.js:269

Maximum height of the container node.

Default: : null (no maximum)

maxWidth

Number

Inherited from photonui.BaseWindow: src/container/basewindow.js:246

Maximum width of the container node.

Default: : null (no maximum)

minHeight

Number

Inherited from photonui.BaseWindow: src/container/basewindow.js:223

Minimum height of the container node.

Default: : null (no minimum)

minWidth

Number

Inherited from photonui.BaseWindow: src/container/basewindow.js:200

Minimum width of the container node.

Default: : null (no minimum)

modal

Boolean

Defined in src/container/window.js:170

Modal window?

Default: false

movable

Boolean

Defined in src/container/window.js:105

Determine if the window can be moved (drag & drop) by the user.

Default: true

name

String

Inherited from photonui.Widget: src/widget.js:109

The unique name of the widget.

Default: "widget-" + uuid.v4()

offsetHeight

Number

Inherited from photonui.Widget: src/widget.js:305

Widget height (outer HTML element).

offsetWidth

Number

Inherited from photonui.Widget: src/widget.js:291

Widget width (outer HTML element).

padding

Number

Inherited from photonui.BaseWindow: src/container/basewindow.js:292

Window container node padding.

Default: 0

parent

photonui.Widget

Inherited from photonui.Widget: src/widget.js:145

The parent widget.

Default: null (no parent)

parentName

String

Inherited from photonui.Widget: src/widget.js:131

The parent widget name.

Default: null (no parent)

position

Object

Inherited from photonui.BaseWindow: src/container/basewindow.js:78

Window position.

{x: Number, y: Number}

Default: {x: 0, y: 0}

title

String

Defined in src/container/window.js:85

The window title.

Default: "Window"

tooltip

String

Inherited from photonui.Widget: src/widget.js:184

Tooltip.

Default: null

verticalChildExpansion

Boolean

Inherited from photonui.Container: src/container/container.js:92

Verticaly expand the container's child widget.

Default: false

visible

Boolean

Inherited from photonui.Widget: src/widget.js:157

Is the widget visible or hidden.

Default: true

width

Number

Inherited from photonui.BaseWindow: src/container/basewindow.js:148

Width of the container node.

Default: : null (auto)

x

Number

Inherited from photonui.BaseWindow: src/container/basewindow.js:114

The X position of the Window.

Default: 0

y

Number

Inherited from photonui.BaseWindow: src/container/basewindow.js:131

The Y position of the Window.

Default: 0