API Docs for: 1.8.0
Show:

photonui.Viewport Class

Extends photonui.Container
Defined in: src/container/viewport.js:42
Module: Container
Parent Module: PhotonUI

Viewport.

Constructor

photonui.Viewport

()

Defined in src/container/viewport.js:42

Methods

__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/viewport.js:379

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/viewport.js:307

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.

_registerWEvents

(
  • wEvents
)
private

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

Register available wEvent.

Parameters:

_sizingHack

() private

Defined in src/container/viewport.js:333

HACK: set the right height.

_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.

_visibilityChanged

(
  • visibility
)
private

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

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.

destroy

()

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

Destroy the widget.

hide

()

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

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

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)

containerNode

HTMLElement

Inherited from photonui.Container but overwritten in src/container/viewport.js:290

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: {}

height

Number

Defined in src/container/viewport.js:254

Height.

* Number: the size in px
* Infinity: 100% of the parent height
* null: auto

Default: Infinity

horizontalChildExpansion

Boolean

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

Horizontaly expand the container's child widget.

Default: true

horizontalScrollbar

Boolean

Defined in src/container/viewport.js:110

Visibility of the horizontal scrollbar.

  • true: displayed,
  • false: hidden,
  • null: auto.

Default: null

html

HTMLElement

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

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

Defined in src/container/viewport.js:231

Maximum height.

* Number: the size in px
* Infinity: 100% of the parent height
* null: no maximum height

Default: null

maxWidth

Number

Defined in src/container/viewport.js:162

Maximum width.

* Number: the size in px
* Infinity: 100% of the parent width
* null: no maximum width

Default: null

minHeight

Number

Defined in src/container/viewport.js:208

Minimum height.

* Number: the size in px
* Infinity: 100% of the parent height
* null: no minimum height

Default: null

minWidth

Number

Defined in src/container/viewport.js:139

Minimum width.

* Number: the size in px
* Infinity: 100% of the parent width
* null: no minimum width

Default: null

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

Defined in src/container/viewport.js:62

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)

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

verticalScrollbar

Boolean

Defined in src/container/viewport.js:81

Visibility of the vertical scrollbar.

  • true: displayed,
  • false: hidden,
  • null: auto.

Default: null

visible

Boolean

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

Is the widget visible or hidden.

Default: true

width

Number

Defined in src/container/viewport.js:185

Width.

* Number: the size in px
* Infinity: 100% of the parent width
* null: auto

Default: Infinity