CCKit2
    Preparing search index...

    Class CCButton

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

    TypeScript
    let button = new CCButton({x: 5, y: 3}, "Hello!", () => CCDialog.messageWithOneButton(this.view.window, "Hello!", "Hello World!"));
    this.view.addSubview(button);

    Lua
    local button = LuaWrappers.new(CCButton, {x = 5, y = 3}, "Hello!", function() CCDialog:messageWithOneButton(self.view.window, "Hello!", "Hello World!") end)
    self.view:addSubview(button)

    Hierarchy (View Summary)

    Index

    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 customEvent didAddSubview didMoveToSuperview didRemoveSubview display draw hitTest horizontalScrollWheel interpretKeyEvents keyDown keyUp layoutSubtree menuForEvent 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

    • 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: boolean = true

    Whether the object can become the first responder.

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

    The function to call when the control is pressed.

    isFocused: boolean = false

    Whether the view is currently focused.

    isHidden: boolean = false

    Whether the view is hidden.

    isPressed: boolean = false
    needsDraw: boolean = true

    Whether the view needs to be redrawn.

    needsLayout: boolean = false

    Whether the view needs to be laid out.

    needsUpdateConstraints: boolean = false

    Whether constraints need to be updated.

    nextResponder?: CCResponder

    The next responder in the responder chain.

    subviews: CCView[] = []

    The list of subviews inside this view.

    superview?: CCView

    The view that contains this view, if it exists.

    userInteractionEnabled: boolean = true

    Whether user interaction is enabled for this view.

    window?: CCWindow

    The window this view is located inside.

    Accessors

    • get buttonActiveColor(): number

      The color of the button when clicked.

      Returns number

    • set buttonActiveColor(value: number): void

      Parameters

      • value: number

      Returns void

    • get buttonColor(): number

      The color of the button.

      Returns number

    • set buttonColor(value: number): void

      Parameters

      • value: number

      Returns void

    • get buttonDefaultColor(): number

      The color of the button when in default state.

      Returns number

    • set buttonDefaultColor(value: number): void

      Parameters

      • value: number

      Returns void

    text

    • get text(): string

      The text for the button.

      Returns string

    • set text(value: string): void

      Parameters

      • value: string

      Returns void

    • get textColor(): number

      The color of the text.

      Returns number

    • set textColor(value: number): void

      Parameters

      • value: number

      Returns void

    • get textDisabledColor(): number

      The color of the text when disabled.

      Returns number

    • set textDisabledColor(value: number): void

      Parameters

      • value: number

      Returns void

    Methods

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

      Returns boolean

      Whether to accept the first responder status

    • 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 [CCPoint, number] | undefined

      The position and color of the cursor in window coordinates, or undefined to not place a cursor

    • 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

    • 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

    • Returns the furthest descendant that contains the specified point.

      Parameters

      • point: CCPoint

        The point to look for

      Returns CCView | undefined

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

    • 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

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

      Returns void

    • Returns a context menu to display on a (usually right-click) event.

      Parameters

      • event: CCEvent

        The event that triggered the menu

      Returns CCMenu | undefined

      A context menu, or nil to not display a menu

    • Handles when a method action fails to find a responder.

      Parameters

      • method: string

        The method that was attempted

      Returns void

    • Notifies the object that it's about to no longer be the first responder.

      Returns boolean

      Whether to resign first responder status

    • 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

    • 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

    • 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