Mac Developer Library

Developer

AppKit Framework Reference NSTokenFieldDelegate Protocol Reference

Options
Deployment Target:

On This Page
Language:

NSTokenFieldDelegate

The NSTokenFieldDelegate protocol defines the optional methods implemented by delegates of NSTokenField objects.

Inheritance


Not Applicable

Import Statement


Swift

import AppKit

Objective-C

@import AppKit;

Availability


Available in OS X v10.6 and later.
  • Allows the delegate to provide a string to be displayed as a proxy for the given represented object.

    Declaration

    Swift

    optional func tokenField(_ tokenField: NSTokenField, displayStringForRepresentedObject representedObject: AnyObject) -> String?

    Objective-C

    - (NSString *)tokenField:(NSTokenField *)tokenField displayStringForRepresentedObject:(id)representedObject

    Parameters

    tokenField

    The token field that sent the message.

    representedObject

    A represented object of the token field.

    Return Value

    The string to be used as a proxy for representedObject. If you return nil or do not implement this method, then representedObject is displayed as the string.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.4 and later.

    Available as part of an informal protocol prior to OS X v10.6.

  • Allows the delegate to return the token style for editing the specified represented object.

    Declaration

    Swift

    optional func tokenField(_ tokenField: NSTokenField, styleForRepresentedObject representedObject: AnyObject) -> NSTokenStyle

    Objective-C

    - (NSTokenStyle)tokenField:(NSTokenField *)tokenField styleForRepresentedObject:(id)representedObject

    Parameters

    tokenField

    The token field that sent the message.

    representedObject

    A represented object of the token field.

    Return Value

    The style that should be used to display the representedObject. Possible values are shown in NSTokenStyle Values.

    Discussion

    If the delegate implements this method and returns an NSTokenStyle that differs from the style set by setTokenStyle:, the value the delegate returns is preferred.

    If the delegate does not implement this method, the token field’s tokenStyle is used.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.4 and later.

    Available as part of an informal protocol prior to OS X v10.6.

  • Allows the delegate to provide an array of appropriate completions for the contents of the receiver.

    Declaration

    Swift

    optional func tokenField(_ tokenField: NSTokenField, completionsForSubstring substring: String, indexOfToken tokenIndex: Int, indexOfSelectedItem selectedIndex: UnsafeMutablePointer<Int>) -> [AnyObject]?

    Objective-C

    - (NSArray *)tokenField:(NSTokenField *)tokenField completionsForSubstring:(NSString *)substring indexOfToken:(NSInteger)tokenIndex indexOfSelectedItem:(NSInteger *)selectedIndex

    Parameters

    tokenField

    The token field where editing is occurring.

    substring

    The partial string that is to be completed.

    tokenIndex

    The index of the token being edited.

    selectedIndex

    Optionally, you can return by-reference an index into the returned array that specifies which of the completions should be initially selected. If none are to be selected, return by reference -1.

    Return Value

    An array of strings that are possible completions.

    Discussion

    If the delegate does not implement this method, no completions are provided.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.4 and later.

    Available as part of an informal protocol prior to OS X v10.6.

  • Allows the delegate to provide a string to be edited as a proxy for a represented object.

    Declaration

    Swift

    optional func tokenField(_ tokenField: NSTokenField, editingStringForRepresentedObject representedObject: AnyObject) -> String?

    Objective-C

    - (NSString *)tokenField:(NSTokenField *)tokenField editingStringForRepresentedObject:(id)representedObject

    Parameters

    tokenField

    The token field that sent the message.

    representedObject

    A represented object of the token field.

    Return Value

    A string that’s an editable proxy of the represented object, or nil if the token should not be editable.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.4 and later.

    Available as part of an informal protocol prior to OS X v10.6.

  • Allows the delegate to provide a represented object for the given editing string.

    Declaration

    Swift

    optional func tokenField(_ tokenField: NSTokenField, representedObjectForEditingString editingString: String) -> AnyObject

    Objective-C

    - (id)tokenField:(NSTokenField *)tokenField representedObjectForEditingString:(NSString *)editingString

    Parameters

    tokenField

    The token field that sent the message.

    editingString

    The edited string representation of a represented object.

    Return Value

    A represented object that is displayed rather than the editing string.

    Discussion

    If your application uses some object other than an NSString for their represented objects, you should return a new, autoreleased instance of that object from this method.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.4 and later.

    Available as part of an informal protocol prior to OS X v10.6.

  • Allows the delegate to validate the tokens to be added to the receiver at a particular location.

    Declaration

    Swift

    optional func tokenField(_ tokenField: NSTokenField, shouldAddObjects tokens: [AnyObject], atIndex index: Int) -> [AnyObject]

    Objective-C

    - (NSArray *)tokenField:(NSTokenField *)tokenField shouldAddObjects:(NSArray *)tokens atIndex:(NSUInteger)index

    Parameters

    tokenField

    The token field that sent the message.

    tokens

    An array of tokens to be inserted in the receiver at index.

    index

    The index of the receiver in which the array of tokens to be validated (tokens) will be inserted.

    Return Value

    An array of validated tokens.

    Discussion

    The delegate can return the array unchanged or return a modified array of tokens. To reject the add completely, return an empty array. Returning nil causes an error.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.4 and later.

    Available as part of an informal protocol prior to OS X v10.6.

  • Allows the delegate to return an array of objects representing the data read from the specified pasteboard.

    Declaration

    Swift

    optional func tokenField(_ tokenField: NSTokenField, readFromPasteboard pboard: NSPasteboard) -> [AnyObject]?

    Objective-C

    - (NSArray *)tokenField:(NSTokenField *)tokenField readFromPasteboard:(NSPasteboard *)pboard

    Parameters

    tokenField

    The token field that sent the message.

    pboard

    The pasteboard from which to read the represented objects.

    Return Value

    An array of represented objects created from the pasteboard data.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.4 and later.

    Available as part of an informal protocol prior to OS X v10.6.

  • Sent so the delegate can write represented objects to the pasteboard corresponding to a given array of display strings.

    Declaration

    Swift

    optional func tokenField(_ tokenField: NSTokenField, writeRepresentedObjects objects: [AnyObject], toPasteboard pboard: NSPasteboard) -> Bool

    Objective-C

    - (BOOL)tokenField:(NSTokenField *)tokenField writeRepresentedObjects:(NSArray *)objects toPasteboard:(NSPasteboard *)pboard

    Parameters

    tokenField

    The token field that sent the message.

    objects

    An array of represented objects associated with the token field.

    pboard

    The pasteboard to which to write the represented objects.

    Return Value

    YEStrue if the delegate writes the represented objects to the pasteboard, NOfalse otherwise. If NOfalse, the token field writes the display strings to the NSStringPboardType pasteboard.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.4 and later.

    Available as part of an informal protocol prior to OS X v10.6.

  • Allows the delegate to specify whether the given represented object provides a menu.

    Declaration

    Swift

    optional func tokenField(_ tokenField: NSTokenField, hasMenuForRepresentedObject representedObject: AnyObject) -> Bool

    Objective-C

    - (BOOL)tokenField:(NSTokenField *)tokenField hasMenuForRepresentedObject:(id)representedObject

    Parameters

    tokenField

    The token field that sent the message.

    representedObject

    A represented object of the token field.

    Return Value

    YEStrue if the represented object has a menu, NOfalse otherwise.

    Discussion

    By default tokens in a token field have no menus.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.4 and later.

    Available as part of an informal protocol prior to OS X v10.6.

  • Allows the delegate to provide a menu for the specified represented object.

    Declaration

    Swift

    optional func tokenField(_ tokenField: NSTokenField, menuForRepresentedObject representedObject: AnyObject) -> NSMenu?

    Objective-C

    - (NSMenu *)tokenField:(NSTokenField *)tokenField menuForRepresentedObject:(id)representedObject

    Parameters

    tokenField

    The token field that sent the message.

    representedObject

    A represented object of the token field.

    Return Value

    The menu associated with the represented object.

    Discussion

    The returned menu should be autoreleased. By default tokens in a token field do not return menus.

    Import Statement

    Objective-C

    @import AppKit;

    Swift

    import AppKit

    Availability

    Available in OS X v10.4 and later.

    Available as part of an informal protocol prior to OS X v10.6.