dojox/widget/RollingList.js

• Provides:

  • dojox.widget.RollingList

• Requires:

  • dojo.window in common
  • dijit.layout.ContentPane in common
  • dijit._Templated in common
  • dijit._Contained in common
  • dijit.layout._LayoutWidget in common
  • dijit.Menu in common
  • dijit.form.Button in common
  • dojox.html.metrics in common
  • dojo.i18n in common

• dojox.widget._RollingListPane

  • type

    Function

  • chains:
    • dijit.layout.ContentPane: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Contained.prototype: (prototype)
    • dijit.layout.ContentPane: (call)
    • dijit._Templated: (call)
    • dijit._Contained: (call)
  • summary

    a core pane that can be attached to a RollingList.  All panes
    should extend this one

• dojox.widget._RollingListPane.templateString

  • type

    string

  • summary

    our template

• dojox.widget._RollingListPane.parentWidget

  • type

    dojox.widget.RollingList

  • summary

    Our rolling list widget

• dojox.widget._RollingListPane.parentPane

  • type

    dojox.widget._RollingListPane

  • summary

    The pane that immediately precedes ours

• dojox.widget._RollingListPane.store

  • type

    store

  • summary

    the store we must use

• dojox.widget._RollingListPane.items

  • type

    item[]

  • summary

    an array of (possibly not-yet-loaded) items to display in this.
    If this array is null, then the query and query options are used to
    get the top-level items to use.  This array is also used to watch and
    see if the pane needs to be reloaded (store notifications are handled)
    by the pane

• dojox.widget._RollingListPane.query

  • type

    object

  • summary

    a query to pass to the datastore.  This is only used if items are null

• dojox.widget._RollingListPane.queryOptions

  • type

    object

  • summary

    query options to be passed to the datastore

• dojox.widget._RollingListPane._focusByNode

  • type

    Object

• dojox.widget._RollingListPane.minWidth

  • type

    integer

  • summary

    the width (in px) for this pane

• dojox.widget._RollingListPane._setContentAndScroll

  • parameters:
    • cont: (typeof String|DomNode|Nodelist)
    • isFakeContent: (typeof Boolean)
  • summary

    sets the value of the content and scrolls it into view

  • type

    Function

• dojox.widget._RollingListPane._updateNodeWidth

  • parameters:
    • n
    • min
  • summary

    updates the min width of the pane to be minPaneWidth

  • type

    Function

• dojox.widget._RollingListPane._onMinWidthChange

  • parameters:
    • v
  • type

    Function

• dojox.widget._RollingListPane._setMinWidthAttr

  • parameters:
    • v
  • type

    Function

• dojox.widget._RollingListPane.startup

  • type

    Function

• dojox.widget._RollingListPane._focusKey

  • parameters:
    • e: (typeof Event)
  • summary

    called when a keypress happens on the widget

  • type

    Function

• dojox.widget._RollingListPane.focus

  • parameters:
    • force: (typeof boolean)
  • summary

    sets the focus to this current widget

  • type

    Function

• dojox.widget._RollingListPane.parentWidget._focusedPane

  • type

    Object

• dojox.widget._RollingListPane._onShow

  • summary

    checks that the store is loaded

  • type

    Function

• dojox.widget._RollingListPane._load

  • summary

    sets the "loading" message and then kicks off a query asyncronously

  • type

    Function

• dojox.widget._RollingListPane.isLoaded

  • type

    bool

• dojox.widget._RollingListPane._doLoadItems

  • parameters:
    • items: (typeof item[])
    • callback: (typeof function)
  • summary

    loads the given items, and then calls the callback when they
    are finished.

  • type

    Function

• dojox.widget._RollingListPane._doQuery

  • summary

    either runs the query or loads potentially not-yet-loaded items.

  • type

    Function

• dojox.widget._RollingListPane._hasItem

  • parameters:
    • item: (typeof item)
  • summary

    returns whether or not the given item is handled by this
    pane

  • type

    Function

• dojox.widget._RollingListPane._onSetItem

  • parameters:
    • item: (typeof item)
    • attribute: (typeof attribute-name-string)
    • oldValue: (typeof object)

      | array

    • newValue: (typeof object)

      | array

  • type

    Function

