import PreferencePersistenceEvent from 'flexicious-react-datagrid/js/flexgrid/events/PreferencePersistenceEvent.js'PreferencePersistenceEvent
Extends:
Dispatched when the grids' preferencePersistenceMode='server' and: 1) The Grid needs to retrieve the preference data from the server 2) The Grid needs to persist the preference data to the server 3) The Grid needs to clear out its preference data.
Constructor Summary
| Public Constructor | ||
| public |
constructor(type: *, preferenceKey: *, preferenceXml: *, bubbles: *, cancelable: *) |
|
Member Summary
| Public Members | ||
| public |
customData: * If you want to save any custom data into the preferences string, populate this property in the savePreferences event. |
|
| public |
isDefault: * Whether the preference to add is the default. |
|
| public |
A key that uniquely identifies the grid whose preference data needs to be persisted on the server |
|
| public |
Name of the preference to persist. |
|
| public |
An xml string that contains all the preference data for this grid. |
|
Method Summary
| Public Methods | ||
| public |
getClassNames(): string[] |
|
Inherited Summary
| From class TypedObject | ||
| public |
typeCache: {} |
|
| public |
|
|
| public |
Returns a list of strings that represent the object hierarchy for this object. |
|
| public |
implementsOrExtends(name: *): Boolean Returns true if the class name to check is in the list of class names defined for this class. |
|
| From class BaseEvent | ||
| public |
Ignored property |
|
| public |
Whether or not this event can be cancelled. |
|
| public |
Has the default for this event been prevented |
|
| public |
Type of this event. |
|
| public |
getClassNames(): string[] |
|
| public |
Has the default for this event been prevented. |
|
| public |
If this event is cancelable, then the default prevented flag is set to true. |
|
| public |
If this event is cancelable, then the default prevented flag is set to true. |
|
Public Constructors
public constructor(type: *, preferenceKey: *, preferenceXml: *, bubbles: *, cancelable: *) source
Override:
BaseEvent#constructorParams:
| Name | Type | Attribute | Description |
| type | * | ||
| preferenceKey | * | ||
| preferenceXml | * | ||
| bubbles | * | ||
| cancelable | * |
Public Members
public customData: * source
If you want to save any custom data into the preferences string, populate this property in the savePreferences event. (This event will be dispatched JUST before saving the preferences. And it will be available to you in the loadPreferences event. (This event is called right after the preferences are applied to the IPersistable)
Properties:
| Name | Type | Attribute | Description |
| customData | * |
public isDefault: * source
Whether the preference to add is the default. Added in 2.9 to support multiple preferences
Properties:
| Name | Type | Attribute | Description |
| isDefault | * |
public preferenceKey: * source
A key that uniquely identifies the grid whose preference data needs to be persisted on the server
Properties:
| Name | Type | Attribute | Description |
| preferenceKey | * |
public preferenceName: * source
Name of the preference to persist. Added in 2.9 to support multiple preferences
Properties:
| Name | Type | Attribute | Description |
| preferenceName | * |
public preferenceXml: * source
An xml string that contains all the preference data for this grid.
Properties:
| Name | Type | Attribute | Description |
| preferenceXml | * |
Public Methods
public getClassNames(): string[] source
Returns a list of strings that represent the object hierarchy for this object.