@serenity-is/sleekgrid / GlobalEditorLock
Class: GlobalEditorLock
A global singleton editor lock. GlobalEditorLock
Static
Table of contents
Methods
Methods
activate
▸ activate(editController): void
Sets the specified edit controller as the active edit controller (acquire edit lock). If another edit controller is already active, and exception will be thrown.
Parameters
| Name | Type | Description |
|---|---|---|
editController |
EditController |
edit controller acquiring the lock |
Returns
void
Method
activate
Defined in
cancelCurrentEdit
▸ cancelCurrentEdit(): boolean
Attempts to cancel the current edit by calling "cancelCurrentEdit" method on the active edit controller and returns whether the edit was successfully cancelled. If no edit controller is active, returns true.
Returns
boolean
Method
cancelCurrentEdit
Defined in
commitCurrentEdit
▸ commitCurrentEdit(): boolean
Attempts to commit the current edit by calling "commitCurrentEdit" method on the active edit controller and returns whether the commit attempt was successful (commit may fail due to validation errors, etc.). Edit controller's "commitCurrentEdit" must return true if the commit has succeeded and false otherwise. If no edit controller is active, returns true.
Returns
boolean
Method
commitCurrentEdit
Defined in
deactivate
▸ deactivate(editController): void
Unsets the specified edit controller as the active edit controller (release edit lock). If the specified edit controller is not the active one, an exception will be thrown.
Parameters
| Name | Type | Description |
|---|---|---|
editController |
EditController |
edit controller releasing the lock |
Returns
void
Method
deactivate
Defined in
isActive
▸ isActive(editController?): boolean
Returns true if a specified edit controller is active (has the edit lock). If the parameter is not specified, returns true if any edit controller is active.
Parameters
| Name | Type | Description |
|---|---|---|
editController? |
EditController |
Returns
boolean
Method
isActive