WillChange
pentaho.type.events. WillChange
This event is emitted when changes will occur in complex or list values.
The listeners of will:change are allowed to:
- cancel the event
- modify the changeset
Extends
Mixes In
Constructor
| Name | Description |
|---|---|
| new WillChange(source, changeset) | Creates a |
Members
| Name | Description |
|---|---|
cancelReason : | Gets the reason why the event was canceled, if any, or |
changeset : | Gets the object that describes the set of changes. |
isCancelable : | Gets a value that indicates if the event can be canceled. |
isCanceled : | Gets a value that indicates if the event has been canceled. |
source : | Gets the source of the event. |
type : | Gets the type of the event. |
Methods
| Name | Description |
|---|---|
| _initChangeset(changeset) Protected | Initializes the mixin. |
| cancel(reason) | Cancels the event. |
clone() : pentaho.lang.Event | Creates a clone of the event object. |
Constructor Details
| new WillChange(source, changeset) | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| Creates a Source: javascript/web/pentaho/type/events/WillChange.js, line 22
|
Members Details
cancelReason: |
|---|
| Gets the reason why the event was canceled, if any, or Source: javascript/web/pentaho/lang/Event.js, line 116 Inherited From: pentaho.lang.Event#cancelReason |
changeset: |
|---|
| Gets the object that describes the set of changes. Source: javascript/web/pentaho/type/mixins/_mixinChangeset.js, line 46 |
isCancelable: |
|---|
| Gets a value that indicates if the event can be canceled. Source: javascript/web/pentaho/lang/Event.js, line 106 Inherited From: pentaho.lang.Event#isCancelable |
isCanceled: |
|---|
| Gets a value that indicates if the event has been canceled. Source: javascript/web/pentaho/lang/Event.js, line 152 Inherited From: pentaho.lang.Event#isCanceled |
source: |
|---|
| Gets the source of the event. Source: javascript/web/pentaho/lang/Event.js, line 96 Inherited From: pentaho.lang.Event#source |
type: |
|---|
| Gets the type of the event. Source: javascript/web/pentaho/lang/Event.js, line 86 Inherited From: pentaho.lang.Event#type |
Methods Details
| _initChangeset(changeset) Protected | ||
|---|---|---|
| Initializes the mixin. Source: javascript/web/pentaho/type/mixins/_mixinChangeset.js, line 35 |
| Name | Default Value | Summary |
|---|---|---|
changeset : pentaho.type.changes.Changeset | An object that describes a set of changes. |
| cancel(reason) | ||||||
|---|---|---|---|---|---|---|
| Cancels the event. This method has no effect if the event is not cancelable or has already been canceled. Source: javascript/web/pentaho/lang/Event.js, line 131 Inherited From: pentaho.lang.Event#cancel
See also: pentaho.lang.Event#isCancelable , pentaho.lang.Event#isCanceled , pentaho.lang.Event#cancelReason |
clone() : pentaho.lang.Event | ||||
|---|---|---|---|---|
| Creates a clone of the event object. Source: javascript/web/pentaho/lang/Event.js, line 161 Inherited From: pentaho.lang.Event#clone
|