• dojox.widget._RollingListPane._onNewItem

  • parameters:
    • newItem: (typeof item)
    • parentInfo: (typeof object)
  • type

    Function

• dojox.widget._RollingListPane._onDeleteItem

  • parameters:
    • deletedItem: (typeof item)
  • type

    Function

• dojox.widget._RollingListPane.onFetchStart

  • summary

    called before a fetch starts

  • type

    Function

• dojox.widget._RollingListPane.onFetchError

  • parameters:
    • error: (typeof Error)
  • summary

    called when a fetch error occurs.

  • type

    Function

• dojox.widget._RollingListPane.onLoadStart

  • summary

    called before a load starts

  • type

    Function

• dojox.widget._RollingListPane.onLoadError

  • parameters:
    • error: (typeof Error)
  • summary

    called when a load error occurs.

  • type

    Function

• dojox.widget._RollingListPane.onItems

  • summary

    called after a fetch or load - at this point, this.items should be
    set and loaded.  Override this function to "do your stuff"

  • type

    Function

• dojox.widget._RollingListPane.onLoadDeferred

  • type

    Object

• dojox.widget._RollingListGroupPane

  • type

    Function

  • chains:
    • dojox.widget._RollingListPane: (prototype)
    • dojox.widget._RollingListPane: (call)
  • summary

    a pane that will handle groups (treats them as menu items)

• dojox.widget._RollingListGroupPane.templateString

  • type

    string

  • summary

    our template

• dojox.widget._RollingListGroupPane._menu

  • type

    dijit.Menu

  • summary

    The menu that we will call addChild() on for adding items

• dojox.widget._RollingListGroupPane._setContent

  • parameters:
    • cont: (typeof String|DomNode|Nodelist)
  • type

    Function

• dojox.widget._RollingListGroupPane._onMinWidthChange

  • parameters:
    • v
  • type

    Function

• dojox.widget._RollingListGroupPane.onItems

  • summary

    called after a fetch or load

  • type

    Function

• dojox.widget._RollingListGroupPane.containerNode.innerHTML

  • type

    String

• dojox.widget._RollingListGroupPane._checkScrollConnection

  • parameters:
    • doLoad
  • summary

    checks whether or not we need to connect to our onscroll
    function

  • type

    Function

• dojox.widget._RollingListGroupPane.store

• dojox.widget._RollingListGroupPane._scrollConn

  • type

    Object

• dojox.widget._RollingListGroupPane.startup

  • type

    Function

• dojox.widget._RollingListGroupPane.focus

  • parameters:
    • force: (typeof boolean)
  • summary

    sets the focus to this current widget

  • type

    Function

• dojox.widget._RollingListGroupPane._focusByNode

  • type

    Object

• dojox.widget._RollingListGroupPane._pendingFocus

  • type

    Object

• dojox.widget._RollingListGroupPane._getMenu

  • summary

    returns a widget to be used for the container widget.

  • type

    Function

• dojox.widget._RollingListGroupPane._onScrollPane

  • summary

    called when the pane has been scrolled - it sets a timeout
    so that we don't try and load our visible items too often during
    a scroll

  • type

    Function

• dojox.widget._RollingListGroupPane._visibleLoadPending

  • type

    Object

• dojox.widget._RollingListGroupPane._loadVisibleItems

  • summary

    loads the items that are currently visible in the pane

  • type

    Function

• dojox.widget._RollingListGroupPane._getSelected

  • parameters:
    • menu: (typeof dijit.Menu)
  • summary

    returns the selected menu item - or null if none are selected

  • type

    Function

