Packagecom.flexicious.persistence
Classpublic class UserSettingsController
InheritanceUserSettingsController Inheritance Object
Subclasses DashboardUserSettingsController

Class responsible for preference persistence.



Public Methods
 MethodDefined By
  
UserSettingsController
  
clearPreferences(userSettingsOptions:UserSettingsOptions):void
Clears preferences
UserSettingsController
  
getPreferencesString(userSettingsOptions:UserSettingsOptions):String
Gets the preferences string for the supplied grid
UserSettingsController
  
[static]
UserSettingsController
  
loadPreferences(userSettingsOptions:UserSettingsOptions):void
Loads preferences
UserSettingsController
  
parsePreferences(userSettingsOptions:UserSettingsOptions, val:String):ArrayCollection
UserSettingsController
  
persistPreferences(userSettingsOptions:UserSettingsOptions, name:String = Default, isDefault:Boolean = false):void
Saves the preferences
UserSettingsController
  
setPreferences(userSettingsOptions:UserSettingsOptions, arrayCollection:ArrayCollection):void
Applies previously set preferences..
UserSettingsController
Protected Methods
 MethodDefined By
  
getColumnOrder(userSettingsOptions:UserSettingsOptions):ArrayCollection
Gets the order of columns
UserSettingsController
  
getColumnVisibility(userSettingsOptions:UserSettingsOptions):ArrayCollection
Gets the visibility of the columns
UserSettingsController
  
getColumnWidths(userSettingsOptions:UserSettingsOptions):ArrayCollection
Gets the widths of the columns
UserSettingsController
  
UserSettingsController
  
getLegacyPreferences(userSettingsOptions:UserSettingsOptions):ArrayCollection
UserSettingsController
  
UserSettingsController
  
getSharedObject(key:String):SharedObject
Gets the shared object by key.
UserSettingsController
  
parseCompactPreferencesString(userSettingsOptions:UserSettingsOptions, val:String):ArrayCollection
UserSettingsController
  
setColumnOrder(userSettingsOptions:UserSettingsOptions, val:ArrayCollection):void
Sets the order of columns
UserSettingsController
  
setColumnVisibility(userSettingsOptions:UserSettingsOptions, val:ArrayCollection):void
Sets the visibility of the columns
UserSettingsController
  
setColumnWidths(userSettingsOptions:UserSettingsOptions, val:ArrayCollection):void
Sets the widths of the columns
UserSettingsController
Constructor Detail
UserSettingsController()Constructor
public function UserSettingsController()



Method Detail
clearPreferences()method
public function clearPreferences(userSettingsOptions:UserSettingsOptions):void

Clears preferences

Parameters

userSettingsOptions:UserSettingsOptions

getColumnOrder()method 
protected function getColumnOrder(userSettingsOptions:UserSettingsOptions):ArrayCollection

Gets the order of columns

Parameters

userSettingsOptions:UserSettingsOptions

Returns
ArrayCollection
getColumnVisibility()method 
protected function getColumnVisibility(userSettingsOptions:UserSettingsOptions):ArrayCollection

Gets the visibility of the columns

Parameters

userSettingsOptions:UserSettingsOptions

Returns
ArrayCollection
getColumnWidths()method 
protected function getColumnWidths(userSettingsOptions:UserSettingsOptions):ArrayCollection

Gets the widths of the columns

Parameters

userSettingsOptions:UserSettingsOptions

Returns
ArrayCollection
getCompactPreferencesString()method 
protected function getCompactPreferencesString(userSettingsOptions:UserSettingsOptions):String

Parameters

userSettingsOptions:UserSettingsOptions

Returns
String
getLegacyPreferences()method 
protected function getLegacyPreferences(userSettingsOptions:UserSettingsOptions):ArrayCollection

Parameters

userSettingsOptions:UserSettingsOptions

Returns
ArrayCollection
getLegacyPreferencesString()method 
protected function getLegacyPreferencesString(userSettingsOptions:UserSettingsOptions):String

Parameters

userSettingsOptions:UserSettingsOptions

Returns
String
getPreferencesString()method 
public function getPreferencesString(userSettingsOptions:UserSettingsOptions):String

Gets the preferences string for the supplied grid

Parameters

userSettingsOptions:UserSettingsOptions

Returns
String
getSharedObject()method 
protected function getSharedObject(key:String):SharedObject

Gets the shared object by key.

Parameters

key:String

Returns
SharedObject
instance()method 
public static function instance():UserSettingsController

Returns
UserSettingsController
loadPreferences()method 
public function loadPreferences(userSettingsOptions:UserSettingsOptions):void

Loads preferences

Parameters

userSettingsOptions:UserSettingsOptions

parseCompactPreferencesString()method 
protected function parseCompactPreferencesString(userSettingsOptions:UserSettingsOptions, val:String):ArrayCollection

Parameters

userSettingsOptions:UserSettingsOptions
 
val:String

Returns
ArrayCollection
parsePreferences()method 
public function parsePreferences(userSettingsOptions:UserSettingsOptions, val:String):ArrayCollection

Parameters

userSettingsOptions:UserSettingsOptions
 
val:String

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

Saves the preferences

Parameters

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

setColumnOrder()method 
protected function setColumnOrder(userSettingsOptions:UserSettingsOptions, val:ArrayCollection):void

Sets the order of columns

Parameters

userSettingsOptions:UserSettingsOptions
 
val:ArrayCollection

setColumnVisibility()method 
protected function setColumnVisibility(userSettingsOptions:UserSettingsOptions, val:ArrayCollection):void

Sets the visibility of the columns

Parameters

userSettingsOptions:UserSettingsOptions
 
val:ArrayCollection

setColumnWidths()method 
protected function setColumnWidths(userSettingsOptions:UserSettingsOptions, val:ArrayCollection):void

Sets the widths of the columns

Parameters

userSettingsOptions:UserSettingsOptions
 
val:ArrayCollection

setPreferences()method 
public function setPreferences(userSettingsOptions:UserSettingsOptions, arrayCollection:ArrayCollection):void

Applies previously set preferences..

Parameters

userSettingsOptions:UserSettingsOptions
 
arrayCollection:ArrayCollection