Class CvsButton

This class is to create simple buttons with text and / or icons on its face.

Hierarchy

CvsTextIcon
- CvsButton

Index

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

addChild(c: string | CvsBaseControl, rx?: number, ry?: number): any
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
Inherited from CvsTextIcon.addChild
- Defined in index.ts:3796

corners

corners(c: number[]): number[] | CvsBaseControl
Set or get the corner radii used for this control

Returns
an array with the 4 corner radii
Parameters
- c: number[]
  
  an array of 4 corner radii
Returns number[] | CvsBaseControl
Inherited from CvsTextIcon.corners
- Defined in index.ts:4227

disable

disable(cascade?: boolean): CvsBaseControl
Disables this control

Returns
this control
Parameters
- Optional cascade: boolean
  
  if true disable child controls
Returns CvsBaseControl
Inherited from CvsTextIcon.disable
- Defined in index.ts:3941

enable

enable(cascade?: boolean): CvsBaseControl
Enables this control

Returns
this control
Parameters
- Optional cascade: boolean
  
  if true enable child controls
Returns CvsBaseControl
Inherited from CvsTextIcon.enable
- Defined in index.ts:3924

getAbsXY

getAbsXY(): __Position
Calculates the absolute position on the canvas taking into account any ancestors

Returns
the actual position in the canvas

Returns __Position
Inherited from CvsTextIcon.getAbsXY
- Defined in index.ts:3747

getParent

getParent(): CvsPane | CvsBaseControl
Returns
this controls parent

Returns CvsPane | CvsBaseControl
Inherited from CvsTextIcon.getParent
- Defined in index.ts:3850

hide

hide(cascade?: boolean): CvsBaseControl
Make this control invisible

Returns
this control
Parameters
- Optional cascade: boolean
  
  if true hide children
Returns CvsBaseControl
Inherited from CvsTextIcon.hide
- Defined in index.ts:3970

icon

icon(i: Graphics, align?: number): any
Gets or sets the icon and its alignment relative to any text in the control.

Processing constants are used to define the icon alignment.

Returns
this control or the current icon
Parameters
- i: Graphics
  
  the icon to use for this control
- Optional align: number
  
  LEFT or RIGHT
Returns any
Inherited from CvsTextIcon.icon
- Defined in index.ts:4905

iconAlign

iconAlign(align: number): CvsButton
Sets the icon alignment relative to the text.

Processing constants are used to define the text alignment.

Returns
this control
Parameters
- align: number
  
  LEFT or RIGHT
Returns CvsButton
Inherited from CvsTextIcon.iconAlign
- Defined in index.ts:4927

invalidateBuffer

invalidateBuffer(): CvsButton
Invalidates the control's buffer forcing it to validate it on the next frame

Returns
this control

Returns CvsButton
Inherited from CvsTextIcon.invalidateBuffer
- Defined in index.ts:4091

isEnabled

isEnabled(): boolean
Use enable() and disable() to enable and disable it.

Returns
true if the control is enabled else false

Returns boolean
Inherited from CvsTextIcon.isEnabled
- Defined in index.ts:3915

isVisible

isVisible(): boolean
Returns
true if this control is visible

Since
0.9.3

Returns boolean
Inherited from CvsTextIcon.isVisible
- Defined in index.ts:3982

leaveParent

leaveParent(): CvsBaseControl
Remove this control from its parent

Returns
this control

Returns CvsBaseControl
Inherited from CvsTextIcon.leaveParent
- Defined in index.ts:3840

name

name(): string
Returns
the unique identier for this control

Returns string
Inherited from CvsTextIcon.name
- Defined in index.ts:3738

noIcon

noIcon(): CvsButton
Returns
this control

Returns CvsButton
Inherited from CvsTextIcon.noIcon
- Defined in index.ts:4943

noText

noText(): CvsBaseControl
Renoves any text that the control might use ti display itself.

Returns
this control

Returns CvsBaseControl
Inherited from CvsTextIcon.noText
- Defined in index.ts:4828

opaque

opaque(): CvsBaseControl
Makes the controls background opaque. The actual color depends on the controls color scheme

Returns
this control

Returns CvsBaseControl
Inherited from CvsTextIcon.opaque
- Defined in index.ts:3991

orient

orient(dir: string): CvsBaseControl
Specify the orientation to show this control

Returns
this control
Parameters
- dir: string
  
  'north', 'south', 'east' or 'west'
Returns CvsBaseControl
Inherited from CvsTextIcon.orient
- Defined in index.ts:3881

