FxField

Enumeration or other hashable unique identifer for this field

String representation of id.

Field list that owns theis field.

Construct Field with unique identifier. Construction usually occurs in fields.add().

fields.add(.zip)

Defines the field title. Titles may be bound to labels and are also used for error message generation.

fields.add("zip").title("Zip Code")

Undocumented

Adds the specified validation rule to the set of field validation rules.

fields.add("zip").validate(FxRules.zipcode)

Validation rules are only checked when field values are not empty. Use .required() to force validation to occur.

Constructs and adds an unnamed validation rule to the set of field validation rules.

fields.add("zip").validate(errorZip) { $0.asText.count == 5 || $0.asText.count == 10 }

Validation fuctions are only checked when field values are not empty. Use .required() to force validation to occur.

Constructs and adds the specified validation rule to the set of field validation rules.

fields.add("zip").validate(name: "zip", message: errorZip) { $0.asText.count == 5 || $0.asText.count == 10 }

Validation fuctions are only checked when field values are not empty. Use .required() to force validation to occur.

Returns true if required rule or validation rules exist.

Removes all validation rules.

Removes the named rule from the list of validation rules.

Returns true if field is valid and all validation rules passed.

Note: Calling isValid will set or clear the field error message value based on validation success.

Checks all validation rules. If validation fails error message will be returned, not set.

Validation triggers are used to fire validation rules when a given event occurs.

field.setValidationTrigger(field.rx.isChanged)

Defines text formatter to be used for rx.text binding.

fields.add(.state).format(FxTextFormatUppercased())

Gets and sets current formatter.

Returns the field’s current value as formatted text.

Defines validation rule that states field text values must be at least N characters long.

fields.add("zip").min(length: 5)

Returns current maxLength value. Changing updates the validation rule appropriately.

Sets initial value of field. Value will be bound to view or control by FxForm.

fields.add(.amount).value(contact.amount)
fields.add(.zip).value(contact.zip)
fields.add(.message).value("This is a message.")
fields.add(.agrees).value(false)

Generic function returns current value as? type T. If T is unknown type returned value will be nil.

Clears the current value.

Returns true if current value is empty.

Returns current value as Bool.

Returns current value as Bool or nil if value is false.

Returns current value as Double.

Returns current value as Double or nil if value is empty.

Returns current value as Int.

Returns current value as Int or nil if value is empty.

Returns current value as String.

Returns current value as String or nil if value is empty.

Gets the current error message. Value will be propagated to bound view, if any.

Undocumented

Defines the Enabled flag state for later binding to a control.

fields.add("zip").enabled(true)

Enabled status will not be automatically bound to view or control unless this method is called during the field definition phase prior to field binding.

Gets and sets the current enabled state. Value may be propagated to bound view.

Defines the Hidden flag state for later binding to a view or control.

Note that hidden fields are not validated.

fields.add("zip").hidden(true)

Hidden status will not be automatically bound to view or control unless this method is called during the field definition phase prior to field binding.

Gets and sets the current hidden state. Value may be propagated to bound view.

Called from FxForm.bind() to perform standard value, error, and attribute bindings to the previously assigned view.

Note: Users should not need to call this function themselves.

Convenience method to bind our error message to a specfifc label.

bindErrorMessage(label)

Convenience method to bind our isEnabled flag to a specfifc control.

field.bindIsEnabled(.zipTextField)

Convenience method to bind our isHidden flag to a specfifc view.

field.bindIsHidden(.zipTextField)

Convenience method to bind our title to a specfifc label.

form.autoBind()
    .bindTitle(.zip, zipLabel)

Convenience method to bind our value to a specfifc button title.

form.autoBind()
    .bindValue(.zip, myButton)

Convenience method to bind our value to a specfifc label.

form.autoBind()
    .bindTitle(.zip, zipLabel)

Defines validation rule that states field text values may not be more than N characters long.

fields.add("zip").max(length: 5)

Returns current maxLength value. Changing updates the validation rule appropriately.

Defines validation rule that the field value is optional. Will clear the Required validation rule.

fields.add("zip").optional()

Defines validation rule that indicates value must not be nil or empty. Will clear the Optional validation rule.

fields.add("state").required(length: 2)
fields.add("zip").required()

Undocumented

Defines the placeholder value that will be passed to the bound textfield.

fields.add("zip").placeholder("00000-0000")

This value will not be automatically bound to view or control unless this method is called during the field definition phase prior to field binding.

Undocumented

This observable automatically fires whenever the base value is set or updated

Defines the error message that should be returned if a validation rule fails.

fields.add("zip").required().message("Zip code is required")

Note that this message overrides any individual validation rule messages.

Gets and sets current message value. Setting may propagate value to bound views.

Defines keyboard type for later binding to textfield.

fields.add("zip").keyboard(.numberpad)

Note value will not be automatically bound to view or control unless this method is called during the field definition phase prior to field binding.

Gets and sets current keyboard value. Setting may propagate value to bound views.