CPTokenField Class Reference

#import <CPTokenField.h>

Inheritance diagram for CPTokenField:

Instance Methods
(BOOL)	- becomeFirstResponder
(int)	- buttonType
(void)	- cancelOperation:
(CPTimeInterval)	- completionDelay
(void)	- deleteBackward:
(void)	- deleteForward:
(void)	- encodeWithCoder:
(id)	- initWithCoder:
(id)	- initWithFrame:
(void)	- insertNewline:
(void)	- insertTab:
(void)	- insertText:
(void)	- keyDown:
(void)	- keyUp:
(void)	- layoutSubviews
(void)	- mouseDown:
(void)	- mouseUp:
(void)	- moveDown:
(void)	- moveLeft:
(void)	- moveLeftAndModifySelection:
(void)	- moveRight:
(void)	- moveRightAndModifySelection:
(void)	- moveUp:
(id)	- objectValue
(BOOL)	- performKeyEquivalent:
(BOOL)	- resignFirstResponder
(BOOL)	- sendAction:to:
(void)	- setButtonType:
(void)	- setCompletionDelay:
(void)	- setDelegate:
(void)	- setEditable:
(void)	- setEnabled:
(void)	- setObjectValue:
(void)	- setTokenizingCharacterSet:
(CPString)	- stringValue
(void)	- textDidChange:
(CPCharacterSet)	- tokenizingCharacterSet
Instance Methods inherited from CPTextField
(BOOL)	- acceptsFirstMouse:
(BOOL)	- acceptsFirstResponder
(CGRect)	- bezelRectForBounds:
(CPTextFieldBezelStyle)	- bezelStyle
(CGRect)	- contentRectForBounds:
(void)	- copy:
(CPView)	- createEphemeralSubviewNamed:
(void)	- cursorUpdate:
(void)	- cut:
(id)	- delegate
(void)	- delete:
(void)	- doCommandBySelector:
(BOOL)	- drawsBackground
(void)	- insertNewlineIgnoringFieldEditor:
(void)	- insertTabIgnoringFieldEditor:
(BOOL)	- isBezeled
(BOOL)	- isBordered
(BOOL)	- isEditable
(BOOL)	- isSecure
(BOOL)	- isSelectable
(void)	- mouseDragged:
(BOOL)	- needsPanelToBecomeKey
(void)	- paste:
(CPString)	- placeholderString
(CGRect)	- rectForEphemeralSubviewNamed:
(void)	- rightMouseDown:
(void)	- selectAll:
(CPRange)	- selectedRange
(void)	- selectText:
(void)	- setBezeled:
(void)	- setBezelStyle:
(void)	- setBordered:
(void)	- setControlSize:
(void)	- setDelegate:
(void)	- setDrawsBackground:
(void)	- setPlaceholderString:
(void)	- setSecure:
(void)	- setSelectable:
(void)	- setSelectedRange:
(void)	- setTextColor:
(void)	- setTextFieldBackgroundColor:
(void)	- setValue:forThemeAttribute:
(void)	- sizeToFit
(void)	- takeValueFromKeyPath:ofObjects:
(void)	- textDidBeginEditing:
(void)	- textDidBlur:
(void)	- textDidEndEditing:
(void)	- textDidFocus:
(CPColor)	- textFieldBackgroundColor
(void)	- updateTrackingAreas
(BOOL)	- validateUserInterfaceItem:
(void)	- viewDidHide
(void)	- viewDidUnhide
Instance Methods inherited from CPControl
(SEL)	- action
(CPTextAlignment)	- alignment
(CPWritingDirection)	- baseWritingDirection
(BOOL)	- continueTracking:at:
(CPControlSize)	- controlSize
(double)	- doubleValue
(float)	- floatValue
(CPFont)	- font
(CPFormatter)	- formatter
(void)	- highlight:
(CPCellImagePosition)	- imagePosition
(CPUInteger)	- imageScaling
(int)	- integerValue
(int)	- intValue
(BOOL)	- isContinuous
(BOOL)	- isEnabled
(BOOL)	- isHighlighted
(CPLineBreakMode)	- lineBreakMode
(unsigned)	- mouseDownFlags
(void)	- mouseEntered:
(void)	- mouseExited:
(CPInteger)	- nextState
(void)	- performClick:
(int)	- sendActionOn:
(BOOL)	- sendsActionOnEndEditing
(void)	- setAction:
(void)	- setAlignment:
(void)	- setBaseWritingDirection:
(void)	- setContinuous:
(void)	- setDoubleValue:
(void)	- setFloatValue:
(void)	- setFont:
(void)	- setFormatter:
(void)	- setHighlighted:
(void)	- setImagePosition:
(void)	- setImageScaling:
(void)	- setIntegerValue:
(void)	- setIntValue:
(void)	- setLineBreakMode:
(void)	- setSendsActionOnEndEditing:
(void)	- setState:
(void)	- setStringValue:
(void)	- setTarget:
(void)	- setTextShadowColor:
(void)	- setTextShadowOffset:
(void)	- setVerticalAlignment:
(BOOL)	- startTrackingAt:
(void)	- stopTracking:at:mouseIsUp:
(void)	- takeDoubleValueFrom:
(void)	- takeFloatValueFrom:
(void)	- takeIntegerValueFrom:
(void)	- takeIntValueFrom:
(void)	- takeObjectValueFrom:
(void)	- takeStringValueFrom:
(id)	- target
(CPColor)	- textColor
(CPColor)	- textShadowColor
(CGSize)	- textShadowOffset
(void)	- trackMouse:
(BOOL)	- tracksMouseOutsideOfFrame
(void)	- unhighlightButtonTimerDidFinish:
(CPTextVerticalAlignment)	- verticalAlignment
Instance Methods inherited from CPView
(void)	- addSubview:
(void)	- addSubview:positioned:relativeTo:
(void)	- addTrackingArea:
(CGRect)	- adjustScroll:
(float)	- alphaValue
(CAAnimation)	- animationForKey:
(CPDictionary)	- animations
(id)	- animator
(BOOL)	- autoresizesSubviews
(unsigned)	- autoresizingMask
(BOOL)	- autoscroll:
(CPColor)	- backgroundColor
(CGRect)	- bounds
(CGPoint)	- boundsOrigin
(CGSize)	- boundsSize
(BOOL)	- canBecomeKeyView
(CGPoint)	- center
(BOOL)	- clipsToBounds
(CGPoint)	- convertPoint:fromView:
(CGPoint)	- convertPoint:toView:
(CGPoint)	- convertPointFromBase:
(CGPoint)	- convertPointToBase:
(CGRect)	- convertRect:fromView:
(CGRect)	- convertRect:toView:
(CGRect)	- convertRectFromBase:
(CGRect)	- convertRectToBase:
(CGSize)	- convertSize:fromView:
(CGSize)	- convertSize:toView:
(CPString)	- debug_description
(void)	- didAddSubview:
(void)	- display
(void)	- displayIfNeeded
(void)	- displayIfNeededInRect:
(void)	- displayRect:
(void)	- displayRectIgnoringOpacity:inContext:
(void)	- dragImage:at:offset:event:pasteboard:source:slideBack:
(void)	- dragView:at:offset:event:pasteboard:source:slideBack:
(void)	- drawRect:
(CPAppearance)	- effectiveAppearance
(CPMenuItem)	- enclosingMenuItem
(CPScrollView)	- enclosingScrollView
(BOOL)	- enterFullScreenMode
(BOOL)	- enterFullScreenMode:withOptions:
(CPView)	- ephemeralSubviewNamed:
(void)	- exitFullScreenMode
(void)	- exitFullScreenModeWithOptions:
(CGRect)	- frame
(CGPoint)	- frameOrigin
(CGRect)	- frameRectOfView:inSuperviewSize:
(CGSize)	- frameSize
(CGRect)	- frameWithNewSuperviewSize:
(BOOL)	- hasCustomDrawRect
(BOOL)	- hasCustomLayoutSubviews
(CPView)	- hitTest:
(BOOL)	- hitTests
(id)	- init
(BOOL)	- inLiveResize
(BOOL)	- isDescendantOf:
(BOOL)	- isFlipped
(BOOL)	- isHidden
(BOOL)	- isHiddenOrHasHiddenAncestor
(BOOL)	- isInFullScreenMode
(BOOL)	- isOpaque
(CALayer)	- layer
(void)	- layout
(CPView)	- layoutEphemeralSubviewNamed:positioned:relativeToEphemeralSubviewNamed:
(void)	- layoutIfNeeded
(void)	- lockFocus
(CPMenu)	- menuForEvent:
(BOOL)	- mouseDownCanMoveWindow
(BOOL)	- needsDisplay
(BOOL)	- needsLayout
(CPView)	- nextKeyView
(CPView)	- nextValidKeyView
(void)	- objectDidChangeTheme
(BOOL)	- postsBoundsChangedNotifications
(BOOL)	- postsFrameChangedNotifications
(CPView)	- previousKeyView
(CPView)	- previousValidKeyView
(void)	- reflectScrolledClipView:
(CPArray)	- registeredDraggedTypes
(void)	- registerForDraggedTypes:
(void)	- removeFromSuperview
(void)	- removeTrackingArea:
(void)	- replaceSubview:with:
(void)	- resizeSubviewsWithOldSize:
(void)	- resizeWithOldSuperviewSize:
(CGSize)	- scaleSize
(void)	- scaleUnitSquareToSize:
(void)	- scrollClipView:toPoint:
(void)	- scrollPoint:
(void)	- scrollRect:by:
(BOOL)	- scrollRectToVisible:
(void)	- setAlphaValue:
(void)	- setAnimations:
(void)	- setAppearance:
(void)	- setAutoresizesSubviews:
(void)	- setAutoresizingMask:
(void)	- setBackgroundColor:
(void)	- setBounds:
(void)	- setBoundsOrigin:
(void)	- setBoundsSize:
(void)	- setCenter:
(void)	- setClipsToBounds:
(void)	- setDOMClassName:
(void)	- setFrame:
(void)	- setFrameOrigin:
(void)	- setFrameSize:
(void)	- setHidden:
(void)	- setHitTests:
(void)	- setLayer:
(void)	- setNeedsDisplay:
(void)	- setNeedsDisplayInRect:
(void)	- setNeedsLayout
(void)	- setNeedsLayout:
(void)	- setNextKeyView:
(void)	- setPostsBoundsChangedNotifications:
(void)	- setPostsFrameChangedNotifications:
(void)	- setScaleSize:
(void)	- setSubviews:
(void)	- setTag:
(void)	- setThemeClass:
(BOOL)	- setThemeState:
(void)	- setToolTip:
(void)	- setValue:forThemeAttribute:inState:
(void)	- setWantsLayer:
(CPArray)	- subviews
(CPView)	- superview
(CPInteger)	- tag
(void)	- unlockFocus
(void)	- unregisterDraggedTypes
(BOOL)	- unsetThemeState:
(void)	- viewDidEndLiveResize
(void)	- viewDidLayout
(void)	- viewDidMoveToSuperview
(void)	- viewDidMoveToWindow
(void)	- viewWillDraw
(void)	- viewWillLayout
(void)	- viewWillMoveToSuperview:
(void)	- viewWillMoveToWindow:
(void)	- viewWillStartLiveResize
(CPView)	- viewWithTag:
(CGRect)	- visibleRect
(BOOL)	- wantsLayer
(void)	- willRemoveSubview:
(CPWindow)	- window

