Packagecom.flexicious.grids.events
Classpublic class PreferencePersistenceEvent
InheritancePreferencePersistenceEvent Inheritance flash.events.Event

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.


Public Properties
 PropertyDefined By
  customData : String
If you want to save any custom data into the preferences string, populate this property in the savePreferences event.
PreferencePersistenceEvent
  isDefault : Boolean
Whether the preference to add is the default.
PreferencePersistenceEvent
  preferenceKey : String
key that uniquely identifies the grid whose preference data needs to be persisted on the server
PreferencePersistenceEvent
  preferenceName : String
Name of the preference to persist.
PreferencePersistenceEvent
  preferenceXml : String
n xml string that contains all the preference data for this grid.
PreferencePersistenceEvent
Public Methods
 MethodDefined By
  
PreferencePersistenceEvent(type:String, preferenceKey:String, preferenceXml:String, bubbles:Boolean = false, cancelable:Boolean = true)
Constructor.
PreferencePersistenceEvent
Public Constants
 ConstantDefined By
  CLEAR_PREFERENCES : String = clearPreferences
[static]
PreferencePersistenceEvent
  LOAD_PREFERENCES : String = loadPreferences
[static]
PreferencePersistenceEvent
  PERSIST_PREFERENCES : String = persistPreferences
[static]
PreferencePersistenceEvent
  PREFERENCES_LOADING : String = preferencesLoading
[static]
PreferencePersistenceEvent
Property Detail
customDataproperty
public var customData:String

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)

isDefaultproperty 
public var isDefault:Boolean

Whether the preference to add is the default. Added in 2.9 to support multiple preferences

preferenceKeyproperty 
public var preferenceKey:String

key that uniquely identifies the grid whose preference data needs to be persisted on the server

preferenceNameproperty 
public var preferenceName:String

Name of the preference to persist. Added in 2.9 to support multiple preferences

preferenceXmlproperty 
public var preferenceXml:String

n xml string that contains all the preference data for this grid.

Constructor Detail
PreferencePersistenceEvent()Constructor
public function PreferencePersistenceEvent(type:String, preferenceKey:String, preferenceXml:String, bubbles:Boolean = false, cancelable:Boolean = true)

Constructor.

Parameters
type:String — The event type; indicates the action that caused the event.
 
preferenceKey:String — Specifies whether the event can bubble up the display list hierarchy.
 
preferenceXml:String — Specifies whether the behavior associated with the event can be prevented.
 
bubbles:Boolean (default = false)
 
cancelable:Boolean (default = true)
Constant Detail
CLEAR_PREFERENCESConstant
public static const CLEAR_PREFERENCES:String = clearPreferences

LOAD_PREFERENCESConstant 
public static const LOAD_PREFERENCES:String = loadPreferences

PERSIST_PREFERENCESConstant 
public static const PERSIST_PREFERENCES:String = persistPreferences

PREFERENCES_LOADINGConstant 
public static const PREFERENCES_LOADING:String = preferencesLoading




Copyright 2012 Flexicious LLC. All rights reserved.

Mon Jun 24 2013, 11:00 PM -04:00