TKAutoCompleteTextView Class Reference
Inherits from | TKView : UIView |
Declared in | TKAutoCompleteTextView.h |
Overview
TkAutoCompleteTextView provides means to perform easy filtering of data and completion suggestioning according to typed text by the user. Provides tokenizing, layouts, completion modes, easy customizations.
Tasks
-
dataSource
property -
delegate
property -
tokeninzingSymbols
property -
contentView
property -
textField
property -
showCloseButton
property -
closeButton
property -
closeButtonInsets
property -
noResultsLabel
property -
imageView
property -
imageViewInsets
property -
titleLabel
property -
suggestionViewOutOfFrame
property -
suggestionView
property -
displayMode
property -
suggestMode
property -
layoutMode
property -
allowTokenHighlighting
property -
allowCustomTokens
property -
readOnly
property -
showAllItemsInitially
property -
tokenInset
property -
autocompleteInset
property -
currentWrapHeight
property -
suggestionViewHeight
property -
maximumWrapHeight
property -
minimumCharactersToSearch
property -
maximumTokensCount
property -
– addToken:
-
– insertToken:atIndex:
-
– removeToken:
-
– removeTokenAtIndex:
-
– removeAllTokens
-
– tokens
-
– tokenAtIndex:
-
– resetAutocomplete
-
– resetAutocompleteState
-
– completeSuggestionViewPopulation:
Properties
allowCustomTokens
Defines whether or not adding tokenizing text outside of the suggestions is allowed.
@property (nonatomic) BOOL allowCustomTokens
Declared In
TKAutoCompleteTextView.h
allowTokenHighlighting
Indicated whether highlighting of tokens is allowd. Default if YES.
@property (nonatomic) BOOL allowTokenHighlighting
Declared In
TKAutoCompleteTextView.h
autocompleteInset
Defines he inset of the autocomplete.
@property (nonatomic) CGFloat autocompleteInset
Declared In
TKAutoCompleteTextView.h
closeButton
The remove button used to clear the input.
@property (nonatomic, strong, readonly, nonnull) TKAutoCompleteClearButton *closeButton
Declared In
TKAutoCompleteTextView.h
closeButtonInsets
The insets for the remove button used to clear the input.
@property (nonatomic) UIEdgeInsets closeButtonInsets
Declared In
TKAutoCompleteTextView.h
contentView
The view holding the base autocomplete components.
@property (nonatomic, strong, readonly, nonnull) TKView *contentView
Declared In
TKAutoCompleteTextView.h
currentWrapHeight
Returns the current height of the token area of the autocomplete.
@property (nonatomic, readonly) CGFloat currentWrapHeight
Declared In
TKAutoCompleteTextView.h
dataSource
TKAutoCompleteDataSource object providing means to filter the suggestion items and populate the suggestion view.
@property (nonatomic, weak, nullable) id<TKAutoCompleteDataSource> dataSource
Declared In
TKAutoCompleteTextView.h
delegate
TKAutoCompleteDelegate object allows easy managing of the autocomplete components and the interaction with them.
@property (nonatomic, weak, nullable) id<TKAutoCompleteDelegate> delegate
Declared In
TKAutoCompleteTextView.h
displayMode
Defines the display mode.
@property (nonatomic) TKAutoCompleteDisplayMode displayMode
Declared In
TKAutoCompleteTextView.h
imageView
The image view located in the top left side of the autocomplete. By default is not presented.
@property (nonatomic, strong, readonly, nonnull) UIImageView *imageView
Declared In
TKAutoCompleteTextView.h
imageViewInsets
The insets for the image view located in the top left side of the autocomplete. By default is not presented.
@property (nonatomic) UIEdgeInsets imageViewInsets
Declared In
TKAutoCompleteTextView.h
layoutMode
Defines the layout mode.
@property (nonatomic) TKAutoCompleteLayoutMode layoutMode
Declared In
TKAutoCompleteTextView.h
maximumTokensCount
Sets the maximum tokens count.
@property (nonatomic) NSUInteger maximumTokensCount
Declared In
TKAutoCompleteTextView.h
maximumWrapHeight
Sets the maximum height of the autocomplete in TKAutoCompleteLayoutModeWrap.
@property (nonatomic) CGFloat maximumWrapHeight
Declared In
TKAutoCompleteTextView.h
minimumCharactersToSearch
Sets the minimum count of typed characters by which to be performd the suggestioning. The default value is 0.
@property (nonatomic) NSUInteger minimumCharactersToSearch
Declared In
TKAutoCompleteTextView.h
noResultsLabel
The label showed if no suggestion are presented. Showed in TKAutoCompleteSuggestModeSuggestAppend and TKAutoCompleteSuggestModeSuggest mode.
@property (nonatomic, strong, readonly, nonnull) UILabel *noResultsLabel
Declared In
TKAutoCompleteTextView.h
readOnly
Defines whether or not the aucomplete as read only.
@property (nonatomic) BOOL readOnly
Declared In
TKAutoCompleteTextView.h
showAllItemsInitially
Defines whether or not all items to be showed initially.
@property (nonatomic) BOOL showAllItemsInitially
Declared In
TKAutoCompleteTextView.h
showCloseButton
Controls whether the remove button used to clear the input should be visible.
@property (nonatomic) BOOL showCloseButton
Declared In
TKAutoCompleteTextView.h
suggestMode
Defines the suggest mode.
@property (nonatomic) TKAutoCompleteSuggestMode suggestMode
Declared In
TKAutoCompleteTextView.h
suggestionView
The view which represents the collection of filtered suggestions. Allows customization as well as exchange with custom view.
@property (nonatomic, weak, nullable) UIView<TKAutoCompleteSuggestViewDelegate> *suggestionView
Declared In
TKAutoCompleteTextView.h
suggestionViewHeight
Defines the height of the suggestion view.
@property (nonatomic) CGFloat suggestionViewHeight
Declared In
TKAutoCompleteTextView.h
suggestionViewOutOfFrame
Indicates if the suggestion view is subview of the autocomplete or not. Defalut value is NO.
@property (nonatomic, assign) BOOL suggestionViewOutOfFrame
Declared In
TKAutoCompleteTextView.h
textField
The autocomplete textfield.
@property (nonatomic, strong, readonly, nonnull) UITextField *textField
Declared In
TKAutoCompleteTextView.h
titleLabel
The title view located in the top left side of the autocomplete. By default is not presented.
@property (nonatomic, strong, readonly, nonnull) UILabel *titleLabel
Declared In
TKAutoCompleteTextView.h
tokenInset
Defines he inset of the tokens.
@property (nonatomic) CGFloat tokenInset
Declared In
TKAutoCompleteTextView.h
Instance Methods
addToken:
Adds token.
- (void)addToken:(TKAutoCompleteToken *__nonnull)token
Parameters
- token
The TKAutoCompleteToken object model.
Declared In
TKAutoCompleteTextView.h
completeSuggestionViewPopulation:
Completes the async population of the suggestion view. Used only with the dataSource autoComplete:autocomplete completionsForString:input method.
- (void)completeSuggestionViewPopulation:(NSArray *__nullable)suggestions
Parameters
- suggestions
The suggestions which are going to be presented.
Declared In
TKAutoCompleteTextView.h
insertToken:atIndex:
Inserts token at specific index.
- (void)insertToken:(TKAutoCompleteToken *__nonnull)token atIndex:(NSInteger)index
Declared In
TKAutoCompleteTextView.h
removeToken:
Removes token.
- (void)removeToken:(TKAutoCompleteToken *__nonnull)token
Parameters
- token
The TKAutoCompleteToken object model.
Declared In
TKAutoCompleteTextView.h
removeTokenAtIndex:
Removes token at specific index.
- (void)removeTokenAtIndex:(NSInteger)index
Parameters
- index
Token index.
Declared In
TKAutoCompleteTextView.h
resetAutocomplete
Resets the autocomplete.
- (void)resetAutocomplete
Declared In
TKAutoCompleteTextView.h
resetAutocompleteState
Resets the autocomplete to initial state & removes all added tokens.
- (void)resetAutocompleteState
Declared In
TKAutoCompleteTextView.h