Class Methods
(CPTimeInterval)	+ defaultCompletionDelay
(CPString)	+ defaultThemeClass
(CPCharacterSet)	+ defaultTokenizingCharacterSet
(CPDictionary)	+ themeAttributes
Class Methods inherited from CPTextField
(CPTextField)	+ labelWithTitle:
(CPTextField)	+ labelWithTitle:theme:
(CPTextField)	+ roundedTextFieldWithStringValue:placeholder:width:
(CPTextField)	+ roundedTextFieldWithStringValue:placeholder:width:theme:
(CPTextField)	+ textFieldWithStringValue:placeholder:width:
(CPTextField)	+ textFieldWithStringValue:placeholder:width:theme:
Class Methods inherited from CPControl
(void)	+ initialize
Class Methods inherited from CPView
(Class)	+ animatorClass
(CAAnimation)	+ defaultAnimationForKey:
(CPMenu)	+ defaultMenu
(BOOL)	+ isHighDPIDrawingEnabled
(CPSet)	+ keyPathsForValuesAffectingBounds
(CPSet)	+ keyPathsForValuesAffectingFrame
(void)	+ setHighDPIDrawingEnabled:

Detailed Description

Definition at line 2 of file CPTokenField.h.

Method Documentation

becomeFirstResponder()

