dojox/mobile/app/List.js

• Provides:

  • dojox.mobile.app.List

• Requires:

  • dojo.string in common
  • dijit._WidgetBase in common

• dojox.mobile.app.List

  • type

    Function

  • chains:
    • dijit._WidgetBase: (prototype)
    • dijit._WidgetBase: (call)
  • summary

    A templated list widget. Given a simple array of data objects
    and a HTML template, it renders a list of elements, with
    support for a swipe delete action.  An optional template
    can be provided for when the list is empty.

• dojox.mobile.app.List.items

  • type

    Array

  • summary

    The array of data items that will be rendered.

• dojox.mobile.app.List.itemTemplate

  • type

    String

  • summary

    The URL to the HTML file containing the markup for each individual
    data item.

• dojox.mobile.app.List.emptyTemplate

  • type

    String

  • summary

    The URL to the HTML file containing the HTML to display if there
    are no data items. This is optional.

• dojox.mobile.app.List.dividerTemplate

  • type

    String

  • summary

    The URL to the HTML file containing the markup for the dividers
    between groups of list items

• dojox.mobile.app.List.dividerFunction

  • type

    Function

  • summary

    Function to create divider elements. This should return a divider
    value for each item in the list

• dojox.mobile.app.List.labelDelete

  • type

    String

  • summary

    The label to display for the Delete button

• dojox.mobile.app.List.labelCancel

  • type

    String

  • summary

    The label to display for the Cancel button

• dojox.mobile.app.List.controller

  • type

    Object

• dojox.mobile.app.List.autoDelete

  • type

    Boolean

• dojox.mobile.app.List.enableDelete

  • type

    Boolean

• dojox.mobile.app.List.enableHold

  • type

    Boolean

• dojox.mobile.app.List.formatters

  • type

    Object

  • summary

    A name/value map of functions used to format data for display

• dojox.mobile.app.List._templateLoadCount

  • type

    Number

  • summary

    The number of templates remaining to load before the list renders.

• dojox.mobile.app.List._mouseDownPos

  • type

    Object

  • summary

    The coordinates of where a mouseDown event was detected

• dojox.mobile.app.List.baseClass

  • type

    String

• dojox.mobile.app.List.constructor

  • constructor - constructor
  • type

    Function

• dojox.mobile.app.List.postCreate

  • type

    Function

• dojox.mobile.app.List.handleDrag

  • parameters:
    • event
  • summary

    Handles rows being swiped for deletion.

  • type

    Function

• dojox.mobile.app.List._dragThreshold

  • type

    Object

• dojox.mobile.app.List._selectedRow.style.left

  • type

    Number

• dojox.mobile.app.List.handleDragCancel

  • summary

    Handle a drag action being cancelled, for whatever reason.
    Reset handles, remove CSS classes etc.

  • type

    Function

• dojox.mobile.app.List.preDelete

  • parameters:
    • currentLeftPos
  • summary

    Slides the row offscreen before it is deleted

  • type

    Function

• dojox.mobile.app.List._deleting

  • type

    bool

• dojox.mobile.app.List.deleteRow

  • parameters:
    • row
  • type

    Function

• dojox.mobile.app.List._deleteAnimConn

  • type

    Object

• dojox.mobile.app.List._postDeleteAnim

  • parameters:
    • event
  • summary

    Completes the deletion of a row.

  • type

    Object

• dojox.mobile.app.List._selectedRow

  • type

    Object

• dojox.mobile.app.List._selectedRow.previousSibling

• dojox.mobile.app.List.createDeleteButtons

  • parameters:
    • aroundNode: (typeof The)

      DOM node of the row about to be deleted.

  • summary

    Creates the two buttons displayed when confirmation is
    required before deletion of a row.

  • type

    Function

• dojox.mobile.app.List._deleteBtns

  • type

    Object

• dojox.mobile.app.List.buttons

  • type

    Object

• dojox.mobile.app.List._handleButtonClick

  • parameters:
    • event
  • summary

    Handles the click of one of the deletion buttons, either to
    delete the row or to cancel the deletion.

  • type

    Function

• dojox.mobile.app.List.onDelete

  • parameters:
    • data: (typeof The)

      data related to the row being deleted

    • index: (typeof The)

      index of the data in the total array

    • array: (typeof The)

      array of data used.

  • summary

    Called when a row is deleted

  • type

    Function

• dojox.mobile.app.List.cancelDelete

  • summary

    Cancels the deletion of a row.

  • type

    Function

• dojox.mobile.app.List.applyClass

  • parameters:
    • node
    • idx
    • array
  • summary

    Applies the 'first' and 'last' CSS classes to the relevant
    rows.

  • type

    Function

• dojox.mobile.app.List._setDataInfo

  • parameters:
    • rowNode
    • event
  • summary

    Attaches the data item and index for each row to any event
    that occurs on that row.

  • type

    Function

• dojox.mobile.app.List.onSelect

  • parameters:
    • data
    • index
    • rowNode
  • summary

    Dummy function that is called when a row is tapped

  • type

    Function

• dojox.mobile.app.List._selectRow

  • parameters:
    • row
  • summary

    Selects a row, applies the relevant CSS classes.

  • type

    Function

• dojox.mobile.app.List._deselectRow

  • summary

    Deselects a row, and cancels any drag actions that were
    occurring.

  • type

    Function

• dojox.mobile.app.List._getRowNode

  • parameters:
    • fromNode
    • ignoreNoClick
  • summary

    Gets the DOM node of the row that is equal to or the parent
    of the node passed to this function.

  • type

    Function

• dojox.mobile.app.List.applyTemplate

  • parameters:
    • template
    • data
  • type

    Function

• dojox.mobile.app.List.render

  • summary

    Renders the list.

  • type

    Function

• dojox.mobile.app.List._renderRange

  • parameters:
    • startIdx
    • endIdx
  • type

    Function

• dojox.mobile.app.List._replaceToken

  • parameters:
    • value
    • key
  • returns

    a debugging aide

  • type

    Object

• dojox.mobile.app.List._checkLoadComplete

  • summary

    Checks if all templates have loaded

  • type

    Object

• dojox.mobile.app.List._loadTemplate

  • parameters:
    • url
    • thisAttr
    • callback
  • summary

    Loads a template

  • type

    Function

• dojox.mobile.app.List._setFormattersAttr

  • parameters:
    • formatters
  • summary

    Sets the data items, and causes a rerender of the list

  • type

    Function

• dojox.mobile.app.List._setItemsAttr

  • parameters:
    • items
  • summary

    Sets the data items, and causes a rerender of the list

  • type

    Function

• dojox.mobile.app.List.destroy

  • type

    Function

• dojox.mobile.app

  • type

    Object

• dojox.mobile

  • type

    Object

• dojox

  • type

    Object