dojox/grid/enhanced/plugins/_StoreLayer.js

• Provides:

  • dojox.grid.enhanced.plugins._StoreLayer

• dojox.grid.enhanced.plugins._StoreLayer

  • type

    Function

  • summary

    The most abstract class of store layers, provides basic utilities and some interfaces.

  • tags: abstract

• dojox.grid.enhanced.plugins._StoreLayer._store

  • tags:
  • type

    Read-store

  • summary

    The wrapped store.

• dojox.grid.enhanced.plugins._StoreLayer._originFetch

  • tags:
  • type

    function

  • summary

    The original fetch function of the store.

• dojox.grid.enhanced.plugins._StoreLayer.__enabled

  • tags:
  • type

    Boolean

  • summary

    To control whether this layer is valid.

• dojox.grid.enhanced.plugins._StoreLayer.tags

  • type

    Array

• dojox.grid.enhanced.plugins._StoreLayer.layerFuncName

  • type

    String

• dojox.grid.enhanced.plugins._StoreLayer.constructor

  • constructor - constructor
  • type

    Function

• dojox.grid.enhanced.plugins._StoreLayer.initialize

  • parameters:
    • store
  • type

    Function

• dojox.grid.enhanced.plugins._StoreLayer.uninitialize

  • parameters:
    • store
  • type

    Function

• dojox.grid.enhanced.plugins._StoreLayer.invalidate

  • type

    Function

• dojox.grid.enhanced.plugins._StoreLayer._wrap

  • parameters:
    • store: (typeof Read-store)

      The store to be wrapped.

    • funcName
    • layerFuncName
    • nextLayer
  • summary

    Do the actual wrapping (or 'hacking' if you like) to the store.

  • tags: internal
  • type

    Function

• dojox.grid.enhanced.plugins._StoreLayer._funcName

• dojox.grid.enhanced.plugins._StoreLayer._unwrap

  • parameters:
    • nextLayer
  • summary

    Do the actual unwrapping to the store.

  • tags: internal store: Read-store The store to be unwrapped.
  • type

    Function

• dojox.grid.enhanced.plugins._StoreLayer.enabled

  • parameters:
    • toEnable: (typeof bool)

      Boolean If given, is a setter, otherwise, it's getter.

  • returns

    Boolean

  • summary

    The get/set function of the enabled status of this layer

  • tags: public
  • type

    Function

• dojox.grid.enhanced.plugins._StoreLayer.name

  • summary

    Get the name of this store layer.
    The default name retrieved from class name, which should have a pattern of "{name}Layer".
    If this pattern does not exist, the whole class name will be this layer's name.
    It's better to override this method if your class name is too complicated.

  • tags: public extension
  • return_summary

    The name of this layer.

  • type

    Function

• dojox.grid.enhanced.plugins._StoreLayer.__name

• dojox.grid.enhanced.plugins._StoreLayer.originFetch

  • type

    Function

• dojox.grid.enhanced.plugins._ServerSideLayer

  • type

    Function

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

    The most abstract class for all server side store layers.

  • tags: abstract

• dojox.grid.enhanced.plugins._ServerSideLayer._url

  • tags:
  • type

    string

  • summary

    The url of the server
    
    
    __cmds [private] object
    The command object to be sent to server.

• dojox.grid.enhanced.plugins._ServerSideLayer.__cmds

  • type

    Object

• dojox.grid.enhanced.plugins._ServerSideLayer.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • args

• dojox.grid.enhanced.plugins._ServerSideLayer.enabled

  • parameters:
    • toEnable: (typeof bool)
  • summary

    Overrided from _StoreLayer.enabled

  • type

    Function

• dojox.grid.enhanced.plugins._ServerSideLayer.__cmds.enable

• dojox.grid.enhanced.plugins._ServerSideLayer.useCommands

  • parameters:
    • toUse: (typeof bool)

      Boolean If provided, it's a setter, otherwise, it's a getter

  • returns

    Boolean

  • summary

    If you only want to modify the user request, instead of sending a separate command
    to server before fetch, just call:
    this.useCommand(false);

  • tags: public
  • type

    Function

• dojox.grid.enhanced.plugins._ServerSideLayer.__cmds.cmdlayer

• dojox.grid.enhanced.plugins._ServerSideLayer._fetch

  • parameters:
    • userRequest: (typeof keywordArgs)
  • returns

    dojo.data.api.Request

  • summary

    Implementation of _StoreLayer._fetch

  • type

    Function

• dojox.grid.enhanced.plugins._ServerSideLayer.command

  • parameters:
    • cmdName: (typeof string)

      The name of the command

    • cmdContent: (typeof (string|number|bool|))

      anything The content of the command

  • returns

    anything

  • summary

    get/set a command (a name-value pair)

  • tags: public
  • return_summary

    The content of the command if cmdContent is undefined

  • type

    Function

• dojox.grid.enhanced.plugins._ServerSideLayer.onCommandLoad

  • parameters:
    • response: (typeof string)

      server response

    • userRequest: (typeof keywordArgs)

      in|out] dojo.data.api.Request
      The request object for *fetch*. You can modify this object according to the *response*
      so as to change the behavior of *fetch*

  • summary

    When the server gives back *response* for the commands, you can do something here.

  • tags: callback extension
  • type

    Function

• dojox.grid.enhanced.plugins._ServerSideLayer.onCommandError

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

    handle errors when sending commands.

  • tags: callback extension
  • type

    Function

• dojox.grid.enhanced.plugins._ServerSideLayer._isStateful

  • type

    bool

• dojox.grid.enhanced.plugins._ServerSideLayer._onUserCommandLoad

  • type

    Function

• dojox.grid.enhanced.plugins

  • alias - dojox.grid.enhanced.plugins

• dojox.grid.enhanced.plugins.wrap

  • parameters:
    • store: (typeof Read-store)

      The store to be wrapped.

    • funcName
    • layer: (typeof _StoreLayer)

      The layer to be used
      returns
      The wrapped store, for nested use only.

    • layerFuncName
  • returns

    Read-store

  • summary

    Wrap the store with the given layer.

  • tags: public
  • type

    Function

• dojox.grid.enhanced

  • type

    Object

• dojox.grid

  • type

    Object

• dojox

  • type

    Object