- (BOOL) becomeFirstResponder

implementation

Reimplemented from CPTextField.

Definition at line 372 of file CPTokenField.j.

buttonType()

- (int) buttonType

implementation

Synthesized accessor method.

Provided by category CPTokenField(CPSynthesizedAccessors).

Definition at line 1758 of file CPTokenField.j.

cancelOperation:()

- (void) cancelOperation: (id)  sender

implementation

Definition at line 853 of file CPTokenField.j.

completionDelay()

- (CPTimeInterval) completionDelay

implementation

Definition at line 1080 of file CPTokenField.j.

defaultCompletionDelay()

+ (CPTimeInterval) defaultCompletionDelay

implementation

Definition at line 106 of file CPTokenField.j.

defaultThemeClass()

+ (CPString) defaultThemeClass

implementation

Reimplemented from CPTextField.

Definition at line 111 of file CPTokenField.j.

defaultTokenizingCharacterSet()

+ (CPCharacterSet) defaultTokenizingCharacterSet

implementation

Definition at line 101 of file CPTokenField.j.

deleteBackward:()

- (void) deleteBackward: (id)  sender

implementation

Reimplemented from CPTextField.

Definition at line 938 of file CPTokenField.j.

deleteForward:()

- (void) deleteForward: (id)  sender

