dojox/grid/TreeGrid.js

• Provides:

  • dojox.grid.TreeGrid

• Requires:

  • dojox.grid.DataGrid in common
  • dojox.grid._TreeView in common
  • dojox.grid.cells.tree in common
  • dojox.grid.TreeSelection in common

• dojox.grid._TreeAggregator

  • type

    Function

  • parameters:
    • kwArgs

• dojox.grid._TreeAggregator.cells

  • type

    Array

• dojox.grid._TreeAggregator.grid

  • type

    Object

• dojox.grid._TreeAggregator.childFields

  • type

    Array

• dojox.grid._TreeAggregator.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • kwArgs

• dojox.grid._TreeAggregator._cacheValue

  • parameters:
    • cache
    • id
    • value
  • type

    Function

• dojox.grid._TreeAggregator.clearSubtotalCache

  • summary

    Clears the subtotal cache so that we are forced to recalc it
    (or reread it) again.  This is needed, for example, when
    column order is changed.

  • type

    Function

• dojox.grid._TreeAggregator.cnt

  • parameters:
    • cell
    • level
    • item
  • summary

    calculates the count of the children of item at the given level

  • type

    Function

• dojox.grid._TreeAggregator.store

• dojox.grid._TreeAggregator.sum

  • parameters:
    • cell
    • level
    • item
  • summary

    calculates the sum of the children of item at the given level

  • type

    Function

• dojox.grid._TreeAggregator.value

  • parameters:
    • cell
    • level
    • item
  • summary

    Empty function so that we can set "aggregate='value'" to
    force loading from the data - and bypass calculating

  • type

    Function

• dojox.grid._TreeAggregator.getForCell

  • parameters:
    • cell
    • level
    • item
    • type
  • summary

    Gets the value of the given cell at the given level and type.
    type can be one of "sum", "cnt", or "value".  If itemAggregates
    is set and can be used, it is used instead.  Values are also
    cached to prevent calculating them too often.

  • type

    Function

• dojox.grid._TreeAggregator.store._cachedAggregates

  • type

    Object

• dojox.grid._TreeLayout

  • type

    Function

  • chains:
    • dojox.grid._Layout: (prototype)
    • dojox.grid._Layout: (call)

• dojox.grid._TreeLayout._isCollapsable

  • type

    Object

• dojox.grid._TreeLayout._getInternalStructure

  • parameters:
    • inStructure
  • type

    Function

• dojox.grid._TreeLayout.grid

• dojox.grid._TreeLayout.grid.aggregator

  • type

    Object

• dojox.grid._TreeLayout.grid.scroller.defaultRowHeight

  • type

    Number

• dojox.grid._TreeLayout.setStructure

  • parameters:
    • inStructure
  • type

    Function

• dojox.grid._TreeLayout.addCellDef

  • parameters:
    • inRowIndex
    • inCellIndex
    • inDef
  • type

    Function

• dojox.grid.TreePath

  • type

    Function

  • parameters:
    • path: (typeof String|Integer[]|Integer|dojox.grid.TreePath)
    • grid: (typeof dojox.grid.TreeGrid)

• dojox.grid.TreePath.level

  • type

    Number

• dojox.grid.TreePath._str

  • type

    Object

• dojox.grid.TreePath._arr

  • type

    Object

• dojox.grid.TreePath.grid

  • type

    Object

• dojox.grid.TreePath.store

  • type

    Object

• dojox.grid.TreePath.cell

  • type

    Object

• dojox.grid.TreePath.item

  • summary

    gets the dojo.data item associated with this path

  • type

    Function

• dojox.grid.TreePath._item

  • type

    Object

• dojox.grid.TreePath.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • path: (typeof String|Integer[]|Integer|dojox.grid.TreePath)
    • grid: (typeof dojox.grid.TreeGrid)

• dojox.grid.TreePath.compare

  • parameters:
    • path: (typeof dojox.grid.TreePath|String|Array)
  • summary

    compares two paths

  • type

    Function

• dojox.grid.TreePath.isOpen

  • summary

    Returns the open state of this cell.

  • type

    Function

