API Docs for: 1.8.0
Show:

photonui.ListView Class

Extends photonui.DataView
Defined in: src/dataview/listview.js:44
Module: DataView
Parent Module: PhotonUI

ListView container.

Constructor

photonui.ListView

()

Defined in src/dataview/listview.js:44

Methods

__onClick

(
  • event
)
private

Inherited from photonui.DataView: src/dataview/dataview.js:861

Called when an element is clicked.

Parameters:

  • event Object

    the click event

__onContextMenu

(
  • event
)
private

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

Called when the context menu should be displayed.

Parameters:

__onDragEnd

(
  • event
)
private

Inherited from photonui.DataView: src/dataview/dataview.js:970

Called when a item drag has ended.

Parameters:

__onDragEnter

(
  • event
)
private

Inherited from photonui.DataView: src/dataview/dataview.js:935

Called when a dragged item enters into another element.

Parameters:

__onDragOver

(
  • event
)
private

Inherited from photonui.DataView: src/dataview/dataview.js:1000

Called when a item is dragged (fix for firefox).

Parameters:

__onDragStart

(
  • event
)
private

Inherited from photonui.DataView: src/dataview/dataview.js:903

Called when an item is dragged.

Parameters:

__onDrop

(
  • event
)
private

Inherited from photonui.DataView: src/dataview/dataview.js:1016

Called when a item is dropped (fix for firefox).

Parameters:

__onItemClick

(
  • event
  • item
)
private

Inherited from photonui.DataView: src/dataview/dataview.js:885

Called when an item is clicked.

Parameters:

  • event Object

    the click event

  • item Item

    the clicked item

__onLocaleChanged

() private

Inherited from photonui.Widget but overwritten in src/dataview/dataview.js:1032

Called when the locale is changed.

_addIdentifiersClasses

(
  • node
  • suffix
)
private

Inherited from photonui.DataView: src/dataview/dataview.js:662

Adds classes defined by the identifiers property to a given element, with a given suffix.

Parameters:

_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

_buildContainerHtml

() private

Inherited from photonui.DataView: src/dataview/dataview.js:505

Build the widget container HTML.

_buildHtml

() private

Inherited from photonui.Widget but overwritten in src/dataview/dataview.js:495

Build the widget HTML.

_buildItemsHtml

() private

Inherited from photonui.DataView: src/dataview/dataview.js:519

Build the items list 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.

_empty

() private

Inherited from photonui.DataView: src/dataview/dataview.js:446

Destroy all children of the layout

_generateColumns

() private

Inherited from photonui.DataView: src/dataview/dataview.js:632

Generate the list of columns.

_generatePlaceholderElement

() Element private

Inherited from photonui.DataView: src/dataview/dataview.js:833

Generates a placeholder item element.

Returns:

Element:

the placeholder item element

_getChildren

() Array private

Inherited from photonui.DataView: src/dataview/dataview.js:462

Layout children widgets.

Returns:

Array:

the childen widget

_getItemByIndex

(
  • index
)
Object private

Inherited from photonui.DataView: src/dataview/dataview.js:481

Returns the item at a given index.

Parameters:

Returns:

Object:

the item

_getItemFromNode

(
  • itemNode
)
Object private

Inherited from photonui.DataView: src/dataview/dataview.js:751

Gets an item of the collection from a given item DOM element.

Parameters:

  • itemNode Element

    the item DOM element

Returns:

Object:

the item

_handleClick

(
  • item
  • modifiers
)
private

Inherited from photonui.DataView: src/dataview/dataview.js:782

Handle item click events.

Parameters:

_moveItem

(
  • itemIndex
  • destinationIndex
)
private

Inherited from photonui.DataView: src/dataview/dataview.js:764

Moves the item at a givent index to another given index. Rebuilds the dataview.

Parameters:

  • itemIndex Number

    the index of the item to move

  • destinationIndex Number

    the destination index

_registerWEvents

(
  • wEvents
)
private

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

Register available wEvent.

Parameters:

_renderColumn

(
  • content
  • columnId
)
Element private

Inherited from photonui.DataView: src/dataview/dataview.js:602

Renders a given column.

Parameters:

Returns:

Element:

the rendered column

_renderItem

(
  • item
)
Element private

Inherited from photonui.DataView: src/dataview/dataview.js:551

