dojox/grid/enhanced/plugins/CellMerge.js

• Provides:

  • dojox.grid.enhanced.plugins.CellMerge

• Requires:

  • dojox.grid.enhanced._Plugin in common

• dojox.grid.enhanced.plugins.CellMerge

  • type

    Function

  • chains:
    • dojox.grid.enhanced._Plugin: (prototype)
    • dojox.grid.enhanced._Plugin: (call)
  • parameters:
    • grid
    • args
  • summary

    This plugin provides functions to merge(un-merge) adjacent cells within one row.
    Acceptable plugin paramters:
    1. mergedCells: Array
    An array of objects with structure:
    {
    row: function(Integer)|Integer
    If it's a function, it's a predicate to decide which rows are to be merged.
    It takes an integer (the row index), and should return true or false;
    start: Integer
    The column index of the left most cell that shall be merged.
    end: Integer
    The column index of the right most cell that shall be merged.
    major: Integer
    The column index of the cell whose content should be used as the content of the merged cell.
    It must be larger than or equal to the startColumnIndex, and less than or equal to the endColumnIndex.
    If it is omitted, the content of the leading edge (left-most for ltr, right most for rtl) cell will be used.
    }

• dojox.grid.enhanced.plugins.CellMerge.name

  • type

    String

  • summary

    Plugin name
    
    
    ----------------Public----------------------------

• dojox.grid.enhanced.plugins.CellMerge.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • grid
    • args

• dojox.grid.enhanced.plugins.CellMerge.mergeCells

  • parameters:
    • rowTester: (typeof function(Integer)|Integer)

      If it's a function, it's a predicate to decide which rows are to be merged.
      It takes an integer (the row index), and should return true or false;

    • startColumnIndex: (typeof Integer)

      The column index of the left most cell that shall be merged.

    • endColumnIndex: (typeof Integer)

      The column index of the right most cell that shall be merged.

    • majorColumnIndex: (typeof Integer)

      The column index of the cell whose content should be used as the content of the merged cell.
      It must be larger than or equal to the startColumnIndex, and less than or equal to the endColumnIndex.
      If it is omitted, the content of the leading edge (left-most for ltr, right most for rtl) cell will be used.
      return: Object | null
      A handler for the merged cells created by a call of this function.
      This handler can be used later to unmerge cells using the function unmergeCells
      If the merge is not valid, returns null;

  • summary

    Merge cells from *startColumnIndex* to *endColumnIndex* at rows that make *rowTester* return true,
    using the content of the cell at *majorColumnIndex*

  • tags: public
  • type

    Function

• dojox.grid.enhanced.plugins.CellMerge.unmergeCells

  • parameters:
    • mergeHandler: (typeof object)

      A handler for the merged cells created by a call of function mergeCells.

  • summary

    Unmerge the cells that are merged by the *mergeHandler*, which represents a call to the function mergeCells.

  • tags: public
  • type

    Function

• dojox.grid.enhanced.plugins.CellMerge.getMergedCells

  • summary

    Get all records of currently merged cells.

  • tags: public return: Array An array of records for merged-cells. The record has the following structure: { "row": 1, //the row index "start": 2, //the start column index "end": 4, //the end column index "major": 3, //the major column index "handle": someHandle, //The handler that covers this merge cell record. }
  • type

    Function

• dojox.grid.enhanced.plugins.CellMerge.getMergedCellsByRow

  • parameters:
    • rowIndex
  • summary

    Get the records of currently merged cells at the given row.

  • tags: public return: Array An array of records for merged-cells. See docs of getMergedCells.
  • type

    Function

• dojox.grid.enhanced.plugins.CellMerge._setupConfig

  • parameters:
    • config
  • type

    Function

• dojox.grid.enhanced.plugins.CellMerge._initEvents

  • type

    Function

• dojox.grid.enhanced.plugins.CellMerge._mixinGrid

  • type

    Function

• dojox.grid.enhanced.plugins.CellMerge.grid

• dojox.grid.enhanced.plugins.CellMerge.grid.mergeCells

  • type

    Object

• dojox.grid.enhanced.plugins.CellMerge.grid.unmergeCells

  • type

    Object

• dojox.grid.enhanced.plugins.CellMerge.grid.getMergedCells

  • type

    Object

• dojox.grid.enhanced.plugins.CellMerge.grid.getMergedCellsByRow

  • type

    Object

• dojox.grid.enhanced.plugins.CellMerge._getWidth

  • parameters:
    • colIndex
  • type

    Function

• dojox.grid.enhanced.plugins.CellMerge._onAfterRow

  • parameters:
    • viewIdx
    • rowIndex
    • subrows
  • type

    Function

• dojox.grid.enhanced.plugins.CellMerge._records.length

• dojox.grid.enhanced.plugins.CellMerge.grid.layout.cells

• dojox.grid.enhanced.plugins.CellMerge._createRecord

  • parameters:
    • item
  • type

    Function

• dojox.grid.enhanced.plugins.CellMerge._isValid

  • parameters:
    • item
  • type

    Function

• dojox.grid.enhanced.plugins.CellMerge.grid.layout.cells.length

• dojox.grid.enhanced.plugins.CellMerge._updateRows

  • parameters:
    • item
  • type

    Function

• dojox.grid.enhanced.plugins.CellMerge.grid.rowCount

• dojox.grid.enhanced.plugins.CellMerge._records

  • type

    Array

• dojox.grid.enhanced.plugins.CellMerge._merged

  • type

    Object

• dojox.grid.enhanced.plugins

  • type

    Object

• dojox.grid.enhanced

  • type

    Object

• dojox.grid

  • type

    Object

• dojox

  • type

    Object