• dojox.grid.TreePath.previous

  • summary

    Returns the path that is before this path in the
    grid. If no path is found, returns null.

  • type

    Function

• dojox.grid.TreePath.next

  • summary

    Returns the next path in the grid.  If no path
    is found, returns null.

  • type

    Function

• dojox.grid.TreePath.children

  • parameters:
    • alwaysReturn
  • summary

    Returns the child data items of this row.  If this
    row isn't open and alwaysReturn is falsey, returns null.

  • type

    Function

• dojox.grid.TreePath.grid.treeModel

• dojox.grid.TreePath.grid.treeModel.store

• dojox.grid.TreePath.childPaths

  • type

    Function

• dojox.grid.TreePath.parent

  • summary

    Returns the parent path of this path.  If this is a
    top-level row, returns null.

  • type

    Function

• dojox.grid.TreePath.lastChild

  • parameters:
    • traverse: (typeof Boolean)
  • summary

    Returns the last child row below this path.  If traverse
    is true, will traverse down to find the last child row
    of this branch.  If there are no children, returns itself.

  • type

    Function

• dojox.grid.TreePath.toString

  • type

    Function

• dojox.grid._TreeFocusManager

  • type

    Function

  • chains:
    • dojox.grid._FocusManager: (prototype)
    • dojox.grid._FocusManager: (call)

• dojox.grid._TreeFocusManager.setFocusCell

  • parameters:
    • inCell
    • inRowIndex
  • type

    Function

• dojox.grid._TreeFocusManager.isLastFocusCell

  • type

    Function

• dojox.grid._TreeFocusManager.next

  • summary

    focus next grid cell

  • type

    Function

• dojox.grid._TreeFocusManager.rowIndex

  • type

    Number

• dojox.grid._TreeFocusManager.cell

• dojox.grid._TreeFocusManager.previous

  • summary

    focus previous grid cell

  • type

    Function

• dojox.grid._TreeFocusManager.move

  • parameters:
    • inRowDelta
    • inColDelta
  • type

    Function

• dojox.grid._TreeFocusManager.grid.scroller

• dojox.grid._TreeFocusManager.cell.index

• dojox.grid.TreeGrid

  • type

    Function

  • chains:
    • dojox.grid.DataGrid: (prototype)
    • dojox.grid.DataGrid: (call)
  • summary

    A grid that supports nesting rows - it provides an expando function
    similar to dijit.Tree.  It also provides mechanisms for aggregating
    the values of subrows

  • description

    TreeGrid currently only works on "simple" structures.  That is,
    single-view structures with a single row in them.
    
    The TreeGrid works using the concept of "levels" - level 0 are the
    top-level items.

• dojox.grid.TreeGrid.defaultOpen

  • type

    Boolean

  • summary

    Whether or not we default to open (all levels).  This defaults to
    false for grids with a treeModel.

• dojox.grid.TreeGrid.sortChildItems

  • type

    Boolean

  • summary

    If true, child items will be returned sorted according to the sorting
    properties of the grid.

• dojox.grid.TreeGrid.openAtLevels

  • type

    Array

  • summary

    Which levels we are open at (overrides defaultOpen for the values
    that exist here).  Its values can be a boolean (true/false) or an
    integer (for the # of children to be closed if there are more than
    that)

• dojox.grid.TreeGrid.treeModel

  • type

    dijit.tree.ForestStoreModel

  • summary

    A dijit.Tree model that will be used instead of using aggregates.
    Setting this value will make the TreeGrid behave like a columnar
    tree.  When setting this value, defaultOpen will default to false,
    and openAtLevels will be ignored.

• dojox.grid.TreeGrid.expandoCell

  • type

    Integer

  • summary

    When used in conjunction with a treeModel (see above), this is a 0-based
    index of the cell in which to place the actual expando

• dojox.grid.TreeGrid.aggregator

  • type

    Object

  • summary

    The aggregator class - it will be populated automatically if we
    are a collapsable grid

• dojox.grid.TreeGrid._layoutClass

  • alias - dojox.grid._TreeLayout

