| Package | com.flexicious.persistence |
| Class | public class GridPreferencesInfo |
| Inheritance | GridPreferencesInfo  Object |
| Implements | flash.events.IEventDispatcher |
| Property | Defined By | ||
|---|---|---|---|
| defaultPreferenceName : String
Name of the default preference
| GridPreferencesInfo | ||
| loadDefaultPreferenceOnCreationComplete : Boolean
Flag that tells the grid to load the default preferences on creation complete
| GridPreferencesInfo | ||
| savedPreferences : Array
List of saved preferences. | GridPreferencesInfo | ||
| Method | Defined By | ||
|---|---|---|---|
| GridPreferencesInfo | |||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void | GridPreferencesInfo | ||
dispatchEvent(event:Event):Boolean | GridPreferencesInfo | ||
Converts a string resut of toPreferenceString to a GridPreferencesInfo object
| GridPreferencesInfo | ||
hasEventListener(type:String):Boolean | GridPreferencesInfo | ||
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void | GridPreferencesInfo | ||
toPreferenceString(uso:UserSettingsOptions):String
A function that converts the current preference object into a string. | GridPreferencesInfo | ||
willTrigger(type:String):Boolean | GridPreferencesInfo | ||
| defaultPreferenceName | property |
defaultPreferenceName:StringName of the default preference
The default value is Default.
This property can be used as the source for data binding.
public function get defaultPreferenceName():String public function set defaultPreferenceName(value:String):void| loadDefaultPreferenceOnCreationComplete | property |
loadDefaultPreferenceOnCreationComplete:BooleanFlag that tells the grid to load the default preferences on creation complete
The default value is true.
This property can be used as the source for data binding.
public function get loadDefaultPreferenceOnCreationComplete():Boolean public function set loadDefaultPreferenceOnCreationComplete(value:Boolean):void| savedPreferences | property |
savedPreferences:ArrayList of saved preferences.
This property can be used as the source for data binding.
public function get savedPreferences():Array public function set savedPreferences(value:Array):void| GridPreferencesInfo | () | Constructor |
public function GridPreferencesInfo()| addEventListener | () | method |
public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void
Parameters
type:String | |
listener:Function | |
useCapture:Boolean (default = false) | |
priority:int (default = 0) | |
weakRef:Boolean (default = false) |
| dispatchEvent | () | method |
public function dispatchEvent(event:Event):Boolean
Parameters
event:Event |
Boolean |
| fromPreferenceString | () | method |
public function fromPreferenceString(uso:UserSettingsOptions, str:String):GridPreferencesInfoConverts a string resut of toPreferenceString to a GridPreferencesInfo object
Parameters
uso:UserSettingsOptions | |
str:String |
GridPreferencesInfo |
| hasEventListener | () | method |
public function hasEventListener(type:String):Boolean
Parameters
type:String |
Boolean |
| removeEventListener | () | method |
public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Parameters
type:String | |
listener:Function | |
useCapture:Boolean (default = false) |
| toPreferenceString | () | method |
public function toPreferenceString(uso:UserSettingsOptions):StringA function that converts the current preference object into a string.
Parameters
uso:UserSettingsOptions |
String —
|
| willTrigger | () | method |
public function willTrigger(type:String):Boolean
Parameters
type:String |
Boolean |