• dojox.widget._RollingListGroupPane._setSelected

  • parameters:
    • item: (typeof dijit.MenuItem)
    • menu: (typeof dijit.Menu)
  • summary

    selectes the given item in the given menu (defaults to pane's menu)

  • type

    Function

• dojox.widget.RollingList

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Container.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
    • dijit._Container: (call)
  • summary

    a rolling list that can be tied to a data store with children

• dojox.widget.RollingList.templateString

  • type

    String

  • summary

    The template to be used to construct the widget.

• dojox.widget.RollingList.widgetsInTemplate

  • type

    Object

• dojox.widget.RollingList.className

  • type

    string

  • summary

    an additional class (or space-separated classes) to add for our widget

• dojox.widget.RollingList.store

  • type

    store

  • summary

    the store we must use

• dojox.widget.RollingList.query

  • type

    object

  • summary

    a query to pass to the datastore.  This is only used if items are null

• dojox.widget.RollingList.queryOptions

  • type

    object

  • summary

    query options to be passed to the datastore

• dojox.widget.RollingList.childrenAttrs

  • type

    String[]

  • summary

    one ore more attributes that holds children of a node

• dojox.widget.RollingList.parentAttr

  • type

    string

  • summary

    the attribute to read for finding our parent item (if any)

• dojox.widget.RollingList.value

  • type

    item

  • summary

    The value that has been selected

• dojox.widget.RollingList.executeOnDblClick

  • type

    boolean

  • summary

    Set to true if you want to call onExecute when an item is
    double-clicked, false if you want to call onExecute yourself. (mainly
    used for popups to control how they want to be handled)

• dojox.widget.RollingList.preloadItems

  • type

    boolean

  • summary

    or int
    if set to true, then onItems will be called only *after* all items have
    been loaded (ie store.isLoaded will return true for all of them).  If
    false, then no preloading will occur.  If set to an integer, preloading
    will occur if the number of items is less than or equal to the value
    of the integer.  The onItems function will need to be aware of handling
    items that may not be loaded

• dojox.widget.RollingList.showButtons

  • type

    boolean

  • summary

    if set to true, then buttons for "OK" and "Cancel" will be provided

• dojox.widget.RollingList.okButtonLabel

  • type

    string

  • summary

    The string to use for the OK button - will use dijit's common "OK" string
    if not set

• dojox.widget.RollingList.cancelButtonLabel

  • type

    string

  • summary

    The string to use for the Cancel button - will use dijit's common
    "Cancel" string if not set

• dojox.widget.RollingList.minPaneWidth

  • type

    integer

  • summary

    the minimum pane width (in px) for all child panes.  If they are narrower,
    the width will be increased to this value.

• dojox.widget.RollingList.postMixInProperties

  • summary

    Mix in our labels, if they are not set

  • type

    Function

• dojox.widget.RollingList._setShowButtonsAttr

  • parameters:
    • doShow
  • summary

    Sets the visibility of the buttons for the widget

  • type

    Function

• dojox.widget.RollingList._itemsMatch

  • parameters:
    • item1: (typeof item)
    • item2: (typeof item)
  • type

    Function

• dojox.widget.RollingList._removeAfter

  • parameters:
    • idx: (typeof Widget)

      or int

  • summary

    removes all widgets after the given widget (or index)

  • type

    Function

• dojox.widget.RollingList.addChild

  • parameters:
    • widget: (typeof dijit._Widget)
    • insertIndex: (typeof int)
  • summary

    adds a child to this rolling list - if passed an insertIndex,
    then all children from that index on will be removed and destroyed
    before adding the child.

  • type

    Function

• dojox.widget.RollingList._setMinPaneWidthAttr

  • parameters:
    • value
  • summary

    Sets the min pane width of all children

  • type

    Function

• dojox.widget.RollingList._updateClass

  • parameters:
    • node: (typeof Node)
    • type: (typeof String)
    • options: (typeof Object)

      an object with key-value-pairs.  The values are boolean, if true,
      the key is added as a class, if false, it is removed.

  • summary

    sets the state of the given node with the given type and options

  • type

    Function

• dojox.widget.RollingList._declaredClasses

  • type

    Object

• dojox.widget.RollingList.scrollIntoView

  • parameters:
    • childWidget: (typeof dijit._Widget)
  • summary

    scrolls the given widget into view

  • type

    Function

• dojox.widget.RollingList._scrollingTimeout

  • type

    Object

• dojox.widget.RollingList.resize

  • parameters:
    • args
  • type

    Function

• dojox.widget.RollingList.layout

  • type

    Function

• dojox.widget.RollingList.buttonsNode

• dojox.widget.RollingList._focusedPane

• dojox.widget.RollingList._onChange

  • parameters:
    • value: (typeof item)
  • type

    Function

• dojox.widget.RollingList._setValue

  • parameters:
    • value: (typeof item)
  • summary

    internally sets the value and fires onchange

  • type

    Function

• dojox.widget.RollingList._setValueAttr

  • parameters:
    • value: (typeof item)
  • summary

    sets the value of this widget to the given store item

  • type

    Function

• dojox.widget.RollingList._setInProgress

• dojox.widget.RollingList.domNode.style

• dojox.widget.RollingList._onItemClick

  • parameters:
    • evt: (typeof Event)
    • pane: (typeof dijit._Contained)
    • item: (typeof item)
    • children: (typeof item[])
  • summary

    internally called when a widget should pop up its child

  • type

    Function

• dojox.widget.RollingList._visibleItem

• dojox.widget.RollingList._getPaneForItem

  • parameters:
    • item: (typeof item)
    • parentPane: (typeof dijit._Contained)
    • children: (typeof item[])
  • summary

    gets the pane for the given item, and mixes in our needed parts
    Returns the pane for the given item (null if the root pane) - after mixing in
    its stuff.

  • type

    Function

• dojox.widget.RollingList._getMenuItemForItem

  • parameters:
    • item: (typeof item)
    • parentPane: (typeof dijit._Contained)
  • summary

    returns a widget for the given store item.  The returned
    item will be added to this widget's container widget.  null will
    be passed in for an "empty" item.

  • type

    Function

• dojox.widget.RollingList._setStore

  • parameters:
    • store: (typeof dojo.data.api.Read)
  • summary

    sets the store for this widget

  • type

    Function

• dojox.widget.RollingList._isIdentity

• dojox.widget.RollingList._onKey

  • parameters:
    • e: (typeof Event)
  • summary

    called when a keypress event happens on this widget

  • type

    Function

• dojox.widget.RollingList._resetValue

  • type

    Function

• dojox.widget.RollingList._onCancel

  • type

    Function

• dojox.widget.RollingList._onExecute

  • type

    Function

• dojox.widget.RollingList._lastExecutedValue

  • type

    Object

• dojox.widget.RollingList.focus

  • summary

    sets the focus state of this widget

  • type

    Function

• dojox.widget.RollingList._savedFocus

  • type

    Object

• dojox.widget.RollingList.handleKey

  • parameters:
    • e: (typeof Event)
  • summary

    handle the key for the given event - called by dropdown
    widgets

  • type

    Function

• dojox.widget.RollingList._updateChildClasses

  • summary

    Called when a child is added or removed - so that we can
    update the classes for styling the "current" one differently than
    the others

  • type

    Function

• dojox.widget.RollingList.startup

  • type

    Function

• dojox.widget.RollingList.getChildItems

  • parameters:
    • item: (typeof item)
  • summary

    Returns the child items for the given store item

  • type

    Function

• dojox.widget.RollingList.getMenuItemForItem

  • parameters:
    • item: (typeof item)
    • parentPane: (typeof dijit._Contained)
    • children: (typeof item[])
  • summary

    user overridable function to return a widget for the given item
    and its children.

  • type

    Function

• dojox.widget.RollingList.getPaneForItem

  • parameters:
    • item: (typeof item)
    • parentPane: (typeof dijit._Contained)
    • children: (typeof item[])
  • summary

    user-overridable function to return a pane that corresponds
    to the given item in the store.  It can return null to not add a new pane
    (ie, you are planning on doing something else with it in onItemClick)
    
    Item is undefined for the root pane, children is undefined for non-group panes

  • type

    Function

• dojox.widget.RollingList.onItemClick

  • parameters:
    • item: (typeof item)
    • pane: (typeof dijit._Contained)
    • children: (typeof item[])
  • summary

    called when an item is clicked - it receives the store item

  • type

    Function

• dojox.widget.RollingList.onExecute

  • summary

    exists so that popups don't disappear too soon

  • type

    Function

• dojox.widget.RollingList.onCancel

  • summary

    exists so that we can close ourselves if we wish

  • type

    Function

• dojox.widget.RollingList.onChange

  • parameters:
    • value: (typeof item)
  • summary

    called when the value of this widget has changed

  • type

    Function

• dojox.widget

  • type

    Object

• dojox

  • type

    Object