Home Reference Source 
import UserSettingsOptions from 'flexicious-react-datagrid/js/flexgrid/persistence/UserSettingsOptions.js'
public class | source

UserSettingsOptions

Extends:

TypedObject → UserSettingsOptions

Class responsible for storing information about the user preference persistence settings

Static Method Summary

Static Public Methods
public static

create(grid: *): *

Returns an options object for this grid.

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

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

The delimiter that separates two preferences from each other
public

The delimiter that separates the properties of the GridPreferencesInfo object
public

The delimiter that separates the properties of the PreferenceInfo object
public

openSettingsPopupRenderer: flexiciousNmsp.ClassFactory

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

The IPersistable being persisted
public

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

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

The delimiter that separates the IPersistables data from custom data
public

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

saveSettingsPopupRenderer: flexiciousNmsp.ClassFactory

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

settingsPopupRenderer: flexiciousNmsp.ClassFactory

Class responsible for showing the UI that prompts the user to display the preferences
public

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?
public

If there is an error during parse preferences, dont apply preferences, and fail silently.
public
  • 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.
public

If set to true, will mark the columns that have column width mode = fitToContent as fixed when preferences are applied.

Method Summary

Public Methods
public
public

Quick accessor for persistable grid

Inherited Summary

From class TypedObject
public

typeCache: {}

public
public

Returns a list of strings that represent the object hierarchy for this object.
public

Returns true if the class name to check is in the list of class names defined for this class.

Static Public Methods

public static create(grid: *): * source

Returns an options object for this grid.

Params:

NameTypeAttributeDescription
grid *

Return:

*

Public Constructors

public constructor() source

Override:

TypedObject#constructor

Public Members

public allowClearOnCorruption: Boolean source

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

Properties:

NameTypeAttributeDescription
allowClearOnCorruption *

public multiPrefDelimiter: String source

The delimiter that separates two preferences from each other

Properties:

NameTypeAttributeDescription
multiPrefDelimiter *

public multiPrefGridPrefPropDelimiter: String source

The delimiter that separates the properties of the GridPreferencesInfo object

Properties:

NameTypeAttributeDescription
multiPrefGridPrefPropDelimiter *

public multiPrefPrefPropDelimiter: String source

The delimiter that separates the properties of the PreferenceInfo object

Properties:

NameTypeAttributeDescription
multiPrefPrefPropDelimiter *

public openSettingsPopupRenderer: flexiciousNmsp.ClassFactory source

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

Properties:

NameTypeAttributeDescription
openSettingsPopupRenderer *

public persistable: null source

The IPersistable being persisted

Properties:

NameTypeAttributeDescription
persistable *

public prefColDelimiter: String source

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

Properties:

NameTypeAttributeDescription
prefColDelimiter *

public prefColPrefDelimiter: String source

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

Properties:

NameTypeAttributeDescription
prefColPrefDelimiter *

public prefCustomDataDelimiter: String source

The delimiter that separates the IPersistables data from custom data

Properties:

NameTypeAttributeDescription
prefCustomDataDelimiter *

public prefDelimiter: String source

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

Properties:

NameTypeAttributeDescription
prefDelimiter *

public saveSettingsPopupRenderer: flexiciousNmsp.ClassFactory source

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

Properties:

NameTypeAttributeDescription
saveSettingsPopupRenderer *

public settingsPopupRenderer: flexiciousNmsp.ClassFactory source

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

Properties:

NameTypeAttributeDescription
settingsPopupRenderer *

public showErrorMessageWhenCorrupt: String source

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?

Properties:

NameTypeAttributeDescription
showErrorMessageWhenCorrupt *

public silentFailure: Boolean source

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

Properties:

NameTypeAttributeDescription
silentFailure *

public useCompactPreferences: Boolean source

  • 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

Properties:

NameTypeAttributeDescription
useCompactPreferences *

public userWidthsOverrideFitToContent: Boolean source

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.

Properties:

NameTypeAttributeDescription
userWidthsOverrideFitToContent *

Public Methods

public getClassNames(): Array source

Returns a list of strings that represent the object hierarchy for this object.

Override:

TypedObject#getClassNames

Return:

Array

public getGrid(): null source

Quick accessor for persistable grid

Return:

null