SCUserDefaultsDefinition Class Reference
Inherits from | SCDictionaryDefinition : SCDataDefinition : NSObject |
Declared in | SCUserDefaultsDefinition.h |
Overview
This class functions as a means to define NSUserDefaults fields that the framework can automatically generate a user interface for. As with all other types of binding, once the UI is generated, the framework will also be responsible for automatically reading and writing the values to NSUserDefaults.
Sample use:
// Create the user defaults definition
SCUserDefaultsDefinition *userDefaultsDef = [SCUserDefaultsDefinition definitionWithUserDefaultsKeyNamesString:
@"Login Details:(username,password):Will be automatically signed in"];
SCPropertyDefinition *passwordDef = [userDefaultsDef propertyDefinitionWithName:@"password"];
passwordDef.attributes = [SCTextFieldAttributes attributesWithPlaceholder:nil secureTextEntry:YES
autocorrectionType:UITextAutocorrectionTypeNo autocapitalizationType:UITextAutocapitalizationTypeNone];
// Generate the UI for the user defaults
[self.tableViewModel generateSectionsForUserDefaultsDefinition:userDefaultsDef];
Tasks
-
+ definitionWithUserDefaultsKeyNamesString:
Allocates and returns an initialized ‘SCUserDefaultsDefinition’ given the key names string of the user defaults.
-
+ definitionWithUserDefaultsKeyNames:
Allocates and returns an initialized ‘SCUserDefaultsDefinition’ given the key names of the user defaults.
-
+ definitionWithUserDefaultsKeyNames:keyTitles:
Allocates and returns an initialized ‘SCUserDefaultsDefinition’ given the key names of the user defaults and their titles.
-
– initWithUserDefaultsKeyNamesString:
Returns an initialized ‘SCUserDefaultsDefinition’ given the key names string of the user defaults.
-
– initWithUserDefaultsKeyNames:
Returns an initialized ‘SCUserDefaultsDefinition’ given the key names of the user defaults.
-
– initWithUserDefaultsKeyNames:keyTitles:
Returns an initialized ‘SCUserDefaultsDefinition’ given the key names of the user defaults and their titles.
Class Methods
definitionWithUserDefaultsKeyNames:
Allocates and returns an initialized ‘SCUserDefaultsDefinition’ given the key names of the user defaults.
+ (id)definitionWithUserDefaultsKeyNames:(NSArray *)keyNames
Parameters
- keyNames
An array of the user defaults key names. All array elements must be of type NSString.
Discussion
By default, all property definitions generated for the given keyNames will have a type of SCPropertyTypeTextField. This can be fully customized after initialization.
Declared In
SCUserDefaultsDefinition.h
definitionWithUserDefaultsKeyNames:keyTitles:
Allocates and returns an initialized ‘SCUserDefaultsDefinition’ given the key names of the user defaults and their titles.
+ (id)definitionWithUserDefaultsKeyNames:(NSArray *)keyNames keyTitles:(NSArray *)keyTitles
Parameters
- keyNames
An array of the user defaults key names. All array elements must be of type NSString.
- keyTitles
An array of titles to the keys in keyNames. All array elements must be of type NSString.
Discussion
By default, all property definitions generated for the given keyNames will have a type of SCPropertyTypeTextField. This can be fully customized after initialization.
Declared In
SCUserDefaultsDefinition.h
definitionWithUserDefaultsKeyNamesString:
Allocates and returns an initialized ‘SCUserDefaultsDefinition’ given the key names string of the user defaults.
+ (id)definitionWithUserDefaultsKeyNamesString:(NSString *)keyNamesString
Parameters
- keyNamesString
A string with the key names separated by semi-colons. Example string: @“firstName;lastName”. Property groups can also be defined in the string using the following format: @“Personal Details:(firstName, lastName); Address:(street, state, country)”. The group title can also be ommitted to create a group with no title. For example: @“:(firstName, lastName)”.
Key names string syntax options:
@"key1;key2;key3;..." @"group1 header:(key1, key2,...):group1 footer;group2..."
Discussion
By default, all property definitions generated for the given keyNames will have a type of SCPropertyTypeTextField. This can be fully customized after initialization.
Declared In
SCUserDefaultsDefinition.h
Instance Methods
initWithUserDefaultsKeyNames:
Returns an initialized ‘SCUserDefaultsDefinition’ given the key names of the user defaults.
- (id)initWithUserDefaultsKeyNames:(NSArray *)keyNames
Parameters
- keyNames
An array of the user defaults key names. All array elements must be of type NSString.
Discussion
By default, all property definitions generated for the given keyNames will have a type of SCPropertyTypeTextField. This can be fully customized after initialization.
Declared In
SCUserDefaultsDefinition.h
initWithUserDefaultsKeyNames:keyTitles:
Returns an initialized ‘SCUserDefaultsDefinition’ given the key names of the user defaults and their titles.
- (id)initWithUserDefaultsKeyNames:(NSArray *)keyNames keyTitles:(NSArray *)keyTitles
Parameters
- keyNames
An array of the user defaults key names. All array elements must be of type NSString.
- keyTitles
An array of titles to the keys in keyNames. All array elements must be of type NSString.
Discussion
By default, all property definitions generated for the given keyNames will have a type of SCPropertyTypeTextField. This can be fully customized after initialization.
Declared In
SCUserDefaultsDefinition.h
initWithUserDefaultsKeyNamesString:
Returns an initialized ‘SCUserDefaultsDefinition’ given the key names string of the user defaults.
- (id)initWithUserDefaultsKeyNamesString:(NSString *)keyNamesString
Parameters
- keyNamesString
A string with the key names separated by semi-colons. Example string: @“firstName;lastName”. Property groups can also be defined in the string using the following format: @“Personal Details:(firstName, lastName); Address:(street, state, country)”. The group title can also be ommitted to create a group with no title. For example: @“:(firstName, lastName)”.
Key names string syntax options:
@"key1;key2;key3;..." @"group1 header:(key1, key2,...):group1 footer;group2..."
Discussion
By default, all property definitions generated for the given keyNames will have a type of SCPropertyTypeTextField. This can be fully customized after initialization.
Declared In
SCUserDefaultsDefinition.h