Packagecom.flexicious.grids.dependencies
Interfacepublic interface IPersistable extends flash.events.IEventDispatcher, mx.core.IUIComponent
Implementors DashboardContainer

An object that can persist it's state into a serializable string and can load itself back from that serializable string.


Public Properties
 PropertyDefined By
  enableMultiplePreferences : Boolean
[read-only]
IPersistable
  enablePreferencePersistence : Boolean
[read-only]
IPersistable
  lastPrintOptionsString : String
IPersistable
  persistedPrintOptionsString : String
IPersistable
  preferencePersistenceKey : String
[read-only]
IPersistable
  preferencePersistenceMode : String
[read-only]
IPersistable
  preferences : String
IPersistable
  preferencesSet : Boolean
IPersistable
  preferencesToPersist : String
IPersistable
  useCompactPreferences : Boolean
[read-only]
IPersistable
  userSettingsOptionsFunction : Function
[read-only]
IPersistable
Public Methods
 MethodDefined By
  
clearPreferences():void
IPersistable
  
getAutoLoadPreferences():Boolean
By default, when the grid's creation complete event is dispatched, the grid will go in and load the saved preference.
IPersistable
  
getCurrentPreferenceInfo():PreferenceInfo
IPersistable
  
getGridPreferencesInfo():GridPreferencesInfo
IPersistable
  
loadPreferences():void
IPersistable
  
persistPreferences(name:String = Default, isDefault:Boolean = false):void
IPersistable
  
setCurrentPreferenceInfo(val:PreferenceInfo, apply:Boolean = true):void
IPersistable
  
setGridPreferencesInfo(val:GridPreferencesInfo, apply:Boolean = true):void
IPersistable
Property Detail
enableMultiplePreferencesproperty
enableMultiplePreferences:Boolean  [read-only]


Implementation
    public function get enableMultiplePreferences():Boolean
enablePreferencePersistenceproperty 
enablePreferencePersistence:Boolean  [read-only]

This property can be used as the source for data binding.


Implementation
    public function get enablePreferencePersistence():Boolean
lastPrintOptionsStringproperty 
lastPrintOptionsString:String


Implementation
    public function get lastPrintOptionsString():String
    public function set lastPrintOptionsString(value:String):void
persistedPrintOptionsStringproperty 
persistedPrintOptionsString:String


Implementation
    public function get persistedPrintOptionsString():String
    public function set persistedPrintOptionsString(value:String):void
preferencePersistenceKeyproperty 
preferencePersistenceKey:String  [read-only]


Implementation
    public function get preferencePersistenceKey():String
preferencePersistenceModeproperty 
preferencePersistenceMode:String  [read-only]


Implementation
    public function get preferencePersistenceMode():String
preferencesproperty 
preferences:String


Implementation
    public function get preferences():String
    public function set preferences(value:String):void
preferencesSetproperty 
preferencesSet:Boolean


Implementation
    public function get preferencesSet():Boolean
    public function set preferencesSet(value:Boolean):void
preferencesToPersistproperty 
preferencesToPersist:String


Implementation
    public function get preferencesToPersist():String
    public function set preferencesToPersist(value:String):void
useCompactPreferencesproperty 
useCompactPreferences:Boolean  [read-only]


Implementation
    public function get useCompactPreferences():Boolean
userSettingsOptionsFunctionproperty 
userSettingsOptionsFunction:Function  [read-only]


Implementation
    public function get userSettingsOptionsFunction():Function
Method Detail
clearPreferences()method
public function clearPreferences():void

getAutoLoadPreferences()method 
public function getAutoLoadPreferences():Boolean

By default, when the grid's creation complete event is dispatched, the grid will go in and load the saved preference. This works well in most cases, but in some cases, where the data needed to build selection comboboxes (for filters) is built from the dataprovider, it makes sense to wait until the dataprovider is loaded to parse and set the preferences, otherwise the grid will end up ignoring saved preferences for filters that have dropdown based UI. In this case set autoLoadPreferences to true, and manually call loadPreferences when the data is received from the server and the dataprovider is set. grid:FlexDataGrid autoLoadPreferences=”false” And then, when you set the dataprovider: dgReport.dataProvider=dp; if(!dgReport.preferencesLoaded){ dgReport.loadPreferences(); }

Returns
Boolean
getCurrentPreferenceInfo()method 
public function getCurrentPreferenceInfo():PreferenceInfo

Returns
PreferenceInfo
getGridPreferencesInfo()method 
public function getGridPreferencesInfo():GridPreferencesInfo

Returns
GridPreferencesInfo
loadPreferences()method 
public function loadPreferences():void

persistPreferences()method 
public function persistPreferences(name:String = Default, isDefault:Boolean = false):void

Parameters

name:String (default = Default)
 
isDefault:Boolean (default = false)

setCurrentPreferenceInfo()method 
public function setCurrentPreferenceInfo(val:PreferenceInfo, apply:Boolean = true):void

Parameters

val:PreferenceInfo
 
apply:Boolean (default = true)

setGridPreferencesInfo()method 
public function setGridPreferencesInfo(val:GridPreferencesInfo, apply:Boolean = true):void

Parameters

val:GridPreferencesInfo
 
apply:Boolean (default = true)




Copyright 2012 Flexicious LLC. All rights reserved.

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