Class CCViewController

The CCViewController class is the primary way to design behavior for a view or window. It owns a root view which is tied to the view controller, whose lifecycle is defined by the view controller.

Hierarchy (View Summary)

CCResponder
- CCViewController

Constructors

constructor

new CCViewController(): CCViewController
Returns CCViewController
Inherited from CCResponder.constructor

Properties

acceptsFirstResponder

acceptsFirstResponder: boolean = true

Whether the object can become the first responder.

`Optional`nextResponder

nextResponder?: CCResponder

The next responder in the responder chain.

`Optional`title

title?: string = undefined

A string which describes the view this controller holds.

view

view: CCView

The root view of the view controller.

Accessors

isViewLoaded

get isViewLoaded(): boolean
Whether the view has been loaded yet.

Returns boolean
- Defined in CCViewController.ts:15

preferredContentSize

get preferredContentSize(): CCSize
Returns the preferred size of the content, in characters.

Returns CCSize
- Defined in CCViewController.ts:22

Methods

becomeFirstResponder

becomeFirstResponder(): boolean
Notifies the object that it's about to become the first responder.

Returns boolean
Whether to accept the first responder status
Inherited from CCResponder.becomeFirstResponder
- Defined in CCResponder.ts:19

cursorPos

cursorPos(): undefined | [CCPoint, number]
This is used to place a blinking cursor on screen while not drawing. It's only called on the first responder of a window.

Returns undefined | [CCPoint, number]
The position and color of the cursor in window coordinates, or undefined to not place a cursor
Inherited from CCResponder.cursorPos
- Defined in CCResponder.ts:86

horizontalScrollWheel

horizontalScrollWheel(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.horizontalScrollWheel
- Defined in CCResponder.ts:110

interpretKeyEvents

interpretKeyEvents(events: CCEvent[]): void
Sends a list of key input events to the input manager, which will send back text input events through insertText(text: string).
Parameters
- events: CCEvent[]
  The input events to send
Returns void
Inherited from CCResponder.interpretKeyEvents
- Defined in CCResponder.ts:46

keyDown

keyDown(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.keyDown
- Defined in CCResponder.ts:106

keyUp

keyUp(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.keyUp
- Defined in CCResponder.ts:107

loadView

loadView(): void
Loads the root view into memory.

Returns void
- Defined in CCViewController.ts:29

loadViewIfNeeded

loadViewIfNeeded(): void
Loads the view if it hasn't been loaded yet.

Returns void
- Defined in CCViewController.ts:44

mouseDown

mouseDown(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.mouseDown
- Defined in CCResponder.ts:94

mouseDragged

mouseDragged(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.mouseDragged
- Defined in CCResponder.ts:95

mouseEntered

mouseEntered(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.mouseEntered
- Defined in CCResponder.ts:98

mouseExited

mouseExited(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.mouseExited
- Defined in CCResponder.ts:99

mouseMoved

mouseMoved(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.mouseMoved
- Defined in CCResponder.ts:97

mouseUp

mouseUp(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.mouseUp
- Defined in CCResponder.ts:96

noResponder

noResponder(method: string): void
Handles when a method action fails to find a responder.
Parameters
- method: string
  The method that was attempted
Returns void
Inherited from CCResponder.noResponder
- Defined in CCResponder.ts:75

otherMouseDown

otherMouseDown(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.otherMouseDown
- Defined in CCResponder.ts:103

otherMouseDragged

otherMouseDragged(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.otherMouseDragged
- Defined in CCResponder.ts:104

otherMouseUp

otherMouseUp(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.otherMouseUp
- Defined in CCResponder.ts:105

resignFirstResponder

resignFirstResponder(): boolean
Notifies the object that it's about to no longer be the first responder.

Returns boolean
Whether to resign first responder status
Inherited from CCResponder.resignFirstResponder
- Defined in CCResponder.ts:25

rightMouseDown

rightMouseDown(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.rightMouseDown
- Defined in CCResponder.ts:100

rightMouseDragged

rightMouseDragged(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.rightMouseDragged
- Defined in CCResponder.ts:101

rightMouseUp

rightMouseUp(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.rightMouseUp
- Defined in CCResponder.ts:102

scrollWheel

scrollWheel(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.scrollWheel
- Defined in CCResponder.ts:109

textInput

textInput(event: CCEvent): void
Parameters
- event: CCEvent
Returns void
Inherited from CCResponder.textInput
- Defined in CCResponder.ts:108

tryToCall

tryToCall(method: string, ...args: any[]): boolean
Attempts to call the specified method on the object, passing the call on to the next responder if this object doesn't implement it.
Parameters
- method: string
  The name of the method to call
- ...args: any[]
  Any parameters to pass to the method
Returns boolean
Whether a responder was able to respond to the method
Inherited from CCResponder.tryToCall
- Defined in CCResponder.ts:57

validateProposedFirstResponder

validateProposedFirstResponder(object: CCResponder, event: CCEvent): boolean
Checks whether the passed object can become the first responder from the specified event.
Parameters
- object: CCResponder
  The object to check
- event: CCEvent
  The event that was sent
Returns boolean
Whether the object is allowed to be the first responder
Inherited from CCResponder.validateProposedFirstResponder
- Defined in CCResponder.ts:35

viewDidAppear

viewDidAppear(animated: boolean): void
Called when the view has just appeared on screen.
Parameters
- animated: boolean
  Whether the view is being animated.
Returns void
- Defined in CCViewController.ts:68

viewDidDisappear

viewDidDisappear(animated: boolean): void
Called when the view has just disappeared from the screen.
Parameters
- animated: boolean
  Whether the view is being animated.
Returns void
- Defined in CCViewController.ts:84

viewDidLoad

viewDidLoad(): void
Called after the view has been loaded into memory.

Returns void
- Defined in CCViewController.ts:37

viewIsAppearing

viewIsAppearing(animated: boolean): void
Called when the view is being added to the view hierarchy.
Parameters
- animated: boolean
  Whether the view is being animated.
Returns void
- Defined in CCViewController.ts:60

viewWillAppear

viewWillAppear(animated: boolean): void
Called when the view is about to appear on screen.
Parameters
- animated: boolean
  Whether the view is being animated.
Returns void
- Defined in CCViewController.ts:52

viewWillDisappear

viewWillDisappear(animated: boolean): void
Called when the view is about to disappear from the screen.
Parameters
- animated: boolean
  Whether the view is being animated.
Returns void
- Defined in CCViewController.ts:76

Class CCViewController

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CCViewController

Properties

acceptsFirstResponder

OptionalnextResponder

Optionaltitle

view

Accessors

isViewLoaded

Returns boolean

preferredContentSize

Returns CCSize

Methods

becomeFirstResponder

Returns boolean

cursorPos

Returns undefined | [CCPoint, number]

horizontalScrollWheel

Parameters

Returns void

interpretKeyEvents

Parameters

Returns void

keyDown

Parameters

Returns void

keyUp

Parameters

Returns void

loadView

Returns void

loadViewIfNeeded

Returns void

mouseDown

Parameters

Returns void

mouseDragged

Parameters

Returns void

mouseEntered

Parameters

Returns void

mouseExited

Parameters

Returns void

mouseMoved

Parameters

Returns void

mouseUp

Parameters

Returns void

noResponder

Parameters

Returns void

otherMouseDown

Parameters

Returns void

otherMouseDragged

Parameters

Returns void

otherMouseUp

Parameters

Returns void

resignFirstResponder

Returns boolean

rightMouseDown

Parameters

Returns void

rightMouseDragged

Parameters

Returns void

rightMouseUp

`Optional`nextResponder

`Optional`title