MODULES Uize.Widget.Committer

SEARCH EXAMPLES SOURCE TO DO DEPS TEST

Contents

1. Introduction

The Uize.Widget.Committer class provides a way to interface between a configurable set of state properties, on one or more instance, and other code.

DEVELOPERS: Chris van Rensburg, Tim Carter

1.1. In a Nutshell

The Uize.Widget.Committer class provides a convenient way to interface between a set of properties and other code.

1.1.1. Watched Properties

An instance of this class can be wired up to watch on any number of properties, as specified by the watchedProperties state property.

In a common case, the set of properties being watched might be the value state properties of a bunch of form input widgets. The committer instance acts as a conduit or interface between the watched properties and the code that cares about watching them.

1.1.2. Convenient Buttons

The values of the watched properties can be committed to the watching code by the user clicking on a commit button, or by the commit instance method being called. Additionally, optional clearAll, restoreInitial, and restorePrevious buttons are supported.

1.1.3. Auto-commit

An auto-commit behavior allows uncommitted values to be automatically committed after a configurable period of inactivity since the last modification, as specified by the autoCommitDelay state property.

1.1.4. Logical State Summary

For the convenience of the watching code, a full complement of read-only boolean state properties provides a logical state summary of the watched properties.

This state summary is provided through the allClear, allValid, anyNotInitial, anyNotCommitted, and readyToCommit boolean state properties, and the committedValues, initialValues, and uncommittedValues object state properties.

1.2. Examples

There are no dedicated showcase example pages for the Uize.Widget.Committer module.

SEARCH FOR EXAMPLES

Use the link below to search for example pages on the UIZE Web site that reference the Uize.Widget.Committer module...

1.3. Implementation Info

The Uize.Widget.Committer module defines the Uize.Widget.Committer class, which is a subclass of Uize.Widget.

INHERITANCE CHAIN

Uize.Class −> Uize.Widget −> Uize.Widget.Committer

1.3.1. Features Introduced in This Module

The features listed in this section have been introduced in this module.

INSTANCE METHODS

STATE PROPERTIES

1.3.2. Features Overridden in This Module

The features listed in this section have been overridden in this module.

The module that an overridden feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

valueOf

STATIC PROPERTIES

Uize.Widget.Committer.moduleName | Uize.Widget.Committer.nonInheritableStatics | Uize.Widget.Committer.undefined

1.3.3. Features Inherited From Other Modules

The features listed in this section have been inherited from other modules.

The module that an inherited feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.

INSTANCE METHODS

INSTANCE PROPERTIES

showConfirm | showInform

STATE PROPERTIES

STATIC METHODS

STATIC PROPERTIES

Uize.Widget.Committer.busyParentTickle | Uize.Widget.Committer.enabledParentTickle | Uize.Widget.Committer.isWired | Uize.Widget.Committer.pathToResources

1.3.4. Modules Directly Under This Namespace

There are no modules directly under this namespace.

1.3.5. Unit Tests

There is no dedicated unit tests module for the Uize.Widget.Committer module.

2. Child Widgets

2.1. clearAll

An instance of the Uize.Widget.Button class, that is wired up so that clicking on it will clear the values of all the watched properties by setting them to '' (empty string).

NOTES

see the related allClear state property

2.2. commit button

An instance of the Uize.Widget.Button class, that is wired up so that clicking on it will commit the values of the watched properties.

The markup for this button is optional. If no markup is present, the action of the button can still be invoked programmatically by calling the commit instance method.

NOTES

see the related commit instance method

2.3. restoreInitial

An instance of the Uize.Widget.Button class, that is wired up so that clicking on it will restore the values of all the watched properties to their initial state (i.e. before a Uize.Widget.Committer instance is wired up).

The markup for this button is optional. The enabled state of this button is managed by the Uize.Widget.Committer class, so that it is disabled whenever the values of all watched properties are at their initial state (i.e. when the value of the anyNotInitial state property is false and clicking this button would have no effect). This could be right after wiring the instance, or right after using the restoreInitial button to retore the values of the watched properties to their initial state.

NOTES

see the related anyNotInitial state property

