dojox/form/manager/_ClassMixin (version 1.10)

Summary

Form manager's mixin for testing/assigning/removing classes of controlled elements.

This mixin provides unified way to check/add/remove a class of controlled elements. It should be used together with dojox.form.manager.Mixin.

See the dojox/form/manager/_ClassMixin reference documentation for more information.

Method Summary

  • addClass(className,names) Add a class to nodes according to the supplied set of names
  • gatherClassState(className,names) Gather the presence of a certain class in all controlled elements.
  • removeClass(className,names) Remove a class from nodes according to the supplied set of names

Methods

addClass(className,names)

Add a class to nodes according to the supplied set of names

Parameter Type Description
className String

Class name to add.

names Object
Optional

If it is an array, it is a list of names to be processed. If it is an object, dictionary keys are names to be processed. If it is omitted, all known form elements are to be processed.

Returns:function

Add a class to nodes according to the supplied set of names

gatherClassState(className,names)

Gather the presence of a certain class in all controlled elements.

Parameter Type Description
className String

The class name to test for.

names Object
Optional

If it is an array, it is a list of names to be processed. If it is an object, dictionary keys are names to be processed. If it is omitted, all known form elements are to be processed.

Returns:undefined
removeClass(className,names)

Remove a class from nodes according to the supplied set of names

Parameter Type Description
className String

Class name to remove.

names Object
Optional

If it is an array, it is a list of names to be processed. If it is an object, dictionary keys are names to be processed. If it is omitted, all known form elements are to be processed.

Returns:function

Remove a class from nodes according to the supplied set of names

Error in the documentation? Can’t find what you are looking for? Let us know!