SCSelectionAttributes

@interface SCSelectionAttributes : SCPropertyAttributes {
  SCDataStore *selectionItemsStore;
  SCDataFetchOptions *selectionItemsFetchOptions;
  BOOL allowMultipleSelection;
  BOOL allowNoSelection;
  NSUInteger maximumSelections;
  BOOL autoDismissDetailView;
  BOOL hideDetailViewNavigationBar;
  BOOL allowAddingItems;
  BOOL allowDeletingItems;
  BOOL allowMovingItems;
  BOOL allowEditingItems;
  NSObject *placeholderuiElement;
  NSObject *addNewObjectuiElement;
}

This class is used to extend the definition of an ‘SCPropertyAttributes’ instance of type SCPropertyTypeSelection, thus allowing further customization of the generated control by the user.

Show on GitHub

Creation and Initialization

  • Allocates and returns an initialized ‘SCSelectionAttributes’. *

    • - parameter: _items The items of the generated selection control. Set to nil to ignore.
    • - parameter: allowMultipleSel Determines if the generated selection control allows multiple selection.
    • - parameter: allowNoSel Determines if the generated selection control allows no selection.

    Declaration

    Objective-C

    + (instancetype)attributesWithItems:(NSArray *)_items
             allowMultipleSelection:(BOOL)allowMultipleSel
                   allowNoSelection:(BOOL)allowNoSel;
    Show on GitHub

  • Allocates and returns an initialized ‘SCSelectionAttributes’. *

    • - parameter: _items The items of the generated selection control. Set to nil to ignore.
    • - parameter: allowMultipleSel Determines if the generated selection control allows multiple selection.
    • - parameter: allowNoSel Determines if the generated selection control allows no selection.
    • - parameter: autoDismiss Set to TRUE to automatically dismiss the selection detail view when an item is selected.
    • - parameter: hideNavBar Set to TRUE to hide the detail view’s navigation bar. - note: Only applicable if autoDismiss is TRUE.

    Declaration

    Objective-C

    + (instancetype)attributesWithItems:(NSArray *)_items
             allowMultipleSelection:(BOOL)allowMultipleSel
                   allowNoSelection:(BOOL)allowNoSel
              autoDismissDetailView:(BOOL)autoDismiss
        hideDetailViewNavigationBar:(BOOL)hideNavBar;
    Show on GitHub

  • Returns an initialized ‘SCSelectionAttributes’. *

    • - parameter: _items The items of the generated selection control. Set to nil to ignore.
    • - parameter: allowMultipleSel Determines if the generated selection control allows multiple selection.
    • - parameter: allowNoSel Determines if the generated selection control allows no selection.

    Declaration

    Objective-C

    - (instancetype)initWithItems:(NSArray *)_items
       allowMultipleSelection:(BOOL)allowMultipleSel
             allowNoSelection:(BOOL)allowNoSel;
    Show on GitHub

  • Returns an initialized ‘SCSelectionAttributes’. *

    • - parameter: _items The items of the generated selection control. Set to nil to ignore.
    • - parameter: allowMultipleSel Determines if the generated selection control allows multiple selection.
    • - parameter: allowNoSel Determines if the generated selection control allows no selection.
    • - parameter: autoDismiss Set to TRUE to automatically dismiss the selection detail view when an item is selected.
    • - parameter: hideNavBar Set to TRUE to hide the detail view’s navigation bar. - note: Only applicable if autoDismiss is TRUE.

    Declaration

    Objective-C

    - (instancetype)initWithItems:(NSArray *)_items
         allowMultipleSelection:(BOOL)allowMultipleSel
               allowNoSelection:(BOOL)allowNoSel
          autoDismissDetailView:(BOOL)autoDismiss
    hideDetailViewNavigationBar:(BOOL)hideNavBar;
    Show on GitHub

  • The data store for the selection items.

    Declaration

    Objective-C

    @property (nonatomic, strong) SCDataStore *selectionItemsStore;
    Show on GitHub

  • The fetch options for the selection items.

    Declaration

    Objective-C

    @property (nonatomic, strong) SCDataFetchOptions *selectionItemsFetchOptions;
    Show on GitHub

  • The items stored in selectionItemsStore.

    Declaration

    Objective-C

    @property (nonatomic, readonly) NSArray *items;
    Show on GitHub

  • Determines if the generated selection control allows multiple selection.

    Declaration

    Objective-C

    @property (nonatomic) BOOL allowMultipleSelection;
    Show on GitHub

  • Determines if the generated selection control allows no selection.

    Declaration

    Objective-C

    @property (nonatomic) BOOL allowNoSelection;
    Show on GitHub

  • The maximum number of items that can be selected. Set to zero to allow an infinite number of selections. Default: 0.

    • - note: Only applicable when allowMultipleSelection is TRUE.

    Declaration

    Objective-C

    @property (nonatomic) NSUInteger maximumSelections;
    Show on GitHub

  • Set to TRUE to automatically dismiss the selection detail view when an item is selected.

    Declaration

    Objective-C

    @property (nonatomic) BOOL autoDismissDetailView;
    Show on GitHub

  • Set to TRUE to hide the detail view’s navigation bar. - note: Only applicable if autoDismissDetailView is TRUE.

    Declaration

    Objective-C

    @property (nonatomic) BOOL hideDetailViewNavigationBar;
    Show on GitHub

  • Determines if the generated control allows adding new items. Default: FALSE.

    Declaration

    Objective-C

    @property (nonatomic) BOOL allowAddingItems;
    Show on GitHub

  • Determines if the generated control allows deleting existing items. Default: FALSE.

    Declaration

    Objective-C

    @property (nonatomic) BOOL allowDeletingItems;
    Show on GitHub

  • Determines if the generated control allows moving items. Default: FALSE.

    Declaration

    Objective-C

    @property (nonatomic) BOOL allowMovingItems;
    Show on GitHub

  • Determines if the generated control allows editing items. Default: FALSE.

    Declaration

    Objective-C

    @property (nonatomic) BOOL allowEditingItems;
    Show on GitHub

  • The user interface element that is used to add new objects when selected. This object is typically of type SCTableViewCell. Set to nil to ignore. Default:nil.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSObject *placeholderuiElement;
    Show on GitHub

  • The uiElement that is displayed when no items are available to display. This object is typically of type SCTableViewCell. Set to nil to ignore. Default:nil.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSObject *addNewObjectuiElement;
    Show on GitHub