2.4. restorePrevious

An instance of the Uize.Widget.Button class, that is wired up so that clicking on it will restore the values of all the watched properties to their previous committed state (i.e. before any of the previously committed values were subsequently modified).

The markup for this button is optional. The enabled state of this button is managed by the Uize.Widget.Committer class, so that it is disabled whenever there are no values to commit (i.e. when the value of the anyNotCommitted state property is false and clicking this button would have no effect). This could be right after wiring the instance, right after using the restorePrevious button to retore the values of the watched properties to their previous committed state, or after editing the values of the watched properties in such a way that they return to their previously committed state.

NOTES

see the related anyNotCommitted state property

3. Instance Events

3.1. Commit

Fired whenever uncommitted values are successfully committed.

This event will be fired regardless of how the uncommitted values are committed - whether programmatically by calling the commit instance method, or by the user clicking the commit button.

4. Instance Methods

4.1. addChild

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.2. addChildren

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.3. addWatchedProperties

Adds a watched property to the watchedProperties property of the instance.

SYNTAX

myCommitter.addWatchedProperties (
  [
    {
      alias:'aliasString',
      instance:'instanceObject',
      name:'nameString'
    }
  ]
);

PARAMS

_propertiesToWatch:_propertiesARR      // an array whose elements represent the widgets and properties to watch

The elements of the _propertiesToWatch array should be objects of the following format:
{
  alias:'aliasSTR'        // a string, to be used as a key in the =_watchedProperties= hash
  instance:'instanceOBJ'      // a Uize instance object containing the property to be watched
  name:'nameSTR'          // the public property alias of the property to be watched
}

Adding a new property directly to the watchedProperties object will not trigger the methods that wire up the events that do the watching. Similarly, using the set method to assign a new object (with the new properties to watch) to the watchedProperties property will not unwire the aforementioned events from the previous object.

IMPLEMENTATION INFO

this feature was introduced in this module

4.4. ajax

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.5. buildHtml

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.6. callInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.7. childHtml

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.8. childId

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.9. clearAll

IMPLEMENTATION INFO

this feature was introduced in this module

4.10. commit

Lets you programmatically commit the uncommitted values of the watched properties.

SYNTAX

myCommitter.commit ();

Calling the commit instance method has the same effect as the user clicking the commit button. Uncommitted values will only be successfully committed if they are all valid, as indicated by the allValid state property. Successfully committing values will result in the Commit instance event being fired. After uncommitted values are successfully committed, the values of the uncommittedValues and committedValues state properties will be identical.

NOTES

see the related commit button child widget

IMPLEMENTATION INFO

this feature was introduced in this module

4.11. confirm

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.12. displayNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.13. fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

4.14. flushNodeCache

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.15. get

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

4.16. getContainer

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.17. getHtml

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.18. getInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.19. getNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.20. getNodeStyle

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.21. getNodeValue

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.22. getProvider

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.23. globalizeNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.24. inform

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.25. injectNodeHtml

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.26. insertOrWireUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.27. insertUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.28. is

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

4.29. isMet

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

4.30. kill

Inherited from Uize.Widget, but introduced in Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Class)

4.31. localize

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.32. met

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

4.33. nodeId

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.34. onChange

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

4.35. once

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

4.36. removeChild

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.37. removeNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.38. removeUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.39. removeWatchedProperties

Removes the watched properties with aliases matching the values passed into the method from the watchedProperties property.

SYNTAX

myCommitter.removeWatchedProperties (['alias1',...,'aliasN']);

PARAMS

_watchedPropertyAliasesToRemove:_watchedPropertyAliasesToRemoveARR      // an array of strings where the elements are aliases that denote which property profiles should be deleted from the =watchedProperties= object

Removing watched properties from the watchedProperties object directly will not unwire any events that were added by the committer. Calling this method will.

IMPLEMENTATION INFO

this feature was introduced in this module

4.40. restoreInitial

IMPLEMENTATION INFO

this feature was introduced in this module

4.41. restorePrevious

IMPLEMENTATION INFO

this feature was introduced in this module

4.42. set

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

