dojox/grid/enhanced/plugins/Pagination.js

• Provides:

  • dojox.grid.enhanced.plugins.Pagination

• Requires:

  • dijit.form.NumberTextBox in common
  • dijit.form.Button in common
  • dojox.grid.enhanced._Plugin in common
  • dojox.grid.enhanced.plugins.Dialog in common
  • dojox.grid.enhanced.plugins._StoreLayer in common

• dojox.grid.enhanced.plugins.Pagination

  • type

    Function

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

    The typical pagination way as an alternative to deal with huge data set besides the default virtual scrolling way

• dojox.grid.enhanced.plugins.Pagination.name

  • type

    String

• dojox.grid.enhanced.plugins.Pagination.pageSize

  • type

    Number

• dojox.grid.enhanced.plugins.Pagination.defaultRows

  • type

    Number

• dojox.grid.enhanced.plugins.Pagination._currentPage

  • type

    Number

• dojox.grid.enhanced.plugins.Pagination._maxSize

  • type

    Number

• dojox.grid.enhanced.plugins.Pagination.init

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination.gh

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination.grid.rowsPerPage

• dojox.grid.enhanced.plugins.Pagination.grid.usingPagination

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination.nls

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination._createPaginators

  • parameters:
    • paginationArgs
  • summary

    Function to create the pagination control bar.

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination.paginators

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination._wrapStoreLayer

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination.grid

• dojox.grid.enhanced.plugins.Pagination._store

• dojox.grid.enhanced.plugins.Pagination.query

• dojox.grid.enhanced.plugins.Pagination.forcePageStoreLayer

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination._stopEvent

  • parameters:
    • event
  • type

    Function

• dojox.grid.enhanced.plugins.Pagination._onNew

  • parameters:
    • item
    • parentInfo
  • type

    Function

• dojox.grid.enhanced.plugins.Pagination._removeSelectedRows

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination._multiRemoving

  • type

    bool

• dojox.grid.enhanced.plugins.Pagination._onDelete

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination._regApis

  • summary

    register pagination public APIs to grid.

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination.grid.gotoPage

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination.grid.nextPage

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination.grid.prevPage

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination.grid.gotoFirstPage

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination.grid.gotoLastPage

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination.grid.changePageSize

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination.grid.showGotoPageButton

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination.grid.getTotalRowCount

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination.originalScrollToRow

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination.grid.scrollToRow

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination._originalOnNew

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination._originalRemove

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination.grid.removeSelectedRows

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination.grid._onNew

  • type

    Object

• dojox.grid.enhanced.plugins.Pagination.destroy

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination.nextPage

  • summary

    Function to handle shifting to the next page in the list.

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination.prevPage

  • summary

    Function to handle shifting to the previous page in the list.

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination.gotoPage

  • parameters:
    • page: (typeof The)

      page to go to, starting at 1.

  • summary

    Function to handle shifting to an arbirtary page in the list.

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination.gotoFirstPage

  • summary

    Go to the first page

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination.gotoLastPage

  • summary

    Go to the last page

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination.changePageSize

  • parameters:
    • size
  • summary

    Change size of items per page.
    This function will only be called by _Paginator

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination.showGotoPageButton

  • parameters:
    • flag: (typeof boolean)

      Show the go to page button when flag is true, otherwise hide it

  • summary

    For show/hide the go to page button dynamically

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination.scrollToRow

  • parameters:
    • inRowIndex: (typeof integer)

      The row index

  • summary

    Override the grid.scrollToRow(), could jump to the right page
    and scroll to the specific row

  • type

    Function

• dojox.grid.enhanced.plugins.Pagination.getTotalRowCount

  • summary

    Function for get total row count

  • type

    Function

• dojox.grid.enhanced.plugins._ForcedPageStoreLayer

  • type

    Function

  • chains:
    • dojox.grid.enhanced.plugins._StoreLayer: (prototype)
    • dojox.grid.enhanced.plugins._StoreLayer: (call)
  • parameters:
    • plugin

• dojox.grid.enhanced.plugins._ForcedPageStoreLayer.tags

  • type

    Array

• dojox.grid.enhanced.plugins._ForcedPageStoreLayer.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • plugin

• dojox.grid.enhanced.plugins._ForcedPageStoreLayer._fetch

  • parameters:
    • request
  • type

    Function

• dojox.grid.enhanced.plugins._ForcedPageStoreLayer._plugin

• dojox.grid.enhanced.plugins._Paginator

  • type

    Function

  • chains:
    • dijit._Widget: (prototype)
    • dijit._Templated.prototype: (prototype)
    • dijit._Widget: (call)
    • dijit._Templated: (call)
  • parameters:
    • params

• dojox.grid.enhanced.plugins._Paginator.templatePath

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator.position

  • type

    String

• dojox.grid.enhanced.plugins._Paginator._maxItemSize

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator.description

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator.pageStepper

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator.maxPageStep

  • type

    Number

• dojox.grid.enhanced.plugins._Paginator.sizeSwitch

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator.pageSizes

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator.gotoButton

  • type

    bool

• dojox.grid.enhanced.plugins._Paginator.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • params

• dojox.grid.enhanced.plugins._Paginator.postCreate

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.grid

• dojox.grid.enhanced.plugins._Paginator._originalResize

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator.grid.resize

  • parameters:
    • changeSize
    • resultSize
  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.grid._pendingChangeSize

• dojox.grid.enhanced.plugins._Paginator.grid._pendingResultSize

• dojox.grid.enhanced.plugins._Paginator.destroy

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.update

  • summary

    Function to update paging information and update
    pagination bar display.

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.currentPageSize

