com.flexicious.persistence.UserSettingsOptions

	Property	Defined By
		allowClearOnCorruption : Boolean [read-only] If for any reason, the preferences become corrupt, prompt the user to clear them as opposed to throwing an error?	UserSettingsOptions
		grid : IExtendedDataGrid [read-only] Quick accessor for persistable grid	UserSettingsOptions
		multiPrefDelimiter : String [read-only] The delimiter that separates two preferences from each other	UserSettingsOptions
		multiPrefGridPrefPropDelimiter : String [read-only] The delimiter that separates the properties of the GridPreferencesInfo object	UserSettingsOptions
		multiPrefPrefPropDelimiter : String [read-only] The delimiter that separates the properties of the PreferenceInfo object	UserSettingsOptions
		openSettingsPopupRenderer : IFactory [read-only] Class responsible for showing the UI that prompts the user to save or clear preferences	UserSettingsOptions
		persistable : IPersistable [read-only] The IPersistable being persisted	UserSettingsOptions
		persistLockModes : Boolean [read-only] Since the column header operations were added, user can change lock modes.	UserSettingsOptions
		prefColDelimiter : String [read-only] The delimiter that separates the string for two columns within a single preference	UserSettingsOptions
		prefColPrefDelimiter : String [read-only] The delimiter that separates the string for two preferences within columns within a single preference	UserSettingsOptions
		prefCustomDataDelimiter : String [read-only] The delimiter that separates the IPersistables data from custom data	UserSettingsOptions
		prefDelimiter : String [read-only] The delimiter that separates the string for two preferences, defaults to ~\|	UserSettingsOptions
		saveSettingsPopupRenderer : IFactory [read-only] Class responsible for showing the UI that prompts the user to save or clear preferences	UserSettingsOptions
		settingsPopupRenderer : IFactory [read-only] lass responsible for showing the UI that prompts the user to display the preferences	UserSettingsOptions
		showErrorMessageWhenCorrupt : String [read-only] If for any reason, the preferences become corrupt, prompt the user to clear them as opposed to throwing an error, and in the prompt, the error message to show?	UserSettingsOptions
		silentFailure : Boolean [read-only] If there is an error during parse preferences, dont apply preferences, and fail silently.	UserSettingsOptions
		useCompactPreferences : Boolean [read-only] If set to true, uses the newer preference persistence scheme introduced in Flexicious 2.0, which stores the preferences as custom string as opposed to XML, making it a lot less verbose.	UserSettingsOptions
		userWidthsOverrideFitToContent : Boolean [read-only] IF set to true, will mark the columns that have column width mode = fitToContent as fixed when preferences are applied.	UserSettingsOptions

	Method	Defined By
		UserSettingsOptions()	UserSettingsOptions
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, weakRef:Boolean = false):void	UserSettingsOptions
		create(grid:IPersistable):UserSettingsOptions [static] Returns an options object for this grid.	UserSettingsOptions
		dispatchEvent(event:Event):Boolean	UserSettingsOptions
		hasEventListener(type:String):Boolean	UserSettingsOptions
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void	UserSettingsOptions
		willTrigger(type:String):Boolean	UserSettingsOptions

Property Detail

allowClearOnCorruption

property

allowClearOnCorruption:Boolean [read-only]

If for any reason, the preferences become corrupt, prompt the user to clear them as opposed to throwing an error?

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

Implementation
public function get allowClearOnCorruption():Boolean

grid

property

grid:IExtendedDataGrid [read-only]

Quick accessor for persistable grid

Implementation
public function get grid():IExtendedDataGrid

multiPrefDelimiter

property

multiPrefDelimiter:String [read-only]

The delimiter that separates two preferences from each other

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

Implementation
public function get multiPrefDelimiter():String

multiPrefGridPrefPropDelimiter

property

multiPrefGridPrefPropDelimiter:String [read-only]

The delimiter that separates the properties of the GridPreferencesInfo object

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

Implementation
public function get multiPrefGridPrefPropDelimiter():String

multiPrefPrefPropDelimiter

property

multiPrefPrefPropDelimiter:String [read-only]