4.43. setInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.44. setNodeClipRect

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.45. setNodeInnerHtml

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.46. setNodeOpacity

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.47. setNodeProperties

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.48. setNodeStyle

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.49. setNodeValue

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.50. showNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.51. toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

4.52. unmet

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

4.53. unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

4.54. unwireNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.55. unwireNodeEventsByMatch

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.56. unwireUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.57. updateUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.58. valueOf

this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class)

IMPLEMENTATION INFO

4.59. whenever

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

4.60. wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Class, first introduced in Uize.Class)

4.61. wireNode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

4.62. wireUi

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5. State Properties

5.1. allClear

A read-only boolean, indicating whether or not all the watched properties are clear (i.e. set to '').

The value of this property is automatically managed by the Uize.Widget.Committer class and is updated as the values of the watched properties change.

NOTES

	this property is read-only
	the initial value is `false`

IMPLEMENTATION INFO

this feature was introduced in this module

5.2. allValid

A read-only boolean, indicating whether or not all the watched properties have valid values.

The value of this property is automatically managed by the Uize.Widget.Committer class and is updated as the values of the watched properties change. The value is determined by the current values of the watched properties - regardless of whether or not those values are committed yet.

NOTES

	this property is read-only
	the initial value is `false`

IMPLEMENTATION INFO

this feature was introduced in this module

5.3. anyNotCommitted

A read-only boolean, indicating whether or not the values of any of the watched properties have been changed from their previous state and have not yet been committed.

The value of this property is automatically managed by the Uize.Widget.Committer class and is updated as the values of the watched properties change. The value of this property is true whenever there is a difference between the values of the committedValues and uncommittedValues state properties.

NOTES

	this property is read-only
	the initial value is `false`

IMPLEMENTATION INFO

this feature was introduced in this module

5.4. anyNotInitial

A read-only boolean, indicating whether or not the values of any of the watched properties are not their initial value (as stored in the initialValues state property).

The value of this property is automatically managed by the Uize.Widget.Committer class and is updated as the values of the watched properties change.

NOTES

	this property is read-only
	see the related `initialValues` state property
	the initial value is `false`

IMPLEMENTATION INFO

this feature was introduced in this module

5.5. autoCommitDelay

An integer, specifying the amount of time (measured in milliseconds), after uncommited values become ready to commit (i.e. the value of readyToCommit becomes true) and are no longer being modified, before those uncommitted values are automaticlly committed.

When the value of this property is set to null, undefined, 0, or false, then the auto-commit feature will be disabled.

NOTES

the initial value is undefined

IMPLEMENTATION INFO

this feature was introduced in this module

5.6. built

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.7. busy

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.8. busyInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.9. busyParentTickle

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.10. children

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.11. committedValues

A read-only object, representing the committed values for all the watched properties.

The value of this property is automatically set whenever the value of the watchedProperties state property is changed. The committedValues object will contain a property for each watched property.

The value of this property is automatically managed by the Uize.Widget.Committer class and is updated as the uncommitted values of the watched properties (as stored in the uncommittedValues state property) are committed by calling the commit instance method or by the user clicking the commit button.

NOTES

	this property is read-only
	see the related `uncommittedValues` and `watchedProperties` state properties
	the initial value is `{}` (an empty object)

IMPLEMENTATION INFO

this feature was introduced in this module

5.12. container

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.13. enabled

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.14. enabledInherited

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.15. enabledParentTickle

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.16. html

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.17. idPrefix

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.18. idPrefixConstruction

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.19. ignoreDisabled

A boolean, specifying whether or not any disabled watchedProperties will be ignored.

When the value of this property is set to true, then the allClear, allValid, anyNotCommitted, anyNotInitial, and readyToCommit read-only set-get properties will not take into account any disabled watchedProperties in their calculation.

NOTES

	see also the `allClear`, `allValid`, `anyNotCommitted`, `anyNotInitial`, and `readyToCommit` set-get properties
	the initial value is `false`

IMPLEMENTATION INFO

this feature was introduced in this module

5.20. initialValues

A read-only object, representing the initial values for all the watched properties.

The value of this property is automatically set whenever the value of the watchedProperties state property is changed. The initialValues object will contain a property for each watched property.