Renders a given item.

Parameters:

Returns:

Element:

the rendered item

_renderItemInner

(
  • itemNode
  • item
)
Element private

Inherited from photonui.DataView: src/dataview/dataview.js:579

Renders all the columns of a given item.

Parameters:

  • itemNode Element

    the container element of the item

  • item Object

    the rendered item

Returns:

Element:

the rendered item

_selectItem

(
  • item
)
private

Inherited from photonui.DataView: src/dataview/dataview.js:686

Selects an item.

Parameters:

_selectItemsTo

(
  • item
)
private

Inherited from photonui.DataView: src/dataview/dataview.js:718

Selects all items from the current selection to a given item.

Parameters:

_unbindEvent

(
  • id
)
private

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

Unbind javascript event.

Parameters:

  • id String
    The id of the event.

_unselectItem

(
  • item
)
private

Inherited from photonui.DataView: src/dataview/dataview.js:702

Unselects an item.

Parameters:

_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: src/widget.js:425

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/dataview/dataview.js:388

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.

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.

selectItems

(
  • indexes
)

Inherited from photonui.DataView: src/dataview/dataview.js:398

Selects the item(s) at given indexes.

Parameters:

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.

unselectAllItems

() private

Inherited from photonui.DataView: src/dataview/dataview.js:739

Unselects all items.

unselectItems

(
  • indexes
)

Inherited from photonui.DataView: src/dataview/dataview.js:421

Unselects the item(s) at given indexes.

Parameters:

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}

allowShiftSelect

Boolean

Inherited from photonui.DataView: src/dataview/dataview.js:215

If true, allow selecting multiple items with one click when pressing "shift" key. Only used when "multiSelectable" option is set to "true".

Default: true

columnElement

String

Inherited from photonui.DataView: src/dataview/dataview.js:346

The type of the columns DOM elements which will be created during the render process.

Default: "span"

columns

Array

Inherited from photonui.DataView: src/dataview/dataview.js:277

The list of columns which defines the structure of the items (if not setted manually, the columns are automatically generated).

Default: null

containerElement

String

Inherited from photonui.DataView: src/dataview/dataview.js:314

The type of the container DOM element which will be created during the render process.

Default: "ul"

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)

customWidgetFormater

Function

Inherited from photonui.DataView: src/dataview/dataview.js:247

A custom formater function which overrides the default rendering process of the widget.

Default: null

data

Object

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

Arbitrary data

Default: {}

dragAndDroppable

Boolean

Inherited from photonui.DataView: src/dataview/dataview.js:232

Defines if the data items can be drag & dropped.

Default: false

html

HTMLElement

Inherited from photonui.Widget but overwritten in src/dataview/dataview.js:302

Html outer element of the widget (if any).

Default: null

identifiers

Array private

Inherited from photonui.DataView: src/dataview/dataview.js:362

The list of identifiers wich will be added to every generated elements of the widget as classnames.

Default: []

itemElement

String

Inherited from photonui.DataView: src/dataview/dataview.js:330

The type of the items DOM elements which will be created during the render process.

Default: "li"

items

Array

Inherited from photonui.DataView: src/dataview/dataview.js:115

The collection of items displayed by the data view widget.

Default: null

layoutOptions

Object

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

Layout options.

Default: {}

multiSelectable

Boolean

Inherited from photonui.DataView: src/dataview/dataview.js:183

Defines if the data items can be multi-selected. Only used when "selectable" option is set to "true".

Default: false

multiSelectWithCtrl

Boolean

Inherited from photonui.DataView: src/dataview/dataview.js:199

Defines wether or not "ctrl" key has to be pressed to multi-select items. Only used when "multiSelectable" option is set to "true".

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

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)

selectable

Boolean

Inherited from photonui.DataView: src/dataview/dataview.js:151

Defines if the data items can be selected.

Default: false

selectedItems

Array

Inherited from photonui.DataView: src/dataview/dataview.js:263

The currently selected items.

Default: []

tooltip

String

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

Tooltip.

Default: null

unselectOnOutsideClick

Boolean

Inherited from photonui.DataView: src/dataview/dataview.js:166

If true, clicking outside of the items (in the container) will unselect currently selected items. Only used when "selectable" option is set to "true".

Default: false

visible

Boolean

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

Is the widget visible or hidden.

Default: true