dojox/grid/enhanced/plugins/Cookie.js

• Provides:

  • dojox.grid.enhanced.plugins.Cookie

• Requires:

  • dojox.grid.enhanced._Plugin in common
  • dojo.cookie in common
  • dojox.grid._RowSelector in common
  • dojox.grid.cells._base in common

• dojox.grid.enhanced.plugins.Cookie

  • type

    Function

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

    This plugin provides a way to persist some grid features in cookie.
    Default persistable features are:
    column width:	"columnWidth" (handler name)
    column order:	"columnOrder"
    sorting order:	"sortOrder"
    
    Grid users can define new persistable features
    by calling the following before grid is initialized (that is, during "preInit");
    	grid.addCookieHandler({
    		name: "a name for the new persistable feature",
    		onLoad: function(savedObject, grid){
    			//load the cookie.
    		},
    		onSave: function(grid){
    			//save the cookie.
    		}
    	});

• dojox.grid.enhanced.plugins.Cookie.name

  • type

    String

  • summary

    Plugin name

• dojox.grid.enhanced.plugins.Cookie._cookieEnabled

  • type

    bool

• dojox.grid.enhanced.plugins.Cookie.constructor

  • constructor - constructor
  • type

    Function

  • parameters:
    • grid
    • args

• dojox.grid.enhanced.plugins.Cookie.destroy

  • type

    Function

• dojox.grid.enhanced.plugins.Cookie._cookieHandlers

  • type

    Array

• dojox.grid.enhanced.plugins.Cookie._mixinGrid

  • type

    Function

• dojox.grid.enhanced.plugins.Cookie.grid

• dojox.grid.enhanced.plugins.Cookie.grid.addCookieHandler

  • type

    Object

• dojox.grid.enhanced.plugins.Cookie.grid.removeCookie

  • type

    Object

• dojox.grid.enhanced.plugins.Cookie.grid.setCookieEnabled

  • type

    Object

• dojox.grid.enhanced.plugins.Cookie.grid.getCookieEnabled

  • type

    Object

• dojox.grid.enhanced.plugins.Cookie._saveCookie

  • type

    Function

• dojox.grid.enhanced.plugins.Cookie.onPreInit

  • type

    Function

• dojox.grid.enhanced.plugins.Cookie._cookie

  • type

    Object

• dojox.grid.enhanced.plugins.Cookie._cookieStartedup

  • type

    Object

• dojox.grid.enhanced.plugins.Cookie.addCookieHandler

  • parameters:
    • args: (typeof Object)

      An object with the following structure:
      	{
      		name: "some-string",
      		onLoad: /* void */ function(/* object */partOfCookie, /* EDG */grid){...},
      		onSave: /* object */ function(/* EDG */grid){...}
      	}

  • summary

    If a grid plugin wants cookie service, call this.
    This must be called during preInit.

  • type

    Function

• dojox.grid.enhanced.plugins.Cookie.removeCookie

  • summary

    Remove cookie for this grid.

  • type

    Function

• dojox.grid.enhanced.plugins.Cookie.setCookieEnabled

  • parameters:
    • cookieName: (typeof String)

      Name of a cookie handler if provided, otherwise for all cookies.

    • enabled: (typeof Boolean)
  • summary

    A setter to enable|disable cookie support for a particular Grid feature.

  • type

    Function

• dojox.grid.enhanced.plugins.Cookie.getCookieEnabled

  • parameters:
    • cookieName: (typeof String)

      Name of a cookie handler if provided, otherwise for all cookies.

  • summary

    A getter to check cookie support of a particular Grid feature.

  • type

    Function

• dojox.grid.enhanced.plugins.Cookie.cookieProps

• dojox.grid.enhanced.plugins

  • type

    Object

• dojox.grid.enhanced

  • type

    Object

• dojox.grid

  • type

    Object

• dojox

  • type

    Object