NOTES

	see the related `committedValues` and `uncommittedValues` state properties
	the initial value is `{}` (an empty object)

IMPLEMENTATION INFO

this feature was introduced in this module

5.21. insertionMode

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.22. localized

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.23. name

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.24. nodeMap

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.25. parent

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

5.26. readyToCommit

A read-only boolean, indicating whether or not there are uncommitted values for watched properties that are ready to commit.

The value of this property is automatically managed by the Uize.Widget.Committer class and is updated as the values of the watched properties change. The value of this property will be true if there are any uncommitted values (i.e. anyNotCommitted is set to true) and the values of all watched properties are valid (i.e. allValid is set to true).

NOTES

	this property is read-only
	see the related `anyNotCommitted` and `allValid` state properties
	the initial value is `false`

IMPLEMENTATION INFO

this feature was introduced in this module

5.27. uncommittedValues

A read-only object, representing the current values of the watched properties.

The value of this property is automatically set whenever the value of the watchedProperties state property is changed. The uncommittedValues object will contain a property for each watched property.

The value of this property is automatically managed by the Uize.Widget.Committer class and is updated as the values of the watched properties change. The value of this property represents all the current values of the watched properties and may be identical to the values of the initialValues and committedValues state properties.

The value of this property will be identical to that of the initialValues state property immediately after the value of watchedProperties is set and before the values of the watched properties have been modified, or right after using the restoreInitial button to retore the values of the watched properties. Its value will be identical to that of the committedValues state property immediately after watchedProperties is set and before the values of the watched properties have been modified, or right after successfully using the commit button or commit instance method to commit the uncommited values.

NOTES

	this property is read-only
	see the related `committedValues` and `watchedProperties` state properties
	the initial value is `{}` (an empty object)

IMPLEMENTATION INFO

this feature was introduced in this module

5.28. watchedProperties

An object, specifying the properties that should be watched by the instance.

The value of the watchedProperties property should be an object of the form...

{
  watchedProperty1Alias:{
    instance:watchedProperty1Instance,
    name:'watchedProperty1Name'
  },
  ... ... ...
  ... ... ...
  ... ... ...
  watchedPropertyNAlias:{
    instance:watchedPropertyNInstance,
    name:'watchedPropertyNName'
  }
}

Each property of the watchedProperties object provides a profile for a watched property, where the property name is an alias for the watched property, and where the property value is an object identifying the property. The object identifying a watched property should contain an "instance" property, identifying the instance (of a Uize.Class subclass) to which the property belongs, and a "name" property, identifying the name of the state property to watch.

NOTES

	see the related `committedValues` and `uncommittedValues` state properties
	the initial value is `undefined`

IMPLEMENTATION INFO

this feature was introduced in this module

5.29. wired

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

6. Instance Properties

6.1. showConfirm

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

6.2. showInform

Inherited from Uize.Widget.

IMPLEMENTATION INFO

this is an inherited feature (implementation is in Uize.Widget, first introduced in Uize.Widget)

7. Static Methods

7.1. Uize.Widget.Committer.alphastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.2. Uize.Widget.Committer.declare

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.3. Uize.Widget.Committer.doMy

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.4. Uize.Widget.Committer.dualContextMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.5. Uize.Widget.Committer.dualContextProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.6. Uize.Widget.Committer.fire

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.7. Uize.Widget.Committer.get

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.8. Uize.Widget.Committer.getBlankImageUrl

Inherited from Uize.Widget.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Widget`, first introduced in `Uize.Widget`)
	this static feature is inherited by subclasses

7.9. Uize.Widget.Committer.instanceMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.10. Uize.Widget.Committer.instanceProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.11. Uize.Widget.Committer.mixins

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.12. Uize.Widget.Committer.omegastructor

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.13. Uize.Widget.Committer.set

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.14. Uize.Widget.Committer.singleton

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.15. Uize.Widget.Committer.spawn

Inherited from Uize.Widget.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Widget`, first introduced in `Uize.Widget`)
	this static feature is inherited by subclasses

