FUITextFieldContentView

@MainActor
open class FUITextFieldContentView : FUIFormCellContentView<FUITextField, FUIControlState, FUIText>, FUITitleComponent, FUIMandatoryFieldComponent, FUIValueComponent, FUIPlaceholderComponent, FUISubtitleComponent, FUIPropertyFormCell, UITextFieldDelegate

The content view of an FUITextFieldFormCell.

  • Declaration

    Swift

    @MainActor
public var validationMessage: String?

  • Declaration

    Swift

    @MainActor
public var validationView: FUIInlineValidationView!

  • The key name of the property.

    Declaration

    Swift

    @MainActor
open var keyName: String? { get set }

  • The value type is String.

    Declaration

    Swift

    public typealias ValueType = String

  • The value of the property.

    Declaration

    Swift

    @MainActor
open var value: String { get set }

  • The FUITextField holds the value string.

    Declaration

    Swift

    @MainActor
public var valueTextField: FUITextField { get }

  • The placeholder for the value text field.

    Declaration

    Swift

    @MainActor
public let placeholder: FUIText

  • Indicates if the value of the cell can be changed or not. For FUISimplePropertyFormCell this property is always false.

    Declaration

    Swift

    @MainActor
open var isEditable: Bool { get set }

  • Implementation of change handler. It is invoked on changes to the value property.

    Declaration

    Swift

    @MainActor
open var onChangeHandler: ((String) -> Void)?

  • If isTrackingLiveChanges == true, then onChangeHandler will be invoked for every letter entered. Otherwise, onChangeHandler will be invoked only after the user taps the “Done” key, or the field resigns first responder.

    The default value is false.

    Declaration

    Swift

    @MainActor
open var isTrackingLiveChanges: Bool

  • The placeholder text for the value text field.

    Declaration

    Swift

    @available(*, deprecated, message: "This property is deprecated.  Please use `placeholder.text`.")
@IBInspectable
@MainActor
public var placeholderText: String? { get set }

  • This is the maximum length of the text in the valueView if maxValueTextLength is greater than 0.

    If the text length reaches this limit when isCharCountEnabled is false, the user cannot enter more text. Note: If the user pastes a string and the length plus the current text length is greater than the limit, the insert is rejected. Partial strings are not accepted in the text field.

    If the text length reaches this limit when isCharCountEnabled is true, the user cannot enter more text if allowsBeyondLimit is false. In the case where allowsBeyondLimit is true, the user can enter more text beyond the limitation in the error state.

    The default value for maxValueTextLength is 0, which means no limit.

    Declaration

    Swift

    @MainActor
public var maxValueTextLength: Int { get set }

  • If isCharCountEnabled is true, it will show the character count and the maxValueTextLength. The character count number will be updated during editing.

    The default value is false.

    Declaration

    Swift

    @MainActor
public var isCharCountEnabled: Bool { get set }

  • If showsErrorInValidationMsg is true, it will show the character count error message in the validationMessage of the FUITextFieldFormCell. Otherwise, the error message will be shown in the errorView in the same layout as the hintView.

    The default is true.

    Declaration

    Swift

    @MainActor
public var showsErrorInValidationMsg: Bool { get set }

  • If allowsBeyondLimit is true, it will allow the user to input continuously even after maxValueTextLength is reached. It will be in an error state with an error message and a semantic negative color. If allowsBeyondLimit is false, it will auto-stop user input when maxValueTextLength is reached.

    The default value is false.

    Declaration

    Swift

    @MainActor
public var allowsBeyondLimit: Bool { get set }

  • The error text of the cell.

    Declaration

    Swift

    @MainActor
public var errorMessage: FUIText { get set }

  • If hasError is true, it will be in an error state with an error message and a semantic negative color.

    The default value is false.

    Declaration

    Swift

    @MainActor
public var hasError: Bool { get set }

  • The error message when the character count limitation is reached.

    Declaration

    Swift

    @MainActor
public var charCountReachLimitMsg: String { get set }

  • The error message when the character count exceeds the limitation.

    Declaration

    Swift

    @MainActor
public var charCountBeyondLimitMsg: String { get set }

  • The formatter for the UITextField in this cell.

    Currently, SAPFiori provides two implementations:

    Declaration

    Swift

    @MainActor
open var formatter: FUIFormattedStringEditing? { get set }

  • An FUIButton for an alternative text entry method. Implement the didSelectHandler to manage alternative entry. Also, supply an image to display on the button.

    Declaration

    Swift

    @MainActor
public let alternativeInputButton: FUIButton

  • A Bool to enable alternative entry. The cell must also have isEditable set to true to display the button. The button will hide while text entry is in progress. The default value is false.

    Declaration

    Swift

    @MainActor
open var isAlternativeInputEnabled: Bool { get set }

  • The customized text alignment for the valueTextField,

    If this property is nil, the default alignment is used.

    • For left to right languages and the cell is editable, the default is left aligned.
    • For left to right languages and the cell is not editable, the default is right aligned.
    • For righ to left languages and the cell is editable, the default is rignt aligned.
    • For righ to left languages and the cell is not editable, the default is left aligned.

    Declaration

    Swift

    @MainActor
open var valueTextAlignment: NSTextAlignment?

Properties added in v2

  • The subtitle text of the cell.

    Declaration

    Swift

    @MainActor
public let subtitle: FUIText

  • Indicates if the cell is read-only or not.

    The default value is false.

    Declaration

    Swift

    @MainActor
open var isReadOnly: Bool { get set }

  • Indicates whether the cell is a mandatory field.

    The default value is false.

    Declaration

    Swift

    @MainActor
open var isRequired: Bool { get set }

  • Indicates that the cell is a mandatory field.

    The default value is *.

    Declaration

    Swift

    @MainActor
public var mandatoryIndicator: FUIText { get set }

  • Indiccates if to hide the read-only hint or not.

    A default hint is provided when this cell’s isReadOnly is true unless this property is true. The default is false, means the default read-only hint will be shown when isReadOnly is true.

    Declaration

    Swift

    @MainActor
open var hidesReadOnlyHint: Bool { get set }

UITextFieldDelegate

  • Method determining the type of presented keyboard

    Declaration

    Swift

    @MainActor
open var keyboardType: UIKeyboardType { get set }