• dojox.grid.enhanced.plugins._Paginator._setWidthValue

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._regFocusMgr

  • parameters:
    • position
  • summary

    Function to register pagination bar to focus manager.

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._placeSelf

  • summary

    Place pagination bar to a position.
    There are two options, top of the grid, bottom of the grid.

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._resetGridHeight

  • parameters:
    • changeSize
    • resultSize
  • summary

    Function of resize grid height to place this pagination bar.
    Since the grid would be able to add other element in its domNode, we have
    change the grid view size to place the pagination bar.
    This function will resize the grid viewsNode height, scorllboxNode height

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._resultSize

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator.plugin.gh

  • type

    String

• dojox.grid.enhanced.plugins._Paginator._styleMsgNode

  • parameters:
    • top
    • width
    • height
  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.grid.messagesNode

• dojox.grid.enhanced.plugins._Paginator._updateDescription

  • summary

    Update size information.

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.plugin.forcePageStoreLayer

• dojox.grid.enhanced.plugins._Paginator.descriptionDiv.innerHTML

• dojox.grid.enhanced.plugins._Paginator._updateSizeSwitch

  • summary

    Update "items per page" information.

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.pageSizeValue

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator._createSizeSwitchNodes

  • summary

    The function to create the size switch nodes

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.initializedSizeNode

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator._updateSwitchNodeClass

  • summary

    Update the switch nodes style

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._updatePageStepper

  • summary

    Update the page step nodes

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.pageStepValue

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator._createPageStepNodes

  • summary

    Create the page step nodes if they do not exist

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._createWardBtns

  • summary

    Create the previous/next/first/last button

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._resetPageStepNodes

  • summary

    The page step nodes might be changed when fetch data, we need to
    update/reset them

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.pageStepperDiv.childNodes

• dojox.grid.enhanced.plugins._Paginator._updatePageStepNodeClass

  • summary

    Update the style of the page step nodes

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._showGotoButton

  • parameters:
    • flag
  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._updateGotoButton

  • summary

    Create/destroy the goto page button

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._createGotoNode

  • summary

    Create the goto page button

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.gotoPageTd

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator.gotoPageDiv

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator._openGotopageDialog

  • parameters:
    • event
  • summary

    Show the goto page dialog

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._gotoPageDialog

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator._currentFocusNode

  • type

    Object

• dojox.grid.enhanced.plugins._Paginator.focusArea

  • type

    String

• dojox.grid.enhanced.plugins._Paginator._onFocusPaginator

  • parameters:
    • event
    • step
  • summary

    Focus handler

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._onFocusPageSizeNode

  • parameters:
    • event
  • summary

    Focus the page size area, if there is no focusable node, return false

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._onFocusPageStepNode

  • parameters:
    • event
  • summary

    Focus the page step area, if there is no focusable node, return false

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._onFocusGotoPageNode

  • parameters:
    • event
  • summary

    Focus the goto page button, if there is no focusable node, return false

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._onBlurPaginator

  • parameters:
    • event
    • step
  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._onKeyDown

  • parameters:
    • event
    • isBubble
  • summary

    Focus navigation

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._moveFocus

  • parameters:
    • rowDelta
    • colDelta
    • evt
  • summary

    Move focus according row delta&column delta

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._getPageSizeActivableNodes

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._getPageStepActivableNodes

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._getAllPageSizeNodes

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._getAllPageStepNodes

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.pageStepperDiv.childNodes.length

• dojox.grid.enhanced.plugins._Paginator._moveToNextActivableNode

  • parameters:
    • nodeList
    • curNodeValue
  • summary

    Need to move the focus to next node since current node is inactive and unfocusable

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._onSwitchPageSize

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

    The handler of switch the page size

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.plugin.grid.usingPagination

  • type

    bool

• dojox.grid.enhanced.plugins._Paginator._onPageStep

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

    The handler jump page event

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.plugin

• dojox.grid.enhanced.plugins._Paginator._getCurrentPageNo

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._getPageCount

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._getStartPage

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator._getStepPageSize

  • type

    Function

• dojox.grid.enhanced.plugins._Paginator.itemTitle

• dojox.grid.enhanced.plugins._Paginator.descTemplate

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog

  • type

    Function

  • parameters:
    • plugin

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog.pageCount

  • type

    Object

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • plugin

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._createDialogContent

  • summary

    Create the dialog content

  • type

    Function

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._specifyNode

  • type

    Object

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._pageInputDiv

  • type

    Object

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._pageTextBox

  • type

    Object

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._pageTextBox.constraints

  • type

    Object

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._pageLabel

  • type

    Object

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._buttonDiv

  • type

    Object

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._confirmBtn

  • type

    Object

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._cancelBtn

  • type

    Object

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._gotoPageDialog.onCancel

  • type

    Object

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._styleContent

  • type

    Function

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog.updatePageCount

  • type

    Function

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog.showDialog

  • type

    Function

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._onConfirm

  • parameters:
    • event
  • summary

    Jump to the given page

  • type

    Function

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._onCancel

  • parameters:
    • event
  • summary

    Cancel action and hide the dialog

  • type

    Function

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._onKeyDown

  • parameters:
    • event
  • type

    Function

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._setConfirmBtnState

  • type

    Function

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog.destroy

  • type

    Function

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog.plugin

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._dialogNode

  • type

    Object

• dojox.grid.enhanced.plugins.pagination._GotoPageDialog._gotoPageDialog

  • type

    Object

• dojox.grid.enhanced.plugins

  • type

    Object

• dojox.grid.enhanced

  • type

    Object

• dojox.grid

  • type

    Object

• dojox

  • type

    Object