ChangedEvent$Typings extension
Properties
-
change
↔ EnumValue
-
Gets or sets the nature of change that occurred.
The default is ChangedEvent.Property.
Other values are ChangedEvent.Insert, ChangedEvent.Remove,
and ChangedEvent.Transaction.
getter/setter pair
-
diagram
↔ Diagram?
-
Gets or sets the Diagram that was modified.
When this property is non-null, the #model property will be null.
However this property and the #model property may both be null simultaneously,
when no particular model or diagram applies.
getter/setter pair
-
isTransactionFinished
↔ bool
-
This read-only property is true when this ChangedEvent is of type ChangedEvent.Transaction and represents the end of a transactional change.
It is implemented as:
getter/setter pair
-
model
↔ Model?
-
Gets or sets the Model or TreeModel or GraphLinksModel that was modified.
When this property is non-null, the #diagram property will be null.
However this property and the #diagram property may both be null simultaneously,
when no particular model or diagram applies.
getter/setter pair
-
modelChange
↔ String
-
Gets or sets the name of the model change, reflecting a change to
model data in addition to a change to the model itself.
getter/setter pair
-
newParam
↔ dynamic
-
Gets or sets an optional value associated with the new value.
Most properties do not require any parameter to describe the change.
This is typically a value that helps distinguish the new value, such as an index into an array.
It is null if it is not used.
The default is null.
getter/setter pair
-
newValue
↔ dynamic
-
Gets or sets the next or current value that the property has.
The default is null.
getter/setter pair
-
object
↔ Object?
-
Gets or sets the Object that was modified.
The default is null.
getter/setter pair
-
oldParam
↔ dynamic
-
Gets or sets an optional value associated with the old value.
Most properties do not require any parameter to describe the change.
This is typically a value that helps distinguish the old value, such as an index into an array.
It is null if it is not used.
The default is null.
getter/setter pair
-
oldValue
↔ dynamic
-
Gets or sets the previous or old value that the property had.
The default is null.
getter/setter pair
-
propertyName
↔ Object
-
Gets or sets the name of the property change.
The default is an empty string, which is not a valid property name.
This property can be useful even when the type of change is
not ChangedEvent.Property, because it can help identify
the collection in the #object that was modified
(for ChangedEvent.Insert or ChangedEvent.Remove)
or the stage of the current transaction (for ChangedEvent.Transaction).
getter/setter pair
Methods
-
canRedo()
→ bool
-
This predicate returns true if you can call redo().
@return {boolean} True if ready for redo() to be called.
-
canUndo()
→ bool
-
This predicate returns true if you can call undo().
@return {boolean} True if ready for undo() to be called.
-
clear()
→ void
-
Forget any object references that this ChangedEvent may have.
-
copy()
→ ChangedEvent
-
Make a copy of this ChangedEvent.
ChangedEvents are copied when the UndoManager adds to a Transaction.
@return {ChangedEvent}
-
getParam(bool undo)
→ dynamic
-
This is a convenient method to get the right parameter value, depending on the value of undo,
when implementing a state change as part of an undo or a redo.
@param {boolean} undo If true, returns the oldParam, otherwise returns the newParam.
@return {*} Either the oldParam or the newParam.
-
getValue(bool undo)
→ dynamic
-
This is a convenient method to get the right value, depending on the value of undo,
when implementing a state change as part of an undo or a redo.
@param {boolean} undo If true, returns the oldValue, otherwise returns the newValue.
@return {*} Either the oldValue or the newValue.
-
redo()
→ void
-
Re-perform this object change after an undo().
canRedo() must be true for this method to have any effect.
-
undo()
→ void
-
Reverse the effects of this object change.
canUndo() must be true for this method to have any effect.
