Class CCButton

A button implements a simple clickable region with text, which triggers a function when clicked.

Hierarchy (View Summary)

Constructors

constructor

Properties

_isDefault _isEnabled acceptsFirstResponder action isFocused isHidden isPressed needsDraw needsLayout needsUpdateConstraints nextResponder? subviews superview? userInteractionEnabled window?

Accessors

backgroundColor buttonActiveColor buttonColor buttonDefaultColor frame isDefault isEnabled text textColor textDisabledColor

Methods

addConstraint addConstraints addSubview becomeFirstResponder bringSubviewToFront convertToWindowSpace cursorPos didAddSubview didMoveToSuperview didRemoveSubview display draw hitTest horizontalScrollWheel interpretKeyEvents keyDown keyUp layoutSubtree mouseDown mouseDragged mouseEntered mouseExited mouseMoved mouseUp noResponder otherMouseDown otherMouseDragged otherMouseUp removeConstraint removeFromSuperview resignFirstResponder rightMouseDown rightMouseDragged rightMouseUp scrollWheel sendSubviewToBack setNeedsDisplay setNeedsLayout textInput tryToCall validateProposedFirstResponder addConstraintsByCode

Constructors

constructor

  • new CCButton(
        position: CCPoint,
        text: string,
        action: (this: void, button: CCView) => void,
    ): CCButton

  • Create a new button.

    Parameters

    • position: CCPoint

      The position of the button

    • text: string

      The text for the button

    • action: (this: void, button: CCView) => void

      The function to call when the button is pressed

    Returns CCButton

Properties

Protected_isDefault

_isDefault: boolean = false

Protected_isEnabled

_isEnabled: boolean = true

acceptsFirstResponder

acceptsFirstResponder: boolean = true

Whether the object can become the first responder.

action

action: (this: void, sender: CCView) => void

The function to call when the control is pressed.

isFocused

isFocused: boolean = false

Whether the view is currently focused.

isHidden

isHidden: boolean = false

Whether the view is hidden.

ProtectedisPressed

isPressed: boolean = false

needsDraw

needsDraw: boolean = true

Whether the view needs to be redrawn.

needsLayout

needsLayout: boolean = false

Whether the view needs to be laid out.

needsUpdateConstraints

needsUpdateConstraints: boolean = false

Whether constraints need to be updated.

OptionalnextResponder

nextResponder?: CCResponder

The next responder in the responder chain.

subviews

subviews: CCView[] = []

The list of subviews inside this view.

Optionalsuperview

superview?: CCView

The view that contains this view, if it exists.

userInteractionEnabled

userInteractionEnabled: boolean = true

Whether user interaction is enabled for this view.

Optionalwindow

window?: CCWindow

The window this view is located inside.

Accessors

backgroundColor

  • get backgroundColor(): undefined | number

  • The background color of the view.

    Returns undefined | number

  • set backgroundColor(value: undefined | number): void

  • Parameters

    • value: undefined | number

    Returns void

buttonActiveColor

  • get buttonActiveColor(): number

  • The color of the button when clicked.

    Returns number

  • set buttonActiveColor(value: number): void

  • Parameters

    • value: number

    Returns void

buttonColor

  • get buttonColor(): number

  • The color of the button.

    Returns number

  • set buttonColor(value: number): void

  • Parameters

    • value: number

    Returns void

buttonDefaultColor

  • get buttonDefaultColor(): number

  • The color of the button when in default state.

    Returns number

  • set buttonDefaultColor(value: number): void

  • Parameters

    • value: number

    Returns void

frame

isDefault

  • get isDefault(): boolean

  • Whether the control is in default state.

    Returns boolean

  • set isDefault(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

isEnabled

  • get isEnabled(): boolean

  • Whether the control is enabled.

    Returns boolean

  • set isEnabled(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

text

  • get text(): string

  • The text for the button.

    Returns string

  • set text(value: string): void

  • Parameters

    • value: string

    Returns void

textColor

  • get textColor(): number

  • The color of the text.

    Returns number

  • set textColor(value: number): void

  • Parameters

    • value: number

    Returns void

textDisabledColor

  • get textDisabledColor(): number

  • The color of the text when disabled.

    Returns number

  • set textDisabledColor(value: number): void

  • Parameters

    • value: number

    Returns void

Methods

addConstraint

addConstraints

addSubview

becomeFirstResponder

  • becomeFirstResponder(): boolean

  • Notifies the object that it's about to become the first responder.

    Returns boolean

    Whether to accept the first responder status

bringSubviewToFront

convertToWindowSpace

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

didAddSubview

didMoveToSuperview

didRemoveSubview

display

  • display(rect: CCRect): void

  • Displays a view in the specified rectangle. This should not be called by other code.

    Parameters

    • rect: CCRect

      The rectangle to draw inside

    Returns void

draw

  • draw(rect: CCRect): void

  • Draws the view inside the specified rectangle. Override this function to provide custom view types.

    Parameters

    • rect: CCRect

      The rectangle to draw inside

    Returns void

hitTest

  • hitTest(point: CCPoint): undefined | CCView

  • Returns the furthest descendant that contains the specified point.

    Parameters

    • point: CCPoint

      The point to look for

    Returns undefined | CCView

    The deepest view that hit the point, or undefined if none was found

horizontalScrollWheel

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

keyDown

keyUp

layoutSubtree

  • layoutSubtree(): void

  • Lays out the view hierarchy following constraints. This should only be called on a superview, which is done automatically.

    Returns void

mouseDown

mouseDragged

mouseEntered

mouseExited

mouseMoved

mouseUp

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

otherMouseDown

otherMouseDragged

otherMouseUp

removeConstraint

removeFromSuperview

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

rightMouseDown

rightMouseDragged

rightMouseUp

scrollWheel

sendSubviewToBack

setNeedsDisplay

setNeedsLayout

  • setNeedsLayout(sender: CCView, previous: CCView): void

  • Tells the receiver that the frame or constraints of the sender changed. This triggers the receiver to update its constraints if any are related to the sender, and cascades the message up and down throughout the hierarchy. It will also trigger a cascade on itself if it needs to update constraints.

    Parameters

    • sender: CCView

      The view whose frame and/or constraints changed

    • previous: CCView

      The view that called this method, to prevent backtracking

    Returns void

textInput

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

validateProposedFirstResponder

StaticaddConstraintsByCode

  • addConstraintsByCode(code: string, views: { [name: string]: CCView }): void

  • Adds a number of constraints to views using code. This can simplify settings constraints by using familiar code syntax instead of lengthy constraint constructions and activations.

    The syntax is fairly simple:

    <ViewName>.<Attribute> = [<Multiplier> *] <ViewName>.<Attribute> [+|- <Constant>]
<ViewName>.<Attribute> = <Constant>

    The code is processed using Lua as the parser, so it's not strictly required to be in exactly this format; but mind that operators other than add/sub/mul/div/unm aren't supported (and division is only valid if the divisor is a number), and no libraries are available in the environment.

    Parameters

    • code: string

      The constraint code to apply

    • views: { [name: string]: CCView }

      A key-value map of names of views in the code, to the views they represent

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods