Other Classes

UICollectionViewCell subclass for FUIDataTableCardView card type, where FUIDataTable are centered in the card.

Extends FUIDataTableCardView API, by extension on FUIBaseDrawingCollectionViewCell.

Usage

let cell = collectionView.dequeueReusableCell(withReuseIdentifier: FUIDataTableCardCollectionViewCell.reuseIdentifier, for: indexPath) as! FUIDataTableCardCollectionViewCell
cell.title.text = "Machine Health Monitoring"
cell.subtitle.text = "ID 3940151"
cell.status.text = "3hr"
self._innerView.data = [[FUIText("Need Attention"), FUIText("Yesterday")],
                        [FUIText("Stable"), FUIText("Jul 5, 2021")],
                        [FUIText("Need Attention"), FUIText("Jul 4, 2021")]]

return cell

Skeleton

cell.showSkeleton()
cell.hideSkeleton()

Theming

Supported TEXT class paths:

fdlFUIDataTableCardCollectionViewCell_title {}
fdlFUIDataTableCardCollectionViewCell_subtitle {}
fdlFUIDataTableCardCollectionViewCell_status {}
fdlFUIDataTableCardCollectionViewCell_footnote {}
fdlFUIDataTableCardCollectionViewCell_textItem {}: TEXT theme for all cells in FUIDataTable. It has lowest priority.
fdlFUIDataTableCardCollectionViewCell_textItem_row2 {}: TEXT theme for one speciif column in FUIDataTable. # is the column index. It has third priority.
fdlFUIDataTableCardCollectionViewCell_textItem_column1 {}: TEXT theme for one specific row in FUIDataTable. # is the row index; header is row 0 if it existis. It has second priority.
fdlFUIDataTableCardCollectionViewCell_textItem_row2_column1{}: TEXT theme for one specific cell. Row index and column index are required. It has highest priority.

Supported TEXT properties:

font-color: Color;
font-style: UIFontTextStyle;
text-line-clamp: Integer;
text-align: NSTextAlignment;

Supported IMAGE class paths:

fdlFUIDataTableCardCollectionViewCell_imageItem {}: IMAGE theme for all cells in FUIDataTable. It has lowest priority.
fdlFUIDataTableCardCollectionViewCell_imageItem_column# {}: IMAGE theme for one speciif column in FUIDataTable. # is the column index. It has third priority.
fdlFUIDataTableCardCollectionViewCell_imageItem_row# {}: IMAGE theme for one specific row in FUIDataTable. # is the row index; header is row 0 if it existis. It has second priority.
fdlFUIDataTableCardCollectionViewCell_imageItem_row#_column# {}: IMAGE theme for one specific cell in FUIDataTable. Row index and column index are required. It has highest priority.

Supported IMAGE properties:

tint-color: Color;
image-name: String;

@MainActor
open class FUIDataTableCardCollectionViewCell : FUIBaseDrawingCollectionViewCell<FUIDataTableCardView>

A FUIDataTableCardView is used to track the current and historical development of valuations (= text) based measuring points (e.g. color, viscosity) over time. This helps users to identify unforeseen changes in the development immediately.

Usage

let view = FUIDataTableCardView()
view.title.text = "Machine Health Monitoring"
view.subtitle.text = "ID 3940151"
// set it as needed
view.subtitle.textColor = UIColor.preferredFioriColor(forStyle: .criticalLabel)
view.status.text = "3hr"
view.detailImage = UIImage(named: "")
view.data = [[FUIText("Need Attention"), FUIText("Yesterday")],
             [FUIText("Stable"), FUIText("Jul 5, 2021")],
             [FUIText("Need Attention"), FUIText("Jul 4, 2021")]]

Skeleton

view.showSkeleton()
view.hideSkeleton()

Theming

Supported TEXT class paths:

fdlFUIDataTableCardView_title {}
fdlFUIDataTableCardView_subtitle {}
fdlFUIDataTableCardView_status {}
fdlFUIDataTableCardView_footnote {}
fdlFUIDataTableCardView_textItem {}: TEXT theme for all cells in FUIDataTable. It has lowest priority.
fdlFUIDataTableCardView_textItem_row2 {}: TEXT theme for one speciif column in FUIDataTable. # is the column index. It has third priority.
fdlFUIDataTableCardView_textItem_column1 {}: TEXT theme for one specific row in FUIDataTable. # is the row index; header is row 0 if it existis. It has second priority.
fdlFUIDataTableCardView_textItem_row2_column1{}: TEXT theme for one specific cell in FUIDataTable. Row index and column index are required. It has highest priority.

Supported TEXT properties:

font-color: Color;
font-style: UIFontTextStyle;
text-line-clamp: Integer;
text-align: NSTextAlignment;

Supported IMAGE class paths:

fdlFUIDataTableCardView_imageItem {}: IMAGE theme for all cells in FUIDataTable. It has lowest priority.
fdlFUIDataTableCardView_imageItem_column# {}: IMAGE theme for one speciif column in FUIDataTable. # is the column index. It has third priority.
fdlFUIDataTableCardView_imageItem_row# {}: IMAGE theme for one specific row in FUIDataTable. # is the row index; header is row 0 if it existis. It has second priority.
fdlFUIDataTableCardView_imageItem_row#_column# {}: IMAGE theme for one specific cell in FUIDataTable. Row index and column index are required. It has highest priority.

Supported IMAGE properties:

tint-color: Color;
image-name: String;

See more

@MainActor
public class FUIDataTableCardView : FUICardBaseView, FUISubtitleMultiLineComponent, FUIFootnoteComponent, FUIDetailImageViewComponent

FUIAvatarStack is a container for a group of avatars with .grouped or .horizontal layout. Also a leading or trailing text can be displayed along with the avatars.

Example Initialization and Configuration:

let avatarStack = FUIAvatarStack()
avatarStack.avatars = ["1", UIImage(systemName: "person")!]
avatarStack.avatarsLayout = .grouped
avatarStack.sideLength = 30
avatarStack.title.text = "Description text for avatar stack"
avatarStack.titlePosition = .leading
avatarStack.isCircular = true
avatarStack.avatarsBorderWidth = 1
avatarStack.avatarsBorderColor = UIColor.red
avatarStack.avatarsContentModel = .scaleAspectFit

Theming

Supported Text class paths:

fdlFUIAvatarStack_title {}

Supported Text attributes: font-color (Color) font-name (FontName) font-style (UIFontTextStyle) font-size (Number)

Supported ImageView class paths:

fdlFUIAvatarStack_avatar_0 {}: Image theme for first image.
fdlFUIAvatarStack_avatar_1 {}: Image theme for second image.
fdlFUIAvatarStack_avatar {}: Image theme for the others.

Supported ImageView attributes:

    image-name: String;
    tint-color: Color;
    font-color: Color;
    background-color: Color;
    content-mode: ContentMode

See more

@MainActor
open class FUIAvatarStack : FUITintableDrawingView<FUIControlState>, FUITitleMultiLineComponent

FUIAvatarsView is a container for a group of avatars with .grouped or .horizontal layout. It’s used as an inner view in FUIAvatarStack.

Example Initialization and Configuration:

let avatarsView = FUIAvatarsView()
avatarsView.avatars = ["1", UIImage(systemName: "person")!]
avatarsView.layout = .grouped
avatarsView.sideLength = 30
avatarsView.isCircular = true
avatarsView.borderWidth = 1
avatarsView.borderColor = UIColor.red
avatarsView.avatarsContentMode = .scaleAspectFit

Theming

Supported ImageView class paths:

// Avatars at different index.
fdlFUIAvatarStack_avatar_0 {}
fdlFUIAvatarStack_avatar_1 {}

//
fdlFUIAvatarStack_avatar {}

Supported IMAGE class paths for FUIAvatarsView:

fdlFUIAvatarsView_avatar_0 {}: Image theme for first image.
fdlFUIAvatarsView_avatar_1 {}: Image theme for second image.
fdlFUIAvatarsView_avatar {}: Image theme for other images.

Supported Image attributes:

    image-name: String;
    tint-color: Color;
    font-color: Color;
    background-color: Color;
    content-mode: ContentMode

See more

@MainActor
open class FUIAvatarsView : FUIDrawingView

A base collection view layout class using section layout manager for generating layout attributes for views in a collection view.

See more

@MainActor
open class FUIBaseCollectionViewLayout<LayoutManager> : UICollectionViewLayout where LayoutManager : FUISectionLayoutManager

A collection view section layout manager that computes the position and size in a section. This is a base class which defines the common properties of a collection section. This class is not supposed to be used directly. Instead, subclass this one and implement prepare() for calculating frames for views in collection view.

See more

open class FUISectionLayoutManager : NSObject

The base view of a calendar cell view.

This is for SAPFiori internal use only.

See more

@MainActor
public class FUIBaseDrawingCalendarItemCollectionViewCell<InnerView> : FUIBaseCalendarItemCollectionViewCell, FUIStyleByStringAttributes, InnerViewContainer where InnerView : FUIBaseFixedMarginsView, InnerView : FUIBackgroundSchemeSupporting, InnerView : FUICalculateLayout, InnerView : FUIStyleByStringAttributes

This class defines the dates to be displayed as disabled in the FUICalendarView.

User cannot choose disabled days in the calendar.

See more

public class FUICalendarDisabledDates

This is the view that contains the weekday title labels in FUICalendarView.

See more

@MainActor
public class FUIWeekLabelView : FUITintableDrawingView<FUIControlState>, FUITitleComponent

Card-based drawing view. Not typically used directly by application developers. A streamlined interface for laying out a collection of views in either a column or rows. It calls each view in contents with systemLayoutSizeFitting(_:withHorizontalFittingPriority:verticalFittingPriority:) to determine its optimal size and layout with other properties.

See more

@MainActor
open class FUICardBaseDrawingView : FUITintableDrawingView<FUIControlState>

Showing card view as inner view for collection view cell.

Example Initialization and Configuration:

let cell = collectionView.dequeueReusableCell(withReuseIdentifier: FUICardCollectionViewCell.reuseIdentifier, for: indexPath) as! FUICardCollectionViewCell
// set up main header
cell.mainHeader.detailImageView.image = UIImage(named: "imageName")
cell.mainHeader.title.text = "Title"
cell.mainHeader.subtitle.text = "Subtitle"
cell.mainHeader.overflowAction.isHidden = false
cell.mainHeader.counter.text = "3 of 36"
// set up the icon stack
let dot = FUIAttributedImage(image: FUIIconLibrary.indicator.dot.withRenderingMode(.alwaysTemplate))
let attachment = FUIAttributedImage(image: FUIIconLibrary.indicator.attachment.withRenderingMode(.alwaysTemplate))
mainHeader.iconImages = [dot, attachment, "1"]

// set up media view
cell.mediaView.detailImageView.image = UIImage(named: "imageName")
cell.mediaView.title.text = "Title"
// set a customized height if needed
mediaView.detailImageViewHeight = 300

// set up extended view
cell.extHeader.row1.contents = [
    FUILabelItem(text: "Negative", image: UIImage(systemName: "exclamationmark.triangle.fill"), alignment: .leading),
    FUILabelItem(text: "Critical"),
    FUILabelItem(text: "label")
]
cell.extHeader.row1.separatorStyle = .automatic
cell.extHeader.row2.contents = [FUIRatingControl(style: .standard)]
cell.extHeader.row3.contents = [...]

let dollars = FUIKPIUnitItem(string: "$")
let metric = FUIKPIMetricItem(string: "888.88")
let unit = FUIKPIUnitItem(string: "M")
cell.extHeader.kpiItems = [dollars, metric, unit]
cell.extHeader.kpiFootnote.text = "Label"

// set up body
cell.body.contents = [
   ...
]

// set up footer
cell.footer..primaryButton.isHidden = false
cell.footer..primaryAction.setTitle("Primary", for: .normal)
cell.footer..secondaryAction.isHidden = false
cell.footer..secondaryAction.setTitle("Secondary", for: .normal)

See more

@MainActor
open class FUICardCollectionViewCell : FUIBaseDrawingCollectionViewCell<FUICardView>

Card Extended Header
 The optional Extended Header block can contain up to 3 rows (row1, row2, and row3) and a KPI. A row can be optionally filled with the following UI components:

• Labels (for text, status or timestamp)
• star rating
• tags

Example Initialization and Configuration:

// set up extended view
let extHeader = FUICardExtHeaderView()
extHeader.row1.contents = [
    FUILabelItem(text: "Negative", image: UIImage(systemName: "exclamationmark.triangle.fill"), alignment: .leading),
    FUILabelItem(text: "Critical"),
    FUILabelItem(text: "label")
]
extHeader.row1.separatorStyle = .automatic
extHeader.row2.contents = [FUIRatingControl(style: .standard)]
extHeader.row3.contents = [...]

// set up kpi
let dollars = FUIKPIUnitItem(string: "$")
let metric = FUIKPIMetricItem(string: "888.88")
let unit = FUIKPIUnitItem(string: "M")
extHeader.kpiItems = [dollars, metric, unit]
extHeader.kpiFootnote.text = "Label"

Theming

Supported Text class paths:

fdlFUICardExtHeaderView_label
fdlFUICardExtHeaderView_labelItem_label
fdlFUICardExtHeaderView_kpiFootnote

Supported Text attributes: font-color (Color) font-name (FontName) font-style (UIFontTextStyle) font-size (Number) text-align (TextAlign) text-line-clamp (Integer)

Supported ImageView class paths:

fdlFUICardExtHeaderView_labelItem_imageView {}

Supported ImageView attributes: image-name (Image) tint-color (Color)

Supported TagView class paths:

fdlFUICardExtHeaderView_tagViewSubView {}

Supported TagView attributes: font-color (Color) font-name (FontName) font-style (UIFontTextStyle) font-size (Number) fill-color (Color) corner-radius (Float) border-width (Float) border-color (Color) content-insets (Box)

Supported FUIRatingControl class path:

fdlFUICardExtHeaderView_ratingControl

Supported RatingControl properties: on-color { -standard | -accented | -editable-disabled | -editable-disabled }: Color; off-color { -standard | -accented | -editable-disabled | -editable-disabled }: Color; on-image { -standard | -editable }: Image; off-image { -standard | -editable }: Image;

See more

@MainActor
public class FUICardExtHeaderView : FUITintableDrawingView<FUIControlState>, FUIKPIComponent, FUIKPIFootnoteMultiLineComponent, FUIKPIAttributesConsumer, FUIKPIAttributesProvider

Card Main Header
 The main header block can contain a thumbnail, icon stack, title, subtitle, an Action button, and a Counter.

Example Initialization and Configuration:

// set up main header
let mainHeader = FUICardMainHeaderView()
mainHeader.detailImageView.image = UIImage(named: "imageName")
mainHeader.title.text = "Title"
mainHeader.subtitle.text = "Subtitle"
mainHeader.overflowAction.isHidden = false
mainHeader.counter.text = "3 of 36"
// set up the icon stack
let dot = FUIAttributedImage(image: FUIIconLibrary.indicator.dot.withRenderingMode(.alwaysTemplate))
let attachment = FUIAttributedImage(image: FUIIconLibrary.indicator.attachment.withRenderingMode(.alwaysTemplate))
mainHeader.iconImages = [dot, attachment, "1"]

Theming

Supported Text class paths:

fdlFUICardMainHeaderView_title {}
fdlFUICardMainHeaderView_subtitle {}
fdlFUICardMainHeaderView_counter {}
fdlFUICardMainHeaderView_overflowAction {}

Supported Text attributes: font-color (Color) font-name (FontName) font-style (UIFontTextStyle) font-size (Number) text-align (TextAlign) text-line-clamp (Integer)

Supported ImageView class paths:

fdlFUICardMainHeaderView_detailImageView {}

Supported ImageView attributes: image-name (Image) tint-color (Color)

See more

@MainActor
open class FUICardMainHeaderView : FUITintableDrawingView<FUIControlState>, FUITitleMultiLineComponent, FUISubtitleMultiLineComponent, FUICounterComponent, FUIOverflowActionComponent, FUIDetailImageViewComponent, FUIIconsComponent

Card media view. The media block can contain an optional title and an image that spans the complete width of the card.

Example Initialization and Configuration:

let mediaView = FUICardMediaView()
// set up media view
mediaView.detailImageView.image = UIImage(named: "imageName")
mediaView.title.text = "Title"
// set a customized height if needed
mediaView.detailImageViewHeight = 300

Theming

Supported Text class paths:

fdlFUICardMediaView_title {}

Supported Text attributes: font-color (Color) font-name (FontName) font-style (UIFontTextStyle) font-size (Number) text-align (TextAlign) text-line-clamp (Integer)

Supported ImageView class paths:

fdlFUICardMediaView_detailImageView {}

Supported ImageView attributes: image-name (Image) tint-color (Color)

See more

@MainActor
public class FUICardMediaView : FUITintableDrawingView<FUIControlState>, FUIDetailImageViewComponent, FUITitleMultiLineComponent

Showing card view as inner view for table view cell.

Example Initialization and Configuration:

let cell = tableView.dequeueReusableCell(withIdentifier: FUICardTableViewCell.reuseIdentifier,
                                         for: indexPath)  as! FUICardTableViewCell
// set up main header
cell.mainHeader.detailImageView.image = UIImage(named: "imageName")
cell.mainHeader.title.text = "Title"
cell.mainHeader.subtitle.text = "Subtitle"
cell.mainHeader.overflowAction.isHidden = false
cell.mainHeader.counter.text = "3 of 36"
// set up the icon stack
let dot = FUIAttributedImage(image: FUIIconLibrary.indicator.dot.withRenderingMode(.alwaysTemplate))
let attachment = FUIAttributedImage(image: FUIIconLibrary.indicator.attachment.withRenderingMode(.alwaysTemplate))
mainHeader.iconImages = [dot, attachment, "1"]

// set up media view
cell.mediaView.detailImageView.image = UIImage(named: "imageName")
cell.mediaView.title.text = "Title"
// set a customized height if needed
mediaView.detailImageViewHeight = 300

// set up extended view
cell.extHeader.row1.contents = [
    FUILabelItem(text: "Negative", image: UIImage(systemName: "exclamationmark.triangle.fill"), alignment: .leading),
    FUILabelItem(text: "Critical"),
    FUILabelItem(text: "label")
]
cell.extHeader.row1.separatorStyle = .automatic
cell.extHeader.row2.contents = [FUIRatingControl(style: .standard)]
cell.extHeader.row3.contents = [...]

let dollars = FUIKPIUnitItem(string: "$")
let metric = FUIKPIMetricItem(string: "888.88")
let unit = FUIKPIUnitItem(string: "M")
cell.extHeader.kpiItems = [dollars, metric, unit]
cell.extHeader.kpiFootnote.text = "Label"

// set up body
cell.body.contents = [
   ...
]

// set up footer
cell.footer..primaryButton.isHidden = false
cell.footer..primaryAction.setTitle("Primary", for: .normal)
cell.footer..secondaryAction.isHidden = false
cell.footer..secondaryAction.setTitle("Secondary", for: .normal)

See more

@MainActor
open class FUICardTableViewCell : FUIBaseDrawingTableViewCell<FUICardView>

The card has five elements: media view FUICardMediaView, main header FUICardMainHeaderView, extended header FUICardExtHeaderView, body FUICardBaseDrawingView and footer FUICardFooterView. The main header FUICardMainHeaderView is the only mandatory element. All others are optional.

Example Initialization and Configuration:

let card = FUICardView()
// set up main header
card.mainHeader.detailImageView.image = UIImage(named: "imageName")
card.mainHeader.title.text = "Title"
card.mainHeader.subtitle.text = "Subtitle"
card.mainHeader.overflowAction.isHidden = false
card.mainHeader.counter.text = "3 of 36"
// set up the icon stack
let dot = FUIAttributedImage(image: FUIIconLibrary.indicator.dot.withRenderingMode(.alwaysTemplate))
let attachment = FUIAttributedImage(image: FUIIconLibrary.indicator.attachment.withRenderingMode(.alwaysTemplate))
card.mainHeader.iconImages = [dot, attachment, "1"]

// set up media view
card.mediaView.detailImageView.image = UIImage(named: "imageName")
card.mediaView.title.text = "Title"
// set a customized height if needed
card.mediaView.detailImageViewHeight = 300

// set up extended view
card.extHeader.row1.contents = [
    FUILabelItem(text: "Negative", image: UIImage(systemName: "exclamationmark.triangle.fill"), alignment: .leading),
    FUILabelItem(text: "Critical"),
    FUILabelItem(text: "label")
]
card.extHeader.row1.separatorStyle = .automatic
card.extHeader.row2.contents = [FUIRatingControl(style: .standard)]
card.extHeader.row3.contents = [...]

let dollars = FUIKPIUnitItem(string: "$")
let metric = FUIKPIMetricItem(string: "888.88")
let unit = FUIKPIUnitItem(string: "M")
card.extHeader.kpiItems = [dollars, metric, unit]
card.extHeader.kpiFootnote.text = "Label"

// set up body
card.body.contents = [
   ...
]

// set up footer
card.footer.primaryAction.isHidden = false
card.footer.primaryAction.setTitle("Primary", for: .normal)
card.footer.secondaryAction.isHidden = false
card.footer.secondaryAction.setTitle("Secondary", for: .normal)

Theming

Supported Text class paths:

fdlFUICardMediaView_title {}
fdlFUICardMainHeaderView_title {}
fdlFUICardMainHeaderView_subtitle {}
fdlFUICardMainHeaderView_counter {}
fdlFUICardMainHeaderView_overflowAction {}
fdlFUICardExtHeaderView_label
fdlFUICardExtHeaderView_labelItem_label
fdlFUICardExtHeaderView_kpiFootnote
fdlFUICardFooterView_primaryAction {}
fdlFUICardFooterView_secondaryAction {}

Supported Text attributes: font-color (Color) font-name (FontName) font-style (UIFontTextStyle) font-size (Number) text-align (TextAlign) text-line-clamp (Integer)

Supported ImageView class paths:

fdlFUICardMediaView_detailImageView {}
fdlFUICardMainHeaderView_detailImageView {}
fdlFUICardExtHeaderView_labelItem_imageView {}

Supported ImageView attributes: image-name (Image) tint-color (Color)

Supported TagView class paths:

fdlFUICardExtHeaderView_tagViewSubView {}

Supported TagView attributes: font-color (Color) font-name (FontName) font-style (UIFontTextStyle) font-size (Number) fill-color (Color) corner-radius (Float) border-width (Float) border-color (Color) content-insets (Box)

Supported FUIRatingControl class path:

fdlFUICardExtHeaderView_ratingControl

Supported RatingControl properties: on-color { -standard | -accented | -editable-disabled | -editable-disabled }: Color; off-color { -standard | -accented | -editable-disabled | -editable-disabled }: Color; on-image { -standard | -editable }: Image; off-image { -standard | -editable }: Image;

See more

@MainActor
open class FUICardView : FUICardBaseDrawingView

Gridline properties for an Axis.

See more

public class FUIChartGridlineAttributes : FUIChartLineAttributes

Style definition for the chartView. Gives access to the chart theming.

See more

public class FUIChartStyle : Equatable

FUIEmptyStateView: conforms to the UIView class and contains SwiftUI component EmptyStateView as a container.

Usage 1: simple

  let emptyView = FUIEmptyStateView()
  emptyView.title.text = "Custom placeholder title"
  emptyView.body.text = "This is a text to describe what you can do when there is no data"
  emptyView.detailImageView.image = UIImage(named: "errorMessage")
  let actionButton = FUIButton()
  // ... configure button style
  // actionButton.setContentHuggingPriority(.defaultHigh, for: .horizontal)
  // actionButton.setContentHuggingPriority(.defaultHigh, for: .vertical)
  emptyStateView.primaryAction = actionButton

Usage 2: customization

  let emptyStateView = FUIEmptyStateView()

  emptyStateView.title.text = ...
  emptyStateView.titleAttributedText = ...

  emptyStateView.body.text = ...
  emptyStateView.bodyAttributedText = ...

  let detailImageView = FUIImageView()
  // ... configure imageView style
  emptyStateView.detailImageView = detailImageView

  let actionButton = FUIButton()
  // ... configure button style
  // actionButton.setContentHuggingPriority(.defaultHigh, for: .horizontal)
  // actionButton.setContentHuggingPriority(.defaultHigh, for: .vertical)
  emptyStateView.primaryAction = actionButton

See more

@available(*, deprecated, message: "This component has been replaced by FUIIllustratedMessage")
@MainActor
public class FUIEmptyStateView : FUIBaseDrawingView, FUITitleMultiLineComponent, FUIBodyMultiLineComponent, FUIDetailImageViewComponent, FUIPrimaryActionComponent

The default implementation of the FUITintAttributesProvider with FUIControlState as the TintState type.

See more

open class FUIControlStateTintAttributesProvider : FUITintAttributesProvider

Undocumented

See more

public class FUIMultiLineText : FUIText

NibDesignableProtocol-compliant implementation of UIStackView

See also

NibDesignableProtocol

See more

@IBDesignable
@MainActor
open class NibDesignableStackView : UIStackView, NibDesignableProtocol

Show banner multi message view. Developer can filter the messages with category, clear one kind of category, or remove the item under the category. On iPhone, the multi message banner view is shown as a form sheet. On iPad, the multi message banner view is shown as a Pop Over.

See more

@MainActor
public class FUIBannerMultiMessageViewController : UIViewController, UITableViewDelegate, UITableViewDataSource

UICollectionView subclass, which invokes a sizeChangeHandler: (() -> Void)? closure, when the current content size of the collection does not match the intrinsic content size. The sizeChangeHandler property is internal to the SDK.

Developers should generally not initialize FUIResizingCollectionView directly. Instead, instances of the class are typically accessed through the FUITableViewCollectionSection API’s.

@available(*, deprecated, message: "If using as subview of UITableViewCell: use FUICollectionViewTableViewCell instead; if using generally: use UICollectionView instead.")
@MainActor
public class FUIResizingCollectionView : UICollectionView

Undocumented

See more

public class ObservableArray<Element> : Sequence, ObservableObject where Element : ObservableObject, Element : Hashable, Element : Identifiable

extension ObservableArray: Collection

extension ObservableArray: RandomAccessCollection

FUIBarButtonItem is an enhanced UIBarButtonItem to provide a way to specify the image to be displayed based on the state when title is nil or empty.

For now, only normal and disabled states are used.

FUIBarButtonItem also provides a few convenience init()s to return a newly initialized SAPFiori Style UIBarButtonItem. It has the SAPFiori styles, font & color for title and icon, .quaternaryFill background color for .highlighted state, and a minimum 44x44 touch area.

See more

@MainActor
open class FUIBarButtonItem : UIBarButtonItem

A UICollectionView subclass. It can be used as a UICollectionView property within a UITableViewCell. This subclass supports the accessibility mode when voice over is turned on , allowing the focus to move to the next or previous UICollectionViewCell while swiping.

See more

@MainActor
public class FUIAccessibilityTableViewCollectionView : UICollectionView

A UITableViewHeaderFooterView subclass, which supports top and bottom padding and separators.

See more

@MainActor
open class FUIBaseTableViewHeaderFooterView : UITableViewHeaderFooterView, FUIViewBorderDrawing

Undocumented

@MainActor
open class FUIDrawingView : FUIBaseDrawingView, FUIAttributesProvider

The base class for an Inline Validation form table view cell.

See more

@MainActor
open class FUIInlineValidationDrawingTableViewCell<InnerView> : FUIBaseDrawingTableViewCell<InnerView>, InnerViewContainerEventHandling, FUIInlineValidation where InnerView : FUIBaseFixedMarginsView, InnerView : FUIBackgroundSchemeSupporting, InnerView : FUICalculateLayout, InnerView : FUIStyleByStringAttributes

UIView subclass to draw text and glygh image using TextKit apis. Typically not used by developer.

See more

@MainActor
public class FUITextKitView : UIView, PrepareForReuse, FUIContentCopyable

Undocumented

See more

@MainActor
open class FUITintableDrawingView<T> : FUIBaseDrawingView, FUITintAttributesProvider, FUIAttributesProvider, FUIStyleTintByStringAttributes, TintStyleGrabbing where T : Defaultable, T : Enableable, T : Hashable

FUIToolbar is a subclass of ‘UIToolbar’ which displays the UIBarButtonItem array in Fiori style.

Developers needs to create UINavigationController with the following code to use FUIToolbar as its toolbar.

UINavigationController(navigationBarClass: nil, toolbarClass: FUIToolbar.self)

Then in the viewDidLoad function of the UIViewController use the following code to set the toolbar items for text buttons:

var buttons: [FUIButton] = [...]
setFioriStyleToolbarItems(buttons, helperText: helperText, animated: true)

Or, for icon type items:

let item1 = UIBarButtonItem(image: shareIcon, ...) // item1 is the primary item
let item2 = UIBarButtonItem(image: trashIcon, ...)
var items: [UIBarButtonItem] = [item1, item2, ...]
setFioriStyleToolbarItems(items, helperText: helperText, animated: true)

Theming

Supported TEXT class paths:

fdlFUIToolbar_helperText {}

Supported TEXT properties:

font-color: Color;
font-style: UIFontTextStyle;

Supported UIBarButtonItem class path:

fdlFUIToolbar_overflowButton {}

Supported UIBarButtonItem properties:

image: Name;

See more

@MainActor
open class FUIToolbar : UIToolbar

Showing business contact information as inner view for collection view cell.

See more

@MainActor
open class FUIContactCollectionViewCell : FUIBaseDrawingCollectionViewCell<FUIContactView>

Base view of FUIContactCollectionViewCell. Standard Fiori control for rendering contact data.

Example Initialization and Configuration

let view = FUIContactView()
view.detailImageView.image = UIImage(named: "name")
view.headlineText = "Edgar Smith"
view.subheadlineText = "Lorem ipsum datil es iosin Lotios nsiqok"
view.activityControl.addActivities([.phone, .email]))
view.activityControl.maxVisibleItems = 4
view.onActivitySelectedHandler = { [weak self] activityItem in
}

Theming

Supported FUIContactView class paths:

fdlFUIContactView {}

Supported FUIContactView attributes: background-color (Color)

Supported Text class paths:

fdlFUIContactView_headlineLabel {}
fdlFUIContactView_subheadlineLabel {}
fdlFUIContactView_descriptionLabel {}

Supported Text attributes:

font-color (Color)
font-name (FontName)
font-style (UIFontTextStyle)
font-size (Number)
text-align (TextAlign)
text-line-clamp (Integer)

Supported ImageView class paths:

fdlFUIContactView_detailImageView {}

Supported ImageView attributes:

image-name (Image)
tint-color (Color)

See more

@MainActor
open class FUIContactView : FUITintableDrawingView<FUIControlState>, FUIDetailImageViewComponent, FUIContactComponent, FUIContentCopyable, FUIActivityControlDelegate

A FUIDimensionSelector object is a horizontal control made up of multiple segments, each segment functioning as a discrete button. Selection is mutually exclusive.

Code usage:

let dimensionSelector = FUIDimensionSelector(titles: titles)
dimensionSelector.selectedIndex = 1
dimensionSelector.interItemSpacing = 20
dimensionSelector.selectionDidChangeHandler = { [weak self] index in
print("selected: \(index ?? -1)")
}

Styling

Attribute setting:

Setting the items’ styling for title and border with setAttribute(attribute, for:). Currently .normal, .selected and .disabled are supported.

let attribute = FUISegmentAttribute(textColor: .red, borderColor: .blue)
dimensionSelector.setAttribute(attribute: attribute, for: .selected)

Theming

fdlFUIDimensionSelector {
title-color: green;
title-color-selected: red;
title-color-disabled: gray;
border-color: blue;
border-color-selected: orange;
border-color-disabled: gray;
interItem-spacing: 20;
title-inset: 5 10 5 10;
content-inset: 0 40 0 40;
}

See more

@MainActor
open class FUIDimensionSelector : UIView

A UIView subclass for showing key-value text in a vertical stack.

Usage

let view = FUIKeyValueContentView()
view.title.text = "title text"
view.value = "value text"

Theming

Supported TEXT class paths:

fdlFUIKeyValueContentView_title {}
fdlFUIKeyValueContentView_valueText {}

Supported TEXT properties:

font-color (Color)
font-name (FontName)
font-style (UIFontTextStyle)
font-size (Number)
text-align (TextAlign)
text-line-clamp (Integer)

See more

@MainActor
open class FUIKeyValueContentView : FUITintableDrawingView<FUIControlState>, FUITitleMultiLineComponent, FUIValueComponent

A UITableViewCell subclass for showing key-value text in a vertical stack.

Usage

override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
    guard let cell = tableView.dequeueReusableCell(withIdentifier: FUIKeyValueTableViewCell.reuseIdentifier, for: indexPath) as? FUIKeyValueTableViewCell else {
        return UITableViewCell()
    }

    cell.title.text = "Short title text"
    cell.value = "Short value text"
    cell.accessoryType = .detailButton

    return cell
}

Behavior

• Tapping the cell (outside the value text view or when ‘dataDetectorTypes’ is not set) triggers table view navigation via tableView(_:didSelectRowAt:).
• Tapping detected links in the value text view (when dataDetectorTypes is set) performs system actions (e.g., opening URL or dialing phone number).

Theming

Supported TEXT class paths:

fdlFUIKeyValueTableViewCell_title {}
fdlFUIKeyValueTableViewCell_valueText {}

Supported TEXT properties:

font-color (Color)
font-name (FontName)
font-style (UIFontTextStyle)
font-size (Number)
text-align (TextAlign)
text-line-clamp (Integer)

See more

@MainActor
open class FUIKeyValueTableViewCell : FUIInlineValidationDrawingTableViewCell<FUIKeyValueContentView>

extension FUIKeyValueTableViewCell: UITextViewDelegate

Undocumented

See more

@MainActor
public class FUILabelItem : FUIDrawingView

The FUITableViewCollectionSection control is designed to be used, when a section in a UITableView should be dedicated to displaying a UICollectionView, and, the height of that section should adjust to fit its contents.

The collection section produces a single FUICollectionViewTableViewCell, which refreshes its height, after its subview FUICollectionView calculates the sizes of its subview UICollectionViewCell items.

A developer uses the FUITableViewCollectionSection, by assigning a data source (/and delegate) to its collectionView: FUICollectionView property; then, he or she should supply its collectionViewTableViewCell property to a UITableViewDataSource.tableView(_:cellForRowAt:) implementation.

## Usage

    let workorders: [WorkOrder] = [WorkOrder]()

    override public func viewDidLoad() {

        let workOrdersLayout = FUICollectionViewLayout.horizontalFlow
        workOrdersLayout.itemSize = CGSize(width: 200, height: 200)
        self.workOrdersSection = FUITableViewCollectionSection(tableView: self.tableView, collectionViewLayout: workOrdersLayout)
        self.workOrdersSection.collectionView.dataSource = self
        self.workOrdersSection.collectionView.register(FUISimpleCollectionViewCell.self, forCellWithReuseIdentifier: FUISimpleCollectionViewCell.reuseIdentifier)
        self.workOrdersSection.collectionView.delegate = self
        self.workOrdersSection.collectionView.isScrollEnabled = false

        self.tableView.estimatedRowHeight = 98
        self.tableView.rowHeight = UITableView.automaticDimension
    }

    // MARK:  UITableViewDataSource
    override public func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
        return 1
    }

    public override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
        return self.workOrdersSection.collectionViewTableViewCell
    }

    // MARK:  UICollectionViewDataSource
    public func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {

        switch collectionView {
        case workOrdersSection.collectionView:
            let cell = collectionView.dequeueReusableCell(withReuseIdentifier: FUISimpleCollectionViewCell.reuseIdentifier,
                                                                          for: indexPath) as! FUISimpleCollectionViewCell
            cell.contentImageView.image = UIImage(named: "WorkOrderImage")
            cell.titleLabel.text = "Work Order: \(indexPath.item)"
            return cell
        default:
            // ...
        }
    }

See more

@available(*, deprecated, message: "Use FUICollectionViewTableViewCell instead.")
open class FUITableViewCollectionSection

FUITagView is an enhanced FUILabel that applies Fiori Design tag color schemes to the label by default.

Usage

• Initializing programmatically:

let tagView = FUITagView(FUITag("tag1"))

See more

@MainActor
public class FUITagView : UIView

Undocumented

See more

@MainActor
public class FUILinearProgressIndicator : FUIBaseDrawingView, FUITitleMultiLineComponent

• The reusable UI component implemented as a UICollectionViewCell to manage selecting attachments.

FUIAttachmentsCollectionViewCell uses a FUIAttachmentsViewController to display the title of the cell and a collection of icons to represent the attachments. The attachment icon size may change, depending on the system font size settings. The controller arranges the attachment icons so that as many icons can be fitted into a row as possible, in as many rows as possible, to display all the attachment icons. It will also try to make the row spacing equal to the spacing between icons. However, the row spacing is limited to a maximum of 20 pixels.

Developers should use the attachmentsController property to provide attachment information; the delegate, the dataSource and the list of FUIAttachmentAction implementations for the desired type of attachments. The app can use the built-in types or implement additional types as desired.

Color settings:

Setting tintColor to add a button for a state using the setTintColor(_:for:) API. Currently normal and .selected are supported.

 cell.setTintAttributes([NSAttributedString.Key.foregroundColor: UIColor.red], for: .actionTitle, state: .normal)

There are three versions of the built-in FUIAttachmentAction:

• FUIAddPhotoAttachmentAction: Choose photo from the photo library.
• FUITakePhotoAttachmentAction: Take photo using the camera.
• FUIDocumentPickerAttachmentAction: Select file using the standard UIDocumentPickerViewController.

 override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
     let cell = collectionView.dequeueReusableCell(withReuseIdentifier: FUIAttachmentsCollectionViewCell.reuseIdentifier, for: indexPath) as! FUIAttachmentsCollectionViewCell
     cell.attachmentsController.delegate = self
     cell.attachmentsController.dataSource = self

     let addPhotoAction = FUIAddPhotoAttachmentAction()
     addPhotoAction.delegate = self
     cell.attachmentsController.addAttachmentAction(addPhotoAction)

     let takePhotoAction = FUITakePhotoAttachmentAction()
     takePhotoAction.delegate = self
     cell.attachmentsController.addAttachmentAction(takePhotoAction)

     let filePickerAction = FUIDocumentPickerAttachmentAction()
     filePickerAction.delegate = self
     cell.attachmentsController.addAttachmentAction(filePickerAction)

     return cell
 }

 var attachmentURLs: [URL] = [URL]()

// MARK: FUIAttachmentsViewControllerDataSource methods
func attachmentsViewController(_ attachmentsViewController: FUIAttachmentsViewController, iconForAttachmentAtIndex index: Int) -> (image: UIImage, contentMode: UIViewContentMode)? {
    let urlString = self.attachmentURLs[index].absoluteString
    guard let image = self.attachmentThumbnails[urlString] else {
        return nil
    }
    return (image!, .scaleAspectFill)
}

func numberOfAttachments(in attachmentsViewController: FUIAttachmentsViewController) -> Int {
    return attachmentURLs.count
}

func attachmentsViewController(_ attachmentsViewController: FUIAttachmentsViewController, urlForAttachmentAtIndex index: Int) -> URL? {
    return attachmentURLs[index]
}

// MARK:  FUIAttachmentsViewControllerDelegateMethods
func attachmentsViewController(_ attachmentsViewController: FUIAttachmentsViewController, couldNotPresentAttachmentAtIndex index: Int) {

}

func focusOnNewAttachment() {
    DispatchQueue.main.async {
        if let cell = ... { // find the attachment cell
            if let newDoc = cell.accessibilityElements?.last {
                UIAccessibility.post(notification: .layoutChanged, argument: newDoc)
            }
        }
    }
}

func attachmentsViewController(_ attachmentsViewController: FUIAttachmentsViewController, didPressDeleteAtIndex index: Int) {
    self.attachmentURLs.remove(at: index)
    self.tableView.reloadSections(IndexSet(integer:attachmentSection), with: .automatic)
}


//MARK: FUIAddPhotoAttachmentActionDelegate
 func addPhotoAttachmentAction(_ action: FUIAddPhotoAttachmentAction, didSelectPhoto asset: PHAsset, at url: URL) {
    setupThumbnails(url, with: asset)
    self.addAttachmentURL(url)
}

//MARK: FUITakePhotoAttachmentActionDelegate

func takePhotoAttachmentAction(_ action: FUITakePhotoAttachmentAction, didTakePhoto asset: PHAsset, at url: URL) {
    setupThumbnails(url, with: asset)
    self.addAttachmentURL(url)
}


func addAttachmentURL(_ url: URL) {
    self.attachmentURLs.append(url)
    DispatchQueue.main.async {
        self.tableView.reloadSections(IndexSet(integer:self.attachmentSection), with: .automatic)
        self.tableView.scrollToRow(at: IndexPath(row: 0, section: self.attachmentSection) , at: .middle, animated: true)
        if UIAccessibility.isVoiceOverRunning {
            focusOnNewAttachment()
        }
    }
}

 func setupThumbnails(_ url: URL, with asset: PHAsset) {
     let imageManager = PHImageManager.default()
     imageManager.requestImage(for: asset, targetSize: CGSize(width: 80, height: 80), contentMode: .default, options: nil, resultHandler: { image, array in
         self.attachmentThumbnails[url.absoluteString] = image
         DispatchQueue.main.async {
             self.tableView.reloadSections(IndexSet(integer:self.attachmentSection), with: .automatic)
             self.tableView.scrollToRow(at: IndexPath(row: 0, section: self.attachmentSection) , at: .middle, animated: true)
         }
     })
 }

 //MARK: FUIDocumentPickerAttachmentActionDelegate {
 var documentPicker: UIDocumentPickerViewController {
     return UIDocumentPickerViewController(documentTypes: ["public.data"], in: .import)
 }

 func documentPickerAttachmentAction(_ action: FUIDocumentPickerAttachmentAction, didPickFileAt url: URL) {
     if let savedUrl = saveFileToTempFolder(url) {
         self.addAttachmentURL(savedUrl)
     }
     self.tableView.reloadSections(IndexSet(integer:self.attachmentSection), with: .automatic)
     if UIAccessibility.isVoiceOverRunning {
        focusOnNewAttachment()
     }
 }

## Theming

Supported TEXT class paths:

 fdlFUIAttachmentsFormView_attachmentTitleLabel {}
 fdlFUIAttachmentsViewController_alertActionTitle {}
 fdlFUIFileThumbnailCollectionItemView_titleLabel {}

Supported TEXT properties:

 font-color: Color;
 font-style: UIFontTextStyle;

Supported IMAGE class paths:

 fdlFUIFileThumbnailCollectionItemView_detailImageView {}

Supported IMAGE properties:

 tint-color: Color;

Supported BUTTON class paths:

fdlFUIAddButtonCell_addButton {}

Supported BUTTON properties:

 image: Image;
 tint-color: Color;

Supported CELL class paths:

 `fdlFUIAttachmentsFormCell_thumbnailCell {}`
 fdlFUIAttachmentsFormCell_addButtonCell {}

Supported CELL properties:

 border-color: Color;
 border-width: Integer;
 corner-radius: Integer;

Supported style classes

See more

@MainActor
open class FUIAttachmentsCollectionViewCell : FUIInlineValidationDrawingCollectionViewCell<FUIAttachmentCellView>, FUIStateTintable

Undocumented

@MainActor
open class FUIAttachmentCellView : FUITintableDrawingView<FUIControlState>

The reusable UI component implemented as a UICollectionViewCell to allow users to enter notes.

The cell height is automatically adjusted to allow all of the content to be displayed. However, the cell height is also limited to the height of the screen above the soft keyboard height.

Usage

The following is an example of usage in an application with UIViewController and UICollectionViewDataSource:

override func viewDidLoad() {
    super.viewDidLoad()
    self.collectionView.register(FUINoteCollectionViewCell.self, forCellReuseIdentifier: FUINoteCollectionViewCell.reuseIdentifier)
}

override func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UITableViewCell {
    let cell = self.collectionView.dequeueReusableCell(withReuseIdentifier: FUINoteCollectionViewCell.reuseIdentifier, for: indexPath) as! FUINoteCollectionViewCell
    cell.onChangeHandler = { [unowned self] newValue in
         self.noteText = newValue
    }
    cell.placeholder.text = "Enter Description"
    cell.value = noteText
    cell.isTrackingLiveChanges = true
    return cell
}

Theming

Supported TEXT class paths:

   fdlFUINoteFormCell_valueText {}
   fdlFUINoteFormCell_placeholder {}

Supported TEXT properties:

   font-color: Color;
   font-style: UIFontTextStyle;

Supported TINTABLE class paths:

   fdlFUIKeyValueFormCell_valueText {}

Supported TINTABLE properties:

   tint-color { -disabled }: Color;
   font-style { -disabled }: UIFontTextStyle;

See more

@IBDesignable
@MainActor
open class FUINoteCollectionViewCell : FUIInlineValidationDrawingCollectionViewCell<FUINoteFormCellContentView>

The reusable UI component implemented as a UICollectionViewCell to display or edit a textfield.

The developer should set the following properties on the cell in their implementation of the UITableViewDataSource cellForRow(at:) function:

• keyName: The key name of the property.
• value: The value of the property.

And, an onChangeHandler:

• onChangeHandler: a handler closure that is invoked on changes to the value.

Optionally, the developer may provide

• isEditable: Indicates whether the cell’s value may be modified. The default is true.

• isStacked: A Boolean value to determine whether the cell should use a stacked or linear layout. If the device’s accessibility settings font size is increased, the cell will force a stacked layout. By default, this property is set to true.

• maxKeyWidth: The maximum width of the key with a linear layout. By default, the width is 115 for compact and 160 for regular. The set value must meet the minimum default threshold.

• alternativeInputButton: An FUIButton that manages an alternative method to fill the textField.

• isAlternativeInputEnabled: A Bool that shows or hides the alternativeInputButton. This button will indicate whether isAlternativeInputEnabled and isEditable are true.

Color settings:

Manage the color of the control by programmatically setting the textColor and tintColor.

The following is an example of usage in an application with UIViewController and UICollectionViewDataSource:

override func viewDidLoad() {
    super.viewDidLoad()
    self.collectionView.register(FUITextFieldCollectionViewCell.self, forCellReuseIdentifier: FUITextFieldCollectionViewCell.reuseIdentifier)
}

override func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {
    let cell = tableView.dequeueReusableCell(withIdentifier: FUITextFieldCollectionViewCell.reuseIdentifier, for: indexPath) as! FUITextFieldCollectionViewCell

    cell.keyName = "Editable"
    cell.value = myObject.productName

    // MARK:  implement onChangeHandler
    cell.onChangeHandler = { newValue in
        myObject.productName = newValue
    }

    // MARK: Implement alternative input, i.e. use OCR to capture input

    cell.isAlternativeInputEnabled = true
    let inputImage = FUIIconLibrary.system.camera
    cell.alternativeInputButton.setImage(inputImage.withRenderingMode(.alwaysTemplate), for: .normal)
    cell.alternativeInputButton.didSelectHandler = { [weak self, weak cell] (button) in

        //Import SAPML to use OCR capability
        let textRecController = FUITextRecognitionViewController()
        textRecController.recognitionView.observationHandler = { [unowned textRecController] observations in
            let filteredObservations = <#filter out unwanted text#>
            textRecController.recognitionView.showTexts(for: filteredObservations)
            let areObservationsValid = <#filteredObservations meets desired criteria#>
            if areObservationsValid {
                DispatchQueue.main.async {
                    cell?.value = filteredObservations.map { $0.value }.joined(separator:" ")
                }
                return true
            }
            return false
        }

        textRecController.onClose = {
            self?.dismiss(animated: true)
        }
        self?.present(UINavigationController(rootViewController: textRecController), animated: true)
    }

    return cell
 }

## Theming

nuiClass:

 fdlFUITextFieldFormCell {}

Supported TEXT class paths:

 fdlFUITextFieldFormCell_keyText {}
 fdlFUITextFieldFormCell_valueText {}

Supported TEXT properties:

 font-color: Color;
 placeholder-color: Color;
 font-style: UIFontTextStyle;

Supported BUTTON class paths:

 fdlFUITextFieldFormCell_alternativeInputButton {}

Supported BUTTON properties:

 background-color: Color;
 font-color: Color;

See more

@MainActor
open class FUITextFieldCollectionViewCell : FUIInlineValidationDrawingCollectionViewCell<FUITextFieldContentView>, FUIFormCell

UITableViewDiffableDataSource subclass to support editing for the cells in table view.

See more

@MainActor
open class FUIEditableTableViewDiffableDataSource<SectionIdentifierType, ItemIdentifierType> : UITableViewDiffableDataSource<SectionIdentifierType, ItemIdentifierType> where SectionIdentifierType : Hashable, ItemIdentifierType : Hashable

This class is an implementation of FUIAttachmentAction to allow users to choose items using PHPickerViewController from the Photo Library as attachments in FUIAttachmentsFormView.

The implementation uses a PHPickerViewController to let user choose items from Photo Library.

See more

@available(iOS 14.0, *)
open class FUIAddPhotoLibraryItemsAttachmentAction : FUIAttachmentAction

extension FUIAddPhotoLibraryItemsAttachmentAction: PHPickerViewControllerDelegate

This class is an implementation of FUIAttachmentAction to allow user to choose a file using UIDocumentPickerViewController as an attachment in FUIAttachmentsFormView.

If the application wants to have its Document directory accessible by the UIDocumentPickerViewController, the application needs to have the following 2 properties set to true in its plist:

• “Supports opening documents in place” (LSSupportsOpeningDocumentsInPlace)
• “Application supports iTunes file sharing” (UIFileSharingEnabled)

Note that the file URL returned by the document picker is a temporary url. The content of the file may not be available after the document picker is closed. Therefore, developer should copy the file content to a location that it may attach the file content later.

class TestFormTableViewController: FUIFormTableViewController {
    override func viewDidLoad() {
        // ...

        // prepare temporary directory to hold attachment files
    }

    // ...

    override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
        // ...

        let cell = tableView.dequeueReusableCell(withIdentifier: FUIAttachmentsFormCell.reuseIdentifier, for: indexPath) as! FUIAttachmentsFormCell
        cell.attachmentsController.delegate = self
        cell.attachmentsController.dataSource = self
        cell.attachmentsController.reloadData()

        let documentPickerAction = FUIDocumentPickerAttachmentAction()
        documentPickerAction.delegate = self
        cell.attachmentsController.addAttachmentAction(documentPickerAction)

        return cell
    }
}

extension TestFormTableViewController: FUIDocumentPickerAttachmentActionDelegate {
    var documentPicker: UIDocumentPickerViewController {
      return UIDocumentPick  erViewController(documentTypes: ["public.data"], in: .import)
    }

    func documentPickerAttachmentAction(_ action: FUIDocumentPickerAttachmentAction, didPickFileAt url: URL) {
        if let savedUrl = saveFileToTempFolder(url) {
            self.addAttachmentURL(savedUrl)
        }
        self.tableView.reloadSections(IndexSet(integer:self.attachmentSection), with: .automatic)
   }
}

Attention

The delegate object with type FUIDocumentPickerAttachmentActionDelegate is declared as a weak reference. On deallocation it will be automatically set to nil. To keep it alive as expected, developer should retain the delegate object during its whole execution scope.

See more

open class FUIDocumentPickerAttachmentAction : NSObject, FUIAttachmentAction

extension FUIDocumentPickerAttachmentAction: UIDocumentPickerDelegate

Base inner view for FUIButtonCollectionViewCell.

See more

@MainActor
open class FUIButtonFormView : FUIBaseDrawingView

A UICollectionViewCell subclass that allows a user to read or enter a value, using a date picker.

And an onChangeHandler:

• onChangeHandler: a handler closure that is invoked on changes to the value

Optionally, UITableViewController could provide:

• dateFormatter: A developer-defined UIDateFormatter for transposing between Date type and String.
• datePickerMode: The UIDatePicker.Mode for the Date Picker. The default is .dateAndTime. Note that .countDownTimer mode is not supported. Use the FUIDurationPickerFormCell for duration values.

Example of usage in an application, UICollectionViewController:

let dateFormatter = DateFormatter()
var date: Date?

override func viewDidLoad() {
super.viewDidLoad()

dateFormatter.dateFormat = "dd-MM-yyyy"
self.collectionView.register(FUIDatePickerCollectionViewCell.self, forCellWithReuseIdentifier: FUIDatePickerCollectionViewCell.reuseIdentifier)
// ...
}

override func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {

let cell = collectionView.dequeueReusableCell(withReuseIdentifier: FUIDatePickerCollectionViewCell.reuseIdentifier, for: indexPath) as! FUIDatePickerCollectionViewCell
cell.keyName = "End Date"

cell.dateFormatter = dateFormatter
cell.datePickerMode = .date
cell.value = self.date

// MARK:  implement onChangeHandler
cell.onChangeHandler = { [unowned self] newValue in
self.date = newValue
}

return cell
}

Theming

Supported TEXT class paths:

   fdlFUIDatePickerCollectionViewCell_title
   fdlFUIDatePickerCollectionViewCell_valueText {}

Supported TEXT properties:

   font-color: Color;
   font-style: UIFontTextStyle;

Supported TINTABLE class paths:

   fdlFUIDatePickerCollectionViewCell_valueText {}

Supported TINTABLE properties:

font-color { -selected }: Color;
font-style { -selected }: UIFontTextStyle;

See more

@MainActor
open class FUIDatePickerCollectionViewCell : FUIInlineValidationDrawingCollectionViewCell<FUIDatePickerContentView>

The basic inner view for FUIDatePickerCollectionViewCell.

See more

@MainActor
open class FUIDatePickerContentView : FUITintableDrawingView<FUIControlState>, FUITitleMultiLineComponent, FUIMandatoryFieldComponent, FUIValueComponent, FUIDatePickerComponent

A UICollectionViewCell subclass that allows a user to read or enter a value, using a calendar view.

And an onChangeHandler:

• onChangeHandler: a handler closure that is invoked on changes to the value

Optionally, UITableViewController could provide:

• dateFormatter: A developer-defined UIDateFormatter for transposing between Date type and String.

Example of usage in an application, UICollectionViewController:

var dateRange1: FUIDateRange? = FUIDateRange(startDate: Date(), duration: 1)
let dateFormatter = DateFormatter()

override func viewDidLoad() {
    super.viewDidLoad()

    dateFormatter.dateFormat = "dd-MM-yyyy"
    self.collectionView.register(FUIDateRangePickerCollectionViewCell.self, forCellWithReuseIdentifier: FUIDateRangePickerCollectionViewCell.reuseIdentifier)
    // ...
}

override func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {
    let cell = collectionView.dequeueReusableCell(withReuseIdentifier: FUIDateRangePickerCollectionViewCell.reuseIdentifier, for: indexPath) as! FUIDateRangePickerCollectionViewCell
    cell.title.text = "Customized Date Formatter"

    cell.dateFormatter = dateFormatter
    cell.value = dateRange1

    // MARK:  implement onChangeHandler
    cell.onChangeHandler = { [unowned self] newValue in
        self.dateRange1 = newValue
    }
    return cell
}

Theming

Supported TEXT class paths:

   fdlFUIDateRangePickerCollectionViewCell_title {}
   fdlFUIDateRangePickerCollectionViewCell_mandatoryIndicator {}
   fdlFUIDateRangePickerCollectionViewCell_valueText {}

Supported TEXT properties:

   font-color: Color;
   font-style: UIFontTextStyle;

Supported TINTABLE class paths:

   fdlFUIDateRangePickerCollectionViewCell_valueText {}

Supported TINTABLE properties:

font-color { -selected }: Color;
font-style { -selected }: UIFontTextStyle;

See more

@MainActor
open class FUIDateRangePickerCollectionViewCell : FUIInlineValidationDrawingCollectionViewCell<FUIDateRangePickerContentView>

The basic inner view for FUIDateRangePickerCollectionViewCell and FUIDateRangePickerFormCell.

See more

@MainActor
open class FUIDateRangePickerContentView : FUITintableDrawingView<FUIControlState>, FUITitleMultiLineComponent, FUIMandatoryFieldComponent, FUIValueComponent, FUIDateRangePickerComponent

A UITableViewCell subclass, which allows a user to read or enter a value, using a calendar.

The developer should set the following properties on the cell, in their implementation of UITableViewDataSource cellForRow(at:) function:

• title: The title of the property.
• value: The value of the property, as DateRange

And an onChangeHandler:

• onChangeHandler: a handler closure, which is invoked on changes to the value

Optionally, UITableViewController could provide

• dateFormatter: A developer-defined UIDateFormatter, for transposing between Date type and String.
• isEditable: Indicates if the cell’s value may be modified. Defaults to true.

Color setting:

Setting text color of filter buttons for a state using setTintColor(_:for:) api. Currently .disabled, .normal and selected are supported.

cell.setTintColor(UIColor.red, for: .normal)

The following is an example of usage in an application UITableViewController:

var dateRange1: FUIDateRange? = FUIDateRange(startDate: Date(), duration: 1)
let dateFormatter = DateFormatter()

override func viewDidLoad() {
    super.viewDidLoad()

    dateFormatter.dateFormat = "dd-MM-yyyy"
    self.tableView.register(FUIDateRangePickerFormCell.self, forCellReuseIdentifier: FUIDateRangePickerFormCell.reuseIdentifier)
    // ...
}

override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
    let cell = tableView.dequeueReusableCell(withIdentifier: FUIDateRangePickerFormCell.reuseIdentifier, for: indexPath) as! FUIDateRangePickerFormCell
    cell.title.text = "Customized Date Formatter"

    cell.dateFormatter = dateFormatter
    cell.value = dateRange1

    // MARK:  implement onChangeHandler
    cell.onChangeHandler = { [unowned self] newValue in
        self.dateRange1 = newValue
    }

    return cell
}

Theming

Supported style classes

fdlFUIDateRangePickerFormCell_title
fdlFUIDateRangePickerFormCell_mandatoryIndicator
fdlFUIDateRangePickerFormCell_valueText

See more

@MainActor
open class FUIDateRangePickerFormCell : FUIInlineValidationDrawingTableViewCell<FUIDateRangePickerContentView>, FUIFormCell

Undocumented

See more

@MainActor
public class FUIDateRangePickerModalViewController : UIViewController, FUICalendarViewDelegate

A UICollectionViewCell subclass, which allows a user to read or enter a value, using a duration picker.

The developer should set the following properties on the cell, in their implementation of UICollectionViewDataSource cellForRow(at:) function:

• keyName: The key name of the property
• value: The value of the property, as TimeInterval

And an onChangeHandler:

• onChangeHandler: a handler closure, which is invoked on changes to the value

Optionally, the developer may provide

• minuteInterval: The minute interval to be used in the picker.
• isEditable: Indicates if the cell’s value may be modified. Defaults to true.

Color configuration:

Call setTintColor(_:for:) to configure tint color for disabled, normal, selected UIControlState. Setting tintColor is equivalent to call setTintColor(color, for: UIControlState.normal).

• disabled: Color to be used when control is disabled.
• normal: Color to be used when control is enabled.
• selected: Color to be used when control is selected.

The following is an example of usage in an application UICollectionViewController:

 override func viewDidLoad() {
     super.viewDidLoad()
     self.collectionView.register(FUIDurationPickerCollectionViewCell, forCellReuseIdentifier: FUIDurationPickerCollectionViewCell.reuseIdentifier)
     // ...
 }

 override func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {

     let cell = collectionView.dequeueReusableCell(withReuseIdentifier: FUIDurationPickerCollectionViewCell.reuseIdentifier, for: indexPath) as! FUIDurationPickerCollectionViewCell
     cell.keyName = "Duration"
     cell.value = myObject.eventDuration  // in seconds

     // MARK:  implement an onChangeHandler
     cell.onChangeHandler = { newValue in
        myObject.eventDuration = newValue
     }

     return cell
 }

## Theming Supported style classes

 fdlFUIDurationPickerFormCell
 fdlFUIDurationPickerFormCell_keyLabel
 fdlFUIDurationPickerFormCell_valueLabel
 fdlFUIDurationPickerFormCell_valueLabel_selected

See more

@MainActor
open class FUIDurationPickerCollectionViewCell : FUIInlineValidationDrawingCollectionViewCell<FUIDurationPickerContentView>

Undocumented

See more

@MainActor
open class FUIDurationPickerContentView : FUITintableDrawingView<FUIControlState>, FUITitleMultiLineComponent, FUIMandatoryFieldComponent, FUIValueComponent, FUIDurationPickerComponent

extension FUIDurationPickerContentView: UIPickerViewDelegate

extension FUIDurationPickerContentView: UIPickerViewDataSource

The content view of a form cell.

See more

@MainActor
open class FUIFormCellContentView<ValueView, T, Text> : FUITintableDrawingView<T> where ValueView : UIView, ValueView : Initializable, T : Defaultable, T : Enableable, T : Hashable, Text : FUITextProtocol, Text : Initializable

When FUIListPickerCollectionViewCells are to be used in an application, the application’s implementation of UICollectionViewController that hosts these FUIListPickerCollectionViewCells must be a subclass of this FUIFormCollectionViewController. FUIFormCollectionViewController hides all the complexity and interactions for handling FUIListPickerCollectionViewCell.

The application’s implementation of the UICollectionViewController needs to only implement the following functions:

 class FormCollectionViewCellTestTVC: UICollectionViewController {
    override func viewDidLoad() {
        // MUST: Call viewDidLoad function of super class.
        super.viewDidLoad()

        // Register FUIFormCells that will be used
        self.collectionView.register(FUIListPickerCollectionViewCell.self, forCellWithReuseIdentifier: FUIListPickerCollectionViewCell.reuseIdentifier)
        ...
    }

    override func numberOfSections(in collectionView: UICollectionView) -> Int {
        // Return how many sections are in the collection
        return ...
    }

    override func collectionView(_ collectionView: UICollectionView, numberOfItemsInSection section: Int) -> Int {
        // Return number of items in each section
        return ...
    }

    override func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {
        // Return the cell to be used at the IndexPath specified
        let cell = collectionView.dequeueReusableCell(withReuseIdentifier: FUIListPickerCollectionViewCell.reuseIdentifier, for: indexPath) as! FUIListPickerCollectionViewCell
        cell.keyName = "Pick One"
        cell.isEnabled = true
        // MARK:  implement onChangeHandler
        cell.onChangeHandler = { newValue in
            myObject.title = newValue
        }
        return cell
    }

See more

@MainActor
open class FUIFormCollectionViewController : UICollectionViewController

A UICollectionViewCell subclass that allows a user to read or enter a set of values using a grid of buttons. This is commonly used for composing filters.

The developer should set the following properties on the cell in their implementation of the UICollectionViewDataSource cellForItem(at:) function:

• title: The title of the property.
• value: An array of the selected indexes in the control. Uses the same index as the valueOptions array.
• `valueOptions: A string array of titles for the buttons in the control

And an onChangeHandler:

• onChangeHandler: a handler closure, which is invoked on changes to the value

Optionally, the developer may provide:

• allowsMultipleSelection: Indicates whether multiple buttons may be selected simultaneously (true). If false, the control behaves in “radio” mode. The default is true.
• allowsEmptySelection: Indicates whether the control allows zero items to be selected (true). If false, then once a value has been selected by the developer or user, taps by the user on the last selected item will be ignored instead of deselecting the item. The default is true.
• isEditable: Indicates whether the cell’s value may be modified. The default is true.

The following is an example of usage in an application, UICollectionViewController:

 // optionally, create an array of value option to localized string mappings
  let buttonTitles: [[String: String]] = [["radius": "Distance"], ["price": "Price"], ["rating": "Ratings"], ["avail": "Availability"]]

 // Register FUIFilterFormCollectionViewCell in viewDidLoad() method in the controller.
 override func viewDidLoad() {
     super.viewDidLoad()
     self.collectionView.register(FUIFilterFormCollectionViewCell.self, forCellWithReuseIdentifier:
     FUIFilterFormCollectionViewCell.reuseIdentifier)
 }

 func collectionView(_ collectionView: UICollectionView, cellForItemAt indexPath: IndexPath) -> UICollectionViewCell {
     let cell = collectionView.dequeueReusableCell(withReuseIdentifier: FUIFilterFormCollectionViewCell.reuseIdentifier,
                                                   for: indexPath) as! FUIFilterFormCollectionViewCell

     cell.valueOptions = buttonTitles.flatMap { $0.map { $0.value }}
     cell.title = "Sort By"
     cell.value = [1]
     cell.allowsMultipleSelection = true
     cell.allowsEmptySelection = false

     // MARK:  implement onChangeHandler
     cell.onChangeHandler = { [weak self] newValue in
        self.applyFilter(forDimensions: newValue)      // here, the cell input is set to a filter function
     }

    return cell
 }

## Theming Supported style classes:

 fdlFUIFilterFormCollectionViewCell
 fdlFUIFilterFormCollectionViewCell_title
 fdlFUIFilterFormCollectionViewCell_item_contentView
 fdlFUIFilterFormCollectionViewCell_item_titleLabel
 fdlFUIFilterFormCollectionViewCell_item_contentView_selected
 fdlFUIFilterFormCollectionViewCell_item_titleLabel_selected

See more