• dojox.grid.TreeGrid.createSelection

  • type

    Function

• dojox.grid.TreeGrid.selection

  • type

    Object

• dojox.grid.TreeGrid._childItemSorter

  • parameters:
    • a
    • b
    • attribute
    • descending
  • type

    Function

• dojox.grid.TreeGrid._onNew

  • parameters:
    • item
    • parentInfo
  • type

    Function

• dojox.grid.TreeGrid._onSet

  • parameters:
    • item
    • attribute
    • oldValue
    • newValue
  • type

    Function

• dojox.grid.TreeGrid._onDelete

  • parameters:
    • item
  • type

    Function

• dojox.grid.TreeGrid._cleanupExpandoCache

  • parameters:
    • index
    • identity
    • item
  • type

    Function

• dojox.grid.TreeGrid._addItem

  • parameters:
    • item
    • index
    • noUpdate
    • dontUpdateRoot
  • type

    Function

• dojox.grid.TreeGrid.getItem

  • parameters:
    • idx: (typeof integer|Array|String)
  • summary

    overridden so that you can pass in a '/' delimited string of indexes to get the
    item based off its path...that is, passing in "1/3/2" will get the
    3rd (0-based) child from the 4th child of the 2nd top-level item.

  • type

    Function

• dojox.grid.TreeGrid.store

• dojox.grid.TreeGrid.treeModel.childrenAttrs

  • type

    Array

• dojox.grid.TreeGrid.treeModel.childrenAttrs.length

• dojox.grid.TreeGrid._getItemIndex

  • parameters:
    • item
    • isDeleted
  • type

    Function

• dojox.grid.TreeGrid.postMixInProperties

  • type

    Function

• dojox.grid.TreeGrid._by_idty_paths

  • type

    Object

• dojox.grid.TreeGrid.postCreate

  • type

    Function

• dojox.grid.TreeGrid.setModel

  • parameters:
    • treeModel
  • type

    Function

• dojox.grid.TreeGrid._setModel

  • parameters:
    • treeModel
  • type

    Function

• dojox.grid.TreeGrid.createScroller

  • type

    Function

• dojox.grid.TreeGrid.scroller._origDefaultRowHeight

• dojox.grid.TreeGrid.createManagers

  • summary

    create grid managers for various tasks including rows, focus, selection, editing

  • type

    Function

• dojox.grid.TreeGrid.rows

  • type

    Object

• dojox.grid.TreeGrid.focus

  • type

    Object

• dojox.grid.TreeGrid.edit

  • type

    Object

• dojox.grid.TreeGrid._setStore

  • parameters:
    • store
  • type

    Function

• dojox.grid.TreeGrid.treeModel.root.children

  • type

    Array

• dojox.grid.TreeGrid.aggregator.store

• dojox.grid.TreeGrid.getDefaultOpenState

  • parameters:
    • cellDef
    • item
  • summary

    Returns the default open state for the given definition and item
    It reads from the openAtLevels and defaultOpen values of the
    grid to calculate if the given item should default to open or
    not.

  • type

    Function

• dojox.grid.TreeGrid.onStyleRow

  • parameters:
    • row
  • type

    Function

• dojox.grid.TreeGrid.styleRowNode

  • parameters:
    • inRowIndex
    • inRowNode
  • type

    Function

• dojox.grid.TreeGrid.onCanSelect

  • parameters:
    • inRowIndex
  • type

    Function

• dojox.grid.TreeGrid.onKeyDown

  • parameters:
    • e
  • type

    Function

• dojox.grid.TreeGrid.canEdit

  • parameters:
    • inCell
    • inRowIndex
  • type

    Function

• dojox.grid.TreeGrid.doApplyCellEdit

  • parameters:
    • inValue
    • inRowIndex
    • inAttrName
  • type

    Function

• dojox.grid.TreeGrid.markupFactory

  • parameters:
    • props
    • node
    • ctor
    • cellFunc
  • type

    Function

• dojo

  • alias - dojo

• dojox.grid

  • type

    Object

• dojox

  • type

    Object