Inherits from NSObject
Declared in TKEntityProperty.h

Overview

This class represents a model of a property.

Tasks

Properties

autoCompleteDisplayMode

The type of the property.

@property (nonatomic) TKAutoCompleteDisplayMode autoCompleteDisplayMode

Declared In

TKEntityProperty.h

converter

A converter that adopts TKDataFormConverter protocol.

@property (nonatomic, strong) id<TKDataFormConverter> converter

Declared In

TKEntityProperty.h

displayName

The name that will be displayed in TKDataForm.

@property (nonatomic, strong) NSString *displayName

Declared In

TKEntityProperty.h

editorClass

The editor class.

@property (nonatomic) Class editorClass

Declared In

TKEntityProperty.h

errorImage

An image that will be displayed if the property value fail validation.

@property (nonatomic, strong) UIImage *errorImage

Declared In

TKEntityProperty.h

errorMessage

A feedback message used to show when validation fails.

@property (nonatomic, copy) NSString *errorMessage

Declared In

TKEntityProperty.h

formatter

A formatter that will be used to format the display value.

@property (nonatomic, strong) NSFormatter *formatter

Declared In

TKEntityProperty.h

groupName

The name of the group to which this property will belong.

@property (nonatomic) NSString *groupName

Declared In

TKEntityProperty.h

hidden

Determines if the property should be visible in the data form.

@property (nonatomic) BOOL hidden

Declared In

TKEntityProperty.h

hintText

A hint text.

@property (nonatomic, strong) NSString *hintText

Declared In

TKEntityProperty.h

image

A UIImage that will be displayed next to the title label of the property.

@property (nonatomic, strong) UIImage *image

Declared In

TKEntityProperty.h

index

The index at which a property will be placed in its group.

@property (nonatomic) NSUInteger index

Declared In

TKEntityProperty.h

isNullable

Determines if null value is allowed. Default values us YES.

@property (nonatomic) BOOL isNullable

Declared In

TKEntityProperty.h

isValid

Indicates indicates if the property has passed validation (read-only).

@property (nonatomic, readonly) BOOL isValid

Declared In

TKEntityProperty.h

layoutInfo

Layout metadata for the property’s editor.

@property (nonatomic, strong) TKLayoutInfo *layoutInfo

Declared In

TKEntityProperty.h

name

The name of the source property.

@property (nonatomic, strong, readonly) NSString *name

Declared In

TKEntityProperty.h

originalValue

The last committed value.

@property (nonatomic, strong, readonly) id originalValue

Declared In

TKEntityProperty.h

owner

The TKDataFormEntity to which the property belongs (read-only).

@property (nonatomic, weak, readonly) TKEntity *owner

Declared In

TKEntityProperty.h

pickersUseIndexValue

Determnes if picker editors should use the item’s index as value. Default is YES.

@property (nonatomic) BOOL pickersUseIndexValue

Declared In

TKEntityProperty.h

positiveImage

An image that will be displayed if the property value pass validation.

@property (nonatomic, strong) UIImage *positiveImage

Declared In

TKEntityProperty.h

positiveMessage

A feedback message used to show when validation succeeds.

@property (nonatomic, copy) NSString *positiveMessage

Declared In

TKEntityProperty.h

propertyClass

The class of the source property. Will be nil if it is a primitive (read-only).

@property (nonatomic, strong, readonly) Class propertyClass

Declared In

TKEntityProperty.h

range

A TKRange object that sets min and max values.

@property (nonatomic, strong) TKRange *range

Declared In

TKEntityProperty.h

readOnly

Determines if the property could be edited in the data form.

@property (nonatomic) BOOL readOnly

Declared In

TKEntityProperty.h

required

Indicates whether a valid property value is required to pass entity validation.

@property (nonatomic) BOOL required

Declared In

TKEntityProperty.h

step

Determines the step used for value changes.

@property (nonatomic, strong) NSNumber *step

Declared In

TKEntityProperty.h

type

The type of the property.

@property (nonatomic) TKEntityPropertyType type

Declared In

TKEntityProperty.h

validators

An array of validators that adopt the TKDataFormValidator protocol that will be used to validate the property.

@property (nonatomic, strong) NSArray *validators

Declared In

TKEntityProperty.h

valueCandidate

The value of the property model. This value may still not be committed.

@property (nonatomic, strong) id valueCandidate

Declared In

TKEntityProperty.h

valuesProvider

NSArray instance that specifies the available values.

@property (nonatomic, strong) NSArray *valuesProvider

Declared In

TKEntityProperty.h

wasValidated

Shows if the property has gone throught validation.

@property (nonatomic, readonly) BOOL wasValidated

Declared In

TKEntityProperty.h

Instance Methods

commit

Commits the property value. Returns true if the property value passes validation.

- (BOOL)commit

Declared In

TKEntityProperty.h

initWithEntity:forPropertyName:

Initializes a new instance of TKEntityProperty with specific property name and owner.

- (instancetype)initWithEntity:(TKEntity *)owner forPropertyName:(NSString *)propertyName

Parameters

owner

The entity which owns this property.

propertyName

The property name.

Declared In

TKEntityProperty.h

validate

Validates the property value.

- (BOOL)validate

Declared In

TKEntityProperty.h