Class CvsPane`Abstract`

Base class for all controls

It provides most of the functionality for the controls

Hierarchy

CvsBaseControl
- CvsPane

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 CvsBaseControl.addChild
- Defined in index.ts:1359

background

background(rgba: string): CvsPane
Sets the pane background color to use when open. There are 2 predined option ...
1. 'dark' semi transparent black background : 'rgba(0,0,0,0.6)'
2. 'light' semi transparent white background : 'rgba(255,255,255,0.6)'
Alternatively the user can provide any valid CSS color specification but if invalid the results are unpredicatable and likely to cause the sketch to fail.

Returns
this control
Parameters
- rgba: string
  
  'light', 'dark' or valid CSS color specification
Returns CvsPane
- Defined in index.ts:5177

close

close(): CvsPane
Close this pane

Returns
this control

Returns CvsPane
- Defined in index.ts:5195

depth

depth(): number
Get the 'depth' the pane will intrude into the canvas when open.

Returns
the depth

Returns number
- Defined in index.ts:5161

disable

disable(): CvsPane
Disables tab opening / closure

Returns
this control

Returns CvsPane
Overrides CvsBaseControl.disable
- Defined in index.ts:5427

enable

enable(): CvsPane
Enables tab opening / closure

Returns
this control

Returns CvsPane
Overrides CvsBaseControl.enable
- Defined in index.ts:5418

getParent

getParent(): CvsBaseControl
Returns
this controls parent

Returns CvsBaseControl
Inherited from CvsBaseControl.getParent
- Defined in index.ts:1412

hide

hide(): CvsPane
Make this control invisible

Returns
this control

Returns CvsPane
Overrides CvsBaseControl.hide
- Defined in index.ts:5437

icon

icon(i: PGraphics, align?: number): CvsPane
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
Parameters
- i: PGraphics
  
  the icon to use for this control
- Optional align: number
  
  LEFT or RIGHT
Returns CvsPane
- Defined in index.ts:5344

invalidateBuffer

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

Returns
this control

Returns CvsPane
Inherited from CvsBaseControl.invalidateBuffer
- Defined in index.ts:1668

isClosed

isClosed(): boolean
Returns
true if the pane is closed else false

Returns boolean
- Defined in index.ts:5212

isClosing

isClosing(): boolean
Returns
true if the pane is closinging else false

Returns boolean
- Defined in index.ts:5220

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 CvsBaseControl.isEnabled
- Defined in index.ts:1477

isOpen

isOpen(): boolean
Returns
true if the pane is open else false

Returns boolean
- Defined in index.ts:5245

isOpening

isOpening(): boolean
Returns
true if the pane is opening else false

Returns boolean
- Defined in index.ts:5253

isVisible

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

Since
0.9.3

Returns boolean
Inherited from CvsBaseControl.isVisible
- Defined in index.ts:1544

name

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

Returns string
Inherited from CvsBaseControl.name
- Defined in index.ts:1300

noIcon

noIcon(): CvsPane
Removes the icon from the pane tab.

Returns
this control

Returns CvsPane
- Defined in index.ts:5353

noText

noText(): CvsPane
Removes the text from the pane tab.

Returns
this control

Returns CvsPane
- Defined in index.ts:5332

open

open(): void
Close this pane

Returns
this control

Returns void
- Defined in index.ts:5228

removeChild

removeChild(c: string | CvsBaseControl): CvsPane
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 CvsPane
Inherited from CvsBaseControl.removeChild
- Defined in index.ts:1381

scheme

scheme(id?: string, cascade?: boolean): any
Sets or gets the color scheme used by this control.

Returns
this control or the control's color scheme
Parameters
- Optional id: string
  
  the color scheme id e.g. 'blue'
- Optional cascade: boolean
  
  if true propogate scheme to all child controls.
Returns any
Inherited from CvsBaseControl.scheme
- Defined in index.ts:1326

setAction

setAction(event_handler: Function): CvsPane
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 CvsPane
Inherited from CvsBaseControl.setAction
- Defined in index.ts:1428

show

show(): CvsPane
Make this control visible

Returns
this control

Returns CvsPane
Overrides CvsBaseControl.show
- Defined in index.ts:5447

shrink

shrink(dim?: string): any
Shrink the pane tab 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 any
Overrides CvsBaseControl.shrink
- Defined in index.ts:5375

tab

tab(): any
Returns
the tab button

Returns any
- Defined in index.ts:5410

text

text(t: string, align?: number): CvsPane
Sets the current text.

Processing constants are used to define the alignment.

Returns
this control
Parameters
- t: string
  
  the text toset
- Optional align: number
  
  LEFT, CENTER or RIGHT
Returns CvsPane
- Defined in index.ts:5323

Class CvsPaneAbstract

Hierarchy

Index

Properties

Methods

Properties

action

Methods

addChild

Returns

Parameters

c: string | CvsBaseControl

Optional rx: number

Optional ry: number

Returns any

background

Returns

Parameters

rgba: string

Returns CvsPane

close

Returns

Returns CvsPane

depth

Returns

Returns number

disable

Returns

Returns CvsPane

enable

Returns

Returns CvsPane

getParent

Returns

Returns CvsBaseControl

hide

Returns

Returns CvsPane

icon

Returns

Parameters

i: PGraphics

Optional align: number

Returns CvsPane

invalidateBuffer

Returns

Returns CvsPane

isClosed

Returns

Returns boolean

isClosing

Returns

Returns boolean

isEnabled

Returns

Returns boolean

isOpen

Returns

Returns boolean

isOpening

Returns

Returns boolean

isVisible

Returns

Since

Returns boolean

name

Returns

Returns string

noIcon

Returns

Returns CvsPane

noText

Returns

Returns CvsPane

open

Returns

Returns void

removeChild

Returns

Class CvsPane`Abstract`

`Optional` rx: number

`Optional` ry: number

`Optional` align: number

`Optional` id: string

`Optional` cascade: boolean

`Optional` dim: string

`Optional` align: number

`Optional` ts: number