dojox/calendar/RendererManager (version 1.10)

dojo/Stateful, dojo/Evented

Summary

This mixin contains the store management.

Usage

var foo = new RendererManager(args);
dojox/calendar/RendererManager
Parameter Type Description
args Object

See the dojox/calendar/RendererManager reference documentation for more information.

Property Summary

  • _attrPairNamesUsed across all instances a hash to cache attribute names and their getter and setter names.
  • itemToRendererThe associated array item to renderer list.
  • ownerThe owner of the store manager: a view or a calendar widget.
  • rendererListThe list of used renderers
  • rendererPoolThe stack of recycled renderers available.

Method Summary

  • _changeAttrValue(name,value) Internal helper for directly changing an attribute value.
  • _get(name,names) Private function that does a get based off a hash of names
  • _getAttrNames(name) Helper function for get() and set().
  • createRenderer(item,kind,rendererClass,cssClass) Creates an item renderer of the specified kind.
  • destroy()
  • destroyRenderer(renderer) Destroys the item renderer.
  • destroyRenderersByKind(kind)
  • emit(type,event)
  • get(name) Get a property on a Stateful instance.
  • getRenderers(item) Returns the renderers that are currently used to displayed the speficied item.
  • on(type,listener)
  • postscript(params)
  • recycleItemRenderers(remove) Recycles all the item renderers.
  • recycleRenderer(renderer,remove) Recycles the item renderer to be reused in the future.
  • set(name,value) Set a property on a Stateful instance
  • watch(name,callback) Watches a property for changes

Properties

_attrPairNames
Defined by: dojo/Stateful

Used across all instances a hash to cache attribute names and their getter and setter names.

itemToRenderer
Defined by: dojox/calendar/RendererManager

The associated array item to renderer list.

owner
Defined by: dojox/calendar/RendererManager

The owner of the store manager: a view or a calendar widget.

rendererList
Defined by: dojox/calendar/RendererManager

The list of used renderers

rendererPool
Defined by: dojox/calendar/RendererManager

The stack of recycled renderers available.

Methods

_changeAttrValue(name,value)
Defined by dojo/Stateful

Internal helper for directly changing an attribute value.

Directly change the value of an attribute on an object, bypassing any accessor setter. Also handles the calling of watch and emitting events. It is designed to be used by descendant class when there are two values of attributes that are linked, but calling .set() is not appropriate.

Parameter Type Description
name String

The property to set.
value Mixed

The value to set in the property.

Returns:function

Internal helper for directly changing an attribute value.

_get(name,names)
Defined by dojo/Stateful

Private function that does a get based off a hash of names

Parameter Type Description
name undefined
names undefined

Hash of names of custom attributes
Returns:undefined
_getAttrNames(name)
Defined by dojo/Stateful

Helper function for get() and set(). Caches attribute name values so we don't do the string ops every time.

Parameter Type Description
name undefined
Returns:undefined | object
createRenderer(item,kind,rendererClass,cssClass)
Defined by dojox/calendar/RendererManager

Creates an item renderer of the specified kind. A renderer is an object with the "container" and "instance" properties.

Parameter Type Description
item Object

The data item.
kind String

The kind of renderer.
rendererClass Object

The class to instantiate to create the renderer.
cssClass undefined
Returns:Object | object | null
destroy()
Defined by dojox/calendar/RendererManager
destroyRenderer(renderer)
Defined by dojox/calendar/RendererManager

Destroys the item renderer.

Parameter Type Description
renderer dojox/calendar/_RendererMixin

The item renderer to destroy.
destroyRenderersByKind(kind)
Defined by dojox/calendar/RendererManager
Parameter Type Description
kind undefined
emit(type,event)
Defined by dojo/Evented
Parameter Type Description
type undefined
event undefined
Returns:undefined
get(name)
Defined by dojo/Stateful

Get a property on a Stateful instance.

Get a named property on a Stateful object. The property may potentially be retrieved via a getter method in subclasses. In the base class this just retrieves the object's property.

Parameter Type Description
name String

The property to get.
Returns:any | undefined

The property value on this Stateful instance.

Examples

Example 1

require(["dojo/Stateful", function(Stateful) {
    var stateful = new Stateful({foo: 3});
    stateful.get("foo") // returns 3
    stateful.foo // returns 3
});
getRenderers(item)
Defined by dojox/calendar/RendererManager

Returns the renderers that are currently used to displayed the speficied item. Returns an array of objects that contains two properties: - container: The DOM node that contains the renderer. - renderer: The dojox.calendar._RendererMixin instance. Do not keep references on the renderers are they are recycled and reused for other items.

Parameter Type Description
item Object

The data or render item.
Returns:Object[] | null
on(type,listener)
Defined by dojo/Evented
Parameter Type Description
type undefined
listener undefined
Returns:undefined
postscript(params)
Defined by dojo/Stateful
Parameter Type Description
params Object
Optional
recycleItemRenderers(remove)
Defined by dojox/calendar/RendererManager

Recycles all the item renderers.

Parameter Type Description
remove Boolean

Whether remove the DOM node from it parent.
recycleRenderer(renderer,remove)
Defined by dojox/calendar/RendererManager

Recycles the item renderer to be reused in the future.

Parameter Type Description
renderer dojox/calendar/_RendererMixin

The item renderer to recycle.
remove undefined
set(name,value)
Defined by dojo/Stateful

Set a property on a Stateful instance

Sets named properties on a stateful object and notifies any watchers of the property. A programmatic setter may be defined in subclasses.

Parameter Type Description
name String

The property to set.
value Object

The value to set in the property.
Returns:any | function

The function returns this dojo.Stateful instance.

Examples

Example 1

require(["dojo/Stateful", function(Stateful) {
    var stateful = new Stateful();
    stateful.watch(function(name, oldValue, value){
        // this will be called on the set below
    }
    stateful.set(foo, 5);

set() may also be called with a hash of name/value pairs, ex: 

stateful.set({
    foo: "Howdy",
    bar: 3
});
});

This is equivalent to calling set(foo, "Howdy") and set(bar, 3)

watch(name,callback)
Defined by dojo/Stateful

Watches a property for changes

Parameter Type Description
name String
Optional

Indicates the property to watch. This is optional (the callback may be the only parameter), and if omitted, all the properties will be watched
callback Function

The function to execute when the property changes. This will be called after the property has been changed. The callback will be called with the |this| set to the instance, the first argument as the name of the property, the second argument as the old value and the third argument as the new value.
Returns:any | object

An object handle for the watch. The unwatch method of this object can be used to discontinue watching this property: 

var watchHandle = obj.watch("foo", callback);
watchHandle.unwatch(); // callback won't be called now
Error in the documentation? Can’t find what you are looking for? Let us know!