parent

parent(p: string | CvsBaseControl, rx?: number, ry?: number): CvsBaseControl
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
Inherited from CvsTextIcon.parent
- Defined in index.ts:3784

removeChild

removeChild(c: string | CvsBaseControl): CvsButton
Remove a child control from this one so that it stays in same screen position

Returns
this control
Parameters
- c: string | CvsBaseControl
  
  the control to remove or its name
Returns CvsButton
Inherited from CvsTextIcon.removeChild
- Defined in index.ts:3818

scheme

scheme(id?: string, cascade?: boolean): CvsBaseControl | __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
Inherited from CvsTextIcon.scheme
- Defined in index.ts:3763

setAction

setAction(event_handler: Function): CvsButton
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 CvsButton
Inherited from CvsTextIcon.setAction
- Defined in index.ts:3866

show

show(cascade?: boolean): CvsBaseControl
Make this control visible

Returns
this control
Parameters
- Optional cascade: boolean
  
  if true show children
Returns CvsBaseControl
Inherited from CvsTextIcon.show
- Defined in index.ts:3957

shrink

shrink(dim?: string): CvsBaseControl
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
Inherited from CvsTextIcon.shrink
- Defined in index.ts:4012

text

text(t?: string | string[], align?: number): string | CvsBaseControl
Gets or sets the current text.

Processing constants are used to define the alignment.

Returns
this control or the existing text
Parameters
- Optional t: string | string[]
  
  the text to display
- Optional align: number
  
  LEFT, CENTER or RIGHT
Returns string | CvsBaseControl
Inherited from CvsTextIcon.text
- Defined in index.ts:4788

textAlign

textAlign(align: number): CvsBaseControl
Sets the text alignment.

Processing constants are used to define the text alignment.

Returns
this control
Parameters
- align: number
  
  LEFT, CENTER or RIGHT
Returns CvsBaseControl
Inherited from CvsTextIcon.textAlign
- Defined in index.ts:4815

tipTextSize

tipTextSize(tsize?: number): CvsButton
Sets the size of the text to use in the tooltip
Parameters
- Optional tsize: number
  
  text size for this tooltip
Returns CvsButton
Inherited from CvsTextIcon.tipTextSize
- Defined in index.ts:4259

tooltip

tooltip(tiptext: string, duration: number): CvsButton
Create a tooltip for this control

Returns
this control
Parameters
- tiptext: string
  
  the text to appear in the tooltip
- duration: number
  
  how long the tip remains visible (milliseconds)
Returns CvsButton
Inherited from CvsTextIcon.tooltip
- Defined in index.ts:4242

transparent

transparent(): CvsBaseControl
Makes the controls background fully transparent.

Returns
this control

Returns CvsBaseControl
Inherited from CvsTextIcon.transparent
- Defined in index.ts:4000

Class CvsButton

Hierarchy

Index

Properties

Methods

Properties

action

Methods

addChild

Returns

Parameters

c: string | CvsBaseControl

Optional rx: number

Optional ry: number

Returns any

corners

Returns

Parameters

c: number[]

Returns number[] | CvsBaseControl

disable

Returns

Parameters

Optional cascade: boolean

Returns CvsBaseControl

enable

Returns

Parameters

Optional cascade: boolean

Returns CvsBaseControl

getAbsXY

Returns

Returns __Position

getParent

Returns

Returns CvsPane | CvsBaseControl

hide

Returns

Parameters

Optional cascade: boolean

Returns CvsBaseControl

icon

Returns

Parameters

i: Graphics

Optional align: number

Returns any

iconAlign

Returns

Parameters

align: number

Returns CvsButton

invalidateBuffer

Returns

Returns CvsButton

isEnabled

Returns

Returns boolean

isVisible

Returns

Since

Returns boolean

leaveParent

Returns

Returns CvsBaseControl

name

Returns

Returns string

noIcon

Returns

Returns CvsButton

noText

Returns

Returns CvsBaseControl

opaque

Returns

Returns CvsBaseControl

orient

Returns

Parameters

`Optional` rx: number

`Optional` ry: number

`Optional` cascade: boolean

`Optional` cascade: boolean

`Optional` cascade: boolean

`Optional` align: number

`Optional` rx: number

`Optional` ry: number

`Optional` id: string

`Optional` cascade: boolean

`Optional` cascade: boolean

`Optional` dim: string

`Optional` t: string | string[]

`Optional` align: number

`Optional` tsize: number