7.16. Uize.Widget.Committer.stateProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.17. Uize.Widget.Committer.staticMethods

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.18. Uize.Widget.Committer.staticProperties

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.19. Uize.Widget.Committer.subclass

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.20. Uize.Widget.Committer.toggle

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.21. Uize.Widget.Committer.treeInheritedStateProperties

Inherited from Uize.Widget.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Widget`, first introduced in `Uize.Widget`)
	this static feature is inherited by subclasses

7.22. Uize.Widget.Committer.unwire

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

7.23. Uize.Widget.Committer.wire

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

8. Static Properties

8.1. Uize.Widget.Committer.busyParentTickle

Inherited from Uize.Widget.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Widget`, first introduced in `Uize.Widget`)
	this static feature is inherited by subclasses

8.2. Uize.Widget.Committer.enabledParentTickle

Inherited from Uize.Widget.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Widget`, first introduced in `Uize.Widget`)
	this static feature is inherited by subclasses

8.3. Uize.Widget.Committer.isWired

Inherited from Uize.Widget.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Widget`, first introduced in `Uize.Widget`)
	this static feature is inherited by subclasses

8.4. Uize.Widget.Committer.moduleName

IMPLEMENTATION INFO

	this is an override of an inherited feature (implementation is in this module, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

8.5. Uize.Widget.Committer.nonInheritableStatics

IMPLEMENTATION INFO

	this is an override of an inherited feature (implementation is in this module, first introduced in `Uize.Class`)
	this static feature is not inherited by subclasses

8.6. Uize.Widget.Committer.pathToResources

Inherited from Uize.Class.

IMPLEMENTATION INFO

	this is an inherited feature (implementation is in `Uize.Class`, first introduced in `Uize.Class`)
	this static feature is inherited by subclasses

8.7. Uize.Widget.Committer.undefined

IMPLEMENTATION INFO

	this is an override of an inherited feature (implementation is in this module, first introduced in `Uize.Widget`)
	this static feature is inherited by subclasses

UIZE JavaScript Framework

MODULES Uize.Widget.Committer

SEARCHEXAMPLESSOURCETO DODEPSTEST

1. Introduction

1.1. In a Nutshell

1.1.1. Watched Properties

1.1.2. Convenient Buttons

1.1.3. Auto-commit

1.1.4. Logical State Summary

1.2. Examples

1.3. Implementation Info

1.3.1. Features Introduced in This Module

1.3.2. Features Overridden in This Module

1.3.3. Features Inherited From Other Modules

1.3.4. Modules Directly Under This Namespace

1.3.5. Unit Tests

2. Child Widgets

2.1. clearAll

2.2. commit button

2.3. restoreInitial

2.4. restorePrevious

3. Instance Events

3.1. Commit

4. Instance Methods

4.1. addChild

4.2. addChildren

4.3. addWatchedProperties

4.4. ajax

4.5. buildHtml

4.6. callInherited

4.7. childHtml

4.8. childId

4.9. clearAll

4.10. commit

4.11. confirm

4.12. displayNode

4.13. fire

4.14. flushNodeCache

4.15. get

4.16. getContainer

4.17. getHtml

4.18. getInherited

4.19. getNode

4.20. getNodeStyle

4.21. getNodeValue

4.22. getProvider

4.23. globalizeNode

4.24. inform

4.25. injectNodeHtml

4.26. insertOrWireUi

4.27. insertUi

4.28. is

4.29. isMet

4.30. kill

4.31. localize

4.32. met

4.33. nodeId

4.34. onChange

4.35. once

4.36. removeChild

4.37. removeNode

4.38. removeUi

4.39. removeWatchedProperties

4.40. restoreInitial

4.41. restorePrevious

4.42. set

4.43. setInherited

4.44. setNodeClipRect

4.45. setNodeInnerHtml

4.46. setNodeOpacity

4.47. setNodeProperties

4.48. setNodeStyle

4.49. setNodeValue

4.50. showNode

4.51. toggle

4.52. unmet

4.53. unwire

4.54. unwireNode

4.55. unwireNodeEventsByMatch

4.56. unwireUi

SEARCH EXAMPLES SOURCE TO DO DEPS TEST