Class CvsPin

This is a placeholder for other controls (its children)

A pin has a position but no visual representation and its children will be shown relative to the pin's xy position.

Hierarchy (View Summary)

CvsPin
- CvsControl

Index

Constructors

Accessors

id isEnabled isVisible type

Methods

addChild disable enable hide leaveParent moveBy moveTo parent removeChild setEnabled setVisible show

Constructors

constructor

new CvsPin(gui: GUI, id: string, x: number, y: number): CvsPin
Parameters
- gui: GUI
- id: string
- x: number
- y: number
Returns CvsPin
- Defined in index.ts:2345

Accessors

id

get id(): string
The unique identifier for this control.

Returns string
- Defined in index.ts:2354

isEnabled

get isEnabled(): boolean
This is true if the control can respond to UI events else false.

Use enable() and disable() to enable and disable it.
Returns boolean
- Defined in index.ts:2381

isVisible

get isVisible(): boolean
This is true if the control is visible else false.

Use hide() and show() to set visibility.
Returns boolean
- Defined in index.ts:2387

type

get type(): string
The type name for this control.
(type name = class name without the Cvs prefix)

Returns string
- Defined in index.ts:2360

Methods

addChild

addChild(child: any, 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.
Parameters
- child: any
  is the actual control or its id
- Optionalrx: number
- Optionalry: number
Returns any
this control
- Defined in index.ts:2471

disable

disable(cascade?: boolean): CvsPin
Disables this control and all its children.
Parameters
- Optionalcascade: boolean
  if true disable child controls
Returns CvsPin
this control
- Defined in index.ts:2550

enable

enable(cascade?: boolean): CvsPin
Enables this control and all its children.
Parameters
- Optionalcascade: boolean
  if true enable child controls
Returns CvsPin
this control
- Defined in index.ts:2537

hide

hide(cascade?: boolean): CvsPin
Hide all the children for this 'pin'.
Parameters
- Optionalcascade: boolean
  always true
Returns CvsPin
this control
- Defined in index.ts:2590

leaveParent

leaveParent(): CvsPin
Remove this control from its parent
Returns CvsPin
this control
- Defined in index.ts:2517

moveBy

moveBy(x: number, y: number): CvsPin
Move this control relative to current position.
Parameters
- x: number
  horizontal distance
- y: number
  vertical distance
Returns CvsPin
this control
- Defined in index.ts:2426

moveTo

moveTo(x: number, y: number): CvsPin
Move this control to an absolute position.
Parameters
- x: number
  horizontal position
- y: number
  vertical position
Returns CvsPin
this control
- Defined in index.ts:2414

parent

parent(parent: any, rx?: number, ry?: number): CvsPin
Adds this control to another control which becomes its parent.
Parameters
- parent: any
  is the parental control or its id
- Optionalrx: number
  x position relative to parent
- Optionalry: number
  y position relative to parent
Returns CvsPin
this control
- Defined in index.ts:2455

removeChild

removeChild(child: any): CvsPin
Remove a child control from this one so that it stays in same screen position.
Parameters
- child: any
  the control to remove or its id
Returns CvsPin
this control
- Defined in index.ts:2494

setEnabled

setEnabled(enable: boolean, cascade?: boolean): CvsPin
An alternative to the enable / disable methods.
Parameters
- enable: boolean
  true / false
- Optionalcascade: boolean
  true apply to all children
Returns CvsPin
this control
- Defined in index.ts:2565

setVisible

setVisible(visible: boolean, cascade?: boolean): CvsPin
An alternative to the show / hide methods.
Parameters
- visible: boolean
  true / false
- Optionalcascade: boolean
  if true hide children
Returns CvsPin
this control
- Defined in index.ts:2605

show

show(cascade?: boolean): CvsPin
Show all the children for this 'pin'.
Parameters
- Optionalcascade: boolean
  always true
Returns CvsPin
this control
- Defined in index.ts:2577