The delimiter that separates the properties of the PreferenceInfo object

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

Implementation
public function get multiPrefPrefPropDelimiter():String

openSettingsPopupRenderer

property

openSettingsPopupRenderer:IFactory [read-only]

Class responsible for showing the UI that prompts the user to save or clear preferences

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

Implementation
public function get openSettingsPopupRenderer():IFactory

persistable

property

persistable:IPersistable [read-only]

The IPersistable being persisted

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

Implementation
public function get persistable():IPersistable

persistLockModes

property

persistLockModes:Boolean [read-only]

Since the column header operations were added, user can change lock modes. Do we want to persist them? Only applies to Ultimate.

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

Implementation
public function get persistLockModes():Boolean

prefColDelimiter

property

prefColDelimiter:String [read-only]

The delimiter that separates the string for two columns within a single preference

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

Implementation
public function get prefColDelimiter():String

prefColPrefDelimiter

property

prefColPrefDelimiter:String [read-only]

The delimiter that separates the string for two preferences within columns within a single preference

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

Implementation
public function get prefColPrefDelimiter():String

prefCustomDataDelimiter

property

prefCustomDataDelimiter:String [read-only]

The delimiter that separates the IPersistables data from custom data

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

Implementation
public function get prefCustomDataDelimiter():String

prefDelimiter

property

prefDelimiter:String [read-only]

The delimiter that separates the string for two preferences, defaults to ~|

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

Implementation
public function get prefDelimiter():String

saveSettingsPopupRenderer

property

saveSettingsPopupRenderer:IFactory [read-only]

Class responsible for showing the UI that prompts the user to save or clear preferences

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

Implementation
public function get saveSettingsPopupRenderer():IFactory

settingsPopupRenderer

property

settingsPopupRenderer:IFactory [read-only]

lass responsible for showing the UI that prompts the user to display the preferences

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

Implementation
public function get settingsPopupRenderer():IFactory

showErrorMessageWhenCorrupt

property

showErrorMessageWhenCorrupt:String [read-only]

If for any reason, the preferences become corrupt, prompt the user to clear them as opposed to throwing an error, and in the prompt, the error message to show?

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

Implementation
public function get showErrorMessageWhenCorrupt():String

silentFailure

property

silentFailure:Boolean [read-only]

If there is an error during parse preferences, dont apply preferences, and fail silently.

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

Implementation
public function get silentFailure():Boolean

useCompactPreferences

property

useCompactPreferences:Boolean [read-only]

If set to true, uses the newer preference persistence scheme introduced in Flexicious 2.0, which stores the preferences as custom string as opposed to XML, making it a lot less verbose. For Ultimate, this is always true

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

Implementation
public function get useCompactPreferences():Boolean

userWidthsOverrideFitToContent

property

userWidthsOverrideFitToContent:Boolean [read-only]

IF set to true, will mark the columns that have column width mode = fitToContent as fixed when preferences are applied. This will cause them to no longer size according to their contents, but respect the width that the user set.

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

Implementation
public function get userWidthsOverrideFitToContent():Boolean

Constructor Detail

UserSettingsOptions

()

Constructor

public function UserSettingsOptions()

Method Detail

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`)

create

()

method

public static function create(grid:IPersistable):UserSettingsOptions

Returns an options object for this grid.

Parameters

grid:IPersistable

Returns

UserSettingsOptions

dispatchEvent

()

method

public function dispatchEvent(event:Event):Boolean

Parameters

event:Event

Returns

Boolean

hasEventListener

()

method

public function hasEventListener(type:String):Boolean

Parameters

type:String

Returns

Boolean

removeEventListener

()

method

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

Parameters

	`type:String`

	`listener:Function`

	`useCapture:Boolean` (default = `false`)

willTrigger

()

method

public function willTrigger(type:String):Boolean

Parameters

type:String

Returns

Boolean

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

Flexicious Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
UserSettingsOptions	Properties \| Methods

Package	com.flexicious.persistence
Class	public class UserSettingsOptions
Inheritance	UserSettingsOptions Object
Implements	flash.events.IEventDispatcher