NSTokenFieldCell Class Reference
| Inherits from | |
| Conforms to | |
| Framework | /System/Library/Frameworks/AppKit.framework |
| Availability | Available in OS X v10.4 and later. |
| Companion guide | |
| Declared in | NSTokenFieldCell.h |
Overview
NSTokenFieldCell is a subclass of NSTextFieldCell that provides tokenized editing of an array of objects similar to the address field in the Mail application. The objects may be strings or objects that can be represented as strings. A single token field cell can be presented in an NSTokenField control.
Tasks
Managing the Token Style
Managing the Tokenizing Character Set
Configuring the Completion Delay
Managing the Delegate
Class Methods
defaultCompletionDelay
Returns the default completion delay.
Return Value
The default completion delay.
Discussion
The default completion delay is 0.
Availability
- Available in OS X v10.4 and later.
See Also
Declared In
NSTokenFieldCell.hdefaultTokenizingCharacterSet
Returns the default tokenizing character set.
Return Value
The default tokenizing character set.
Discussion
The default tokenizing character set contains the single character “,”.
Availability
- Available in OS X v10.4 and later.
Declared In
NSTokenFieldCell.hInstance Methods
completionDelay
Returns the receiver’s completion delay.
Return Value
The receiver’s completion delay.
Availability
- Available in OS X v10.4 and later.
Declared In
NSTokenFieldCell.hdelegate
Returns the receiver’s delegate.
Return Value
The receiver’s delegate.
Availability
- Available in OS X v10.4 and later.
See Also
Declared In
NSTokenFieldCell.hsetCompletionDelay:
Sets the receiver’s completion delay to a given delay.
Parameters
- delay
The delay for the receiver.
Availability
- Available in OS X v10.4 and later.
Declared In
NSTokenFieldCell.hsetDelegate:
Sets the receiver’s delegate.
Parameters
- anObject
The delegate for the receiver.
Availability
- Available in OS X v10.4 and later.
See Also
Declared In
NSTokenFieldCell.hsetTokenizingCharacterSet:
Sets the receiver’s tokenizing character set to a given character set.
Parameters
- characterSet
The tokenizing character set for the receiver.
Availability
- Available in OS X v10.4 and later.
Declared In
NSTokenFieldCell.hsetTokenStyle:
Sets the token style of the receiver.
Parameters
- style
The token style for the receiver. The valid values are described in “NSTokenStyle.”
Availability
- Available in OS X v10.4 and later.
See Also
Declared In
NSTokenFieldCell.htokenizingCharacterSet
Returns the receiver’s tokenizing character set.
Return Value
The receiver’s tokenizing character set.
Availability
- Available in OS X v10.4 and later.
Declared In
NSTokenFieldCell.htokenStyle
Returns the receiver’s token style.
Return Value
The receiver’s token style. The valid values are described in “NSTokenStyle.”
Availability
- Available in OS X v10.4 and later.
See Also
Declared In
NSTokenFieldCell.hConstants
NSTokenStyle
The NSTokenStyle constants define how tokens are displayed and editable in the NSTokenFieldCell. These values are used by tokenStyle, setTokenStyle: and the delegate method tokenFieldCell:styleForRepresentedObject:.
enum {
NSDefaultTokenStyle,
NSPlainTextTokenStyle,
NSRoundedTokenStyle
};
typedef NSUInteger NSTokenStyle;
Constants
NSDefaultTokenStyleStyle best used for keyword type tokens.
Available in OS X v10.4 and later.
Declared in
NSTokenFieldCell.h.NSPlainTextTokenStyleStyle to use for data you want represented as plain-text and without any token background.
Available in OS X v10.4 and later.
Declared in
NSTokenFieldCell.h.NSRoundedTokenStyleStyle best used for address type tokens.
Available in OS X v10.4 and later.
Declared in
NSTokenFieldCell.h.
© 2009 Apple Inc. All Rights Reserved. (Last updated: 2009-05-24)