Class CvsBaseControl

Base class for all controls

It provides most of the functionality for the controls

Hierarchy

Properties

action

Methods

addChild disable enable getAbsXY getParent hide invalidateBuffer isEnabled isVisible leaveParent name opaque orient parent removeChild scheme setAction show shrink transparent

Properties

action

action: Function = ...

The event handler for this control. Although it is permitted to set this property directly it is recommended that the setAction(...) method is used to define the event handler actions.

Methods

addChild

  • Add a child to this control using its relative position [rx, ry]. If rx and ry are not provided then it uses the values set in the child.

    Returns

    this control

    Parameters

    • c: string | CvsBaseControl

      is the actual control or its name

    • Optional rx: number
    • Optional ry: number

    Returns any

disable

  • Disables this control

    Returns

    this control

    Parameters

    • Optional cascade: boolean

      if true disable child controls

    Returns CvsBaseControl

enable

  • Enables this control

    Returns

    this control

    Parameters

    • Optional cascade: boolean

      if true enable child controls

    Returns CvsBaseControl

getAbsXY

  • Calculates the absolute position on the canvas taking into account any ancestors

    Returns

    the actual position in the canvas

    Returns __Position

getParent

hide

  • Make this control invisible

    Returns

    this control

    Parameters

    • Optional cascade: boolean

      if true hide children

    Returns CvsBaseControl

invalidateBuffer

  • Invalidates the control's buffer forcing it to validate it on the next frame

    Returns

    this control

    Returns CvsBaseControl

isEnabled

  • Use enable() and disable() to enable and disable it.

    Returns

    true if the control is enabled else false

    Returns boolean

isVisible

  • Returns

    true if this control is visible

    Since

    0.9.3

    Returns boolean

leaveParent

name

  • Returns

    the unique identier for this control

    Returns string

opaque

  • Makes the controls background opaque. The actual color depends on the controls color scheme

    Returns

    this control

    Returns CvsBaseControl

orient

  • Specify the orientation to show this control

    Returns

    this control

    Parameters

    • dir: string

      'north', 'south', 'east' or 'west'

    Returns CvsBaseControl

parent

  • Adds this control to another control which becomes its parent

    Returns

    this control

    Parameters

    • p: string | CvsBaseControl

      is the parental control or its name

    • Optional rx: number

      x position relative to parent

    • Optional ry: number

      y position relative to parent

    Returns CvsBaseControl

removeChild

scheme

  • Sets or gets the color scheme used by this control.

    Returns

    this control or the control's color scheme

    Parameters

    • Optional id: string
    • Optional cascade: boolean

    Returns CvsBaseControl | __Scheme

setAction

  • This sets the event handler to be used when this control fires an event. The parameter can take three forms:

    1. Arrow function definition
    2. Anonymous function definition
    3. Named function declaration

    Returns

    this control

    Parameters

    • event_handler: Function

      the function to handle this controls event

    Returns CvsBaseControl

show

  • Make this control visible

    Returns

    this control

    Parameters

    • Optional cascade: boolean

      if true show children

    Returns CvsBaseControl

shrink

  • Shrink the control to fit contents.

    To shrink on one dimension only pass either 'w' (width) or 'h' (height) to indicate which dimmension to shrink

    Returns

    this control

    Parameters

    • Optional dim: string

      the dimension to shrink

    Returns CvsBaseControl

transparent

  • Makes the controls background fully transparent.

    Returns

    this control

    Returns CvsBaseControl

Settings

Member Visibility

Theme

Generated using TypeDoc