FUIListPicker

public protocol FUIListPicker

The protocol defines the properties and functions for listing the options in an UITableView for the corresponding ListPickerFormCell.

  • The prompt string to be displayed on the section footer of the selection list table view. If this is nil, there will be no section footer.

    Declaration

    Swift

    var prompt: String?

  • This property indicates if search bar is to be displayed in the ListPicker. The default is false.

    Declaration

    Swift

    var isSearchEnabled: Bool

  • If this is true, there will be a barcode scanner icon at the bookmark location of the search bar to allow user use barcode scanner.

    Declaration

    Swift

    var isBarcodeScannerEnabled: Bool

  • The FUIBarcodeScanMode for the barcode scanner.

    Declaration

    Swift

    var barcodeScanMode: FUIBarcodeScanMode

  • A closure to transform the scan result string. The transformed string will be used as the search text. If this property is nil, the result string from scanner will be used as the search text directly without transformation.

    Declaration

    Swift

    var barcodeScanResultTransformer: ((String) -> String)?

  • The ListPickerDataSource implementation for the available options. If this is set, the valueOptions property of the associated FUIListPickerFormCell will be ignored. If this is not set by the developer, and valueOptions property of the associated FUIListPickerFormCell is set, a StringListPickerDataSource will be created using valueOptions and set to both properties ‘dataSource’ and ‘searchResultsUpdating’.

    Declaration

    Swift

    var dataSource: FUIListPickerDataSource?

  • The ListPickerSearchResultsUpdating implementation for handling search results. Please refer to the dataSource property that if dataSource property is not set by the developer, and valueOptions property of the associated FUIListPickerFormCell is set, a StringListPickerDataSource will be created using valueOptions and set to both properties ‘dataSource’ and ‘searchResultsUpdating’.

    Declaration

    Swift

    var searchResultsUpdating: FUIListPickerSearchResultsUpdating?

  • The section header title for selected entries in long list. The default is from localized strings file - Selected.

    Declaration

    Swift

    var selectedEntriesSectionTitle: String?

  • The section header title for all entries in long list. The default is from localized strings file - All.

    Declaration

    Swift

    var allEntriesSectionTitle: String?

  • Register the UITableViewCell classes that will be used in displaying cells from dataSource. Note that the standard UITableViewCell is by default registered using the identifier UITableViewCell.

    Declaration

    Swift

    func register(_ cellClass: AnyClass?, forCellReuseIdentifier identifier: String)

  • Reload the data in the selection list table view.

    Declaration

    Swift

    func reloadData()