implementation

Reimplemented from CPTextField.

Definition at line 964 of file CPTokenField.j.

encodeWithCoder:()

- (void) encodeWithCoder: (CPCoder)  aCoder

implementation

Encodes the data of this textfield into the provided coder.

Parameters

aCoder

the coder into which the data will be written

Reimplemented from CPTextField.

Provided by category CPTokenField(CPCoding).

Definition at line 1726 of file CPTokenField.j.

initWithCoder:()

- (id) initWithCoder: (CPCoder)  aCoder

implementation

Initializes the textfield with data from a coder.

Parameters

aCoder

the coder from which to read the textfield data

Returns

the initialized textfield

Reimplemented from CPTextField.

Provided by category CPTokenField(CPCoding).

Definition at line 1707 of file CPTokenField.j.

initWithFrame:()

- (id) initWithFrame: (CGRect)  aFrame

implementation

Initializes the receiver for usage with the specified bounding rectangle

Returns

the initialized view

Reimplemented from CPTextField.

Definition at line 121 of file CPTokenField.j.

insertNewline:()

- (void) insertNewline: (id)  sender

implementation

Reimplemented from CPTextField.

Definition at line 794 of file CPTokenField.j.

insertTab:()

- (void) insertTab: (id)  sender

implementation

Definition at line 807 of file CPTokenField.j.

insertText:()

- (void) insertText: (CPString)  characters

implementation

Definition at line 824 of file CPTokenField.j.

keyDown:()

- (void) keyDown: (CPEvent)  anEvent

implementation

Reimplemented from CPTextField.

Definition at line 1009 of file CPTokenField.j.

keyUp:()

- (void) keyUp: (CPEvent)  anEvent

implementation

Reimplemented from CPTextField.

Definition at line 1025 of file CPTokenField.j.

layoutSubviews()

- (void) layoutSubviews

implementation

Reimplemented from CPTextField.

Definition at line 1088 of file CPTokenField.j.

mouseDown:()

- (void) mouseDown: (CPEvent)  anEvent

implementation

Reimplemented from CPTextField.

Definition at line 546 of file CPTokenField.j.

mouseUp:()

- (void) mouseUp: (CPEvent)  anEvent

implementation

Reimplemented from CPTextField.

Definition at line 555 of file CPTokenField.j.

moveDown:()

- (void) moveDown: (id)  sender

implementation

Definition at line 788 of file CPTokenField.j.

moveLeft:()

- (void) moveLeft: (id)  sender

implementation

Definition at line 858 of file CPTokenField.j.

moveLeftAndModifySelection:()

- (void) moveLeftAndModifySelection: (id)  sender

implementation

Definition at line 878 of file CPTokenField.j.

moveRight:()

- (void) moveRight: (id)  sender

implementation

Definition at line 895 of file CPTokenField.j.

moveRightAndModifySelection:()

- (void) moveRightAndModifySelection: (id)  sender

implementation

Definition at line 922 of file CPTokenField.j.

moveUp:()

- (void) moveUp: (id)  sender

implementation

Definition at line 782 of file CPTokenField.j.

objectValue()

- (id) objectValue

implementation

Returns the string in the text field.

Reimplemented from CPTextField.

Definition at line 591 of file CPTokenField.j.

performKeyEquivalent:()

- (BOOL) performKeyEquivalent: (CPEvent)  anEvent

implementation

Overridden by subclasses to handle a key equivalent.

If the receiver’s key equivalent is the same as the characters of the key-down event theEvent, as returned by [anEvent charactersIgnoringModifiers], the receiver should take the appropriate action and return YES. Otherwise, it should return the result of invoking super’s implementation. The default implementation of this method simply passes the message down the view hierarchy (from superviews to subviews) and returns NO if none of the receiver’s subviews responds YES.

Parameters

anEvent

An event object that represents the key equivalent pressed

Returns

YES if theEvent is a key equivalent that the receiver handled, NO if it is not a key equivalent that it should handle.

Reimplemented from CPView.

Definition at line 1037 of file CPTokenField.j.

resignFirstResponder()

- (BOOL) resignFirstResponder

implementation

Reimplemented from CPTextField.

Definition at line 478 of file CPTokenField.j.

sendAction:to:()

- (BOOL) sendAction: (SEL)  anAction to: (id)  anObject

implementation

Causes anAction to be sent to anObject.

Parameters

anAction	the action to send
anObject	the object to which the action will be sent

Reimplemented from CPControl.

Definition at line 715 of file CPTokenField.j.

setButtonType:()

- (void) setButtonType: (int)  aValue

implementation

Synthesized accessor method.

Provided by category CPTokenField(CPTokenFieldDelegate).

Definition at line 1766 of file CPTokenField.j.

setCompletionDelay:()

- (void) setCompletionDelay: (CPTimeInterval)  delay

implementation

Definition at line 1075 of file CPTokenField.j.

setDelegate:()

- (void) setDelegate: (id <CPTokenFieldDelegate>)  aDelegate

implementation

Set the delegate of the receiver

Definition at line 164 of file CPTokenField.j.

setEditable:()

- (void) setEditable: (BOOL)  shouldBeEditable

implementation

Sets whether or not the receiver text field can be edited. If NO, any ongoing edit is ended.

Reimplemented from CPTextField.

Definition at line 708 of file CPTokenField.j.

setEnabled:()

- (void) setEnabled: (BOOL)  shouldBeEnabled

implementation

Sets whether the field reacts to events. If NO, any ongoing edit is ended.

Reimplemented from CPTextField.

Definition at line 694 of file CPTokenField.j.

setObjectValue:()

- (void) setObjectValue: (id)  anObject

implementation

Sets the receiver's object value.

Reimplemented from CPTextField.

Definition at line 618 of file CPTokenField.j.

setTokenizingCharacterSet:()

- (void) setTokenizingCharacterSet: (CPCharacterSet)  aValue

implementation

Synthesized accessor method.

Provided by category CPTokenField(CPSynthesizedAccessors).

Definition at line 1750 of file CPTokenField.j.

stringValue()

- (CPString) stringValue

implementation

Returns the receiver's string value.

Reimplemented from CPControl.

Definition at line 586 of file CPTokenField.j.

textDidChange:()

- (void) textDidChange: (CPNotification)  aNotification

implementation

Reimplemented from CPTextField.

Definition at line 1052 of file CPTokenField.j.

themeAttributes()

+ (CPDictionary) themeAttributes

implementation

Reimplemented from CPTextField.

Definition at line 116 of file CPTokenField.j.

tokenizingCharacterSet()

- (CPCharacterSet) tokenizingCharacterSet

implementation

Synthesized accessor method.

Provided by category CPTokenField(CPSynthesizedAccessors).

Definition at line 1742 of file CPTokenField.j.

---

The documentation for this class was generated from the following files:

• AppKit/CPTokenField.h
• AppKit/CPTokenField.j