Class CvsPane`Abstract`

This class provides most of the core functionality for the canvasGUI controls.

Hierarchy

CvsBaseControl
- CvsPane

Index

Accessors

id isClosed isClosing isEnabled isOpaque isOpen isOpening isVisible tab type

Methods

addChild close depth disable enable hide icon moveBy moveTo noIcon noText open removeChild scheme setAction show shrink text textFont textSize textStyle

Accessors

id

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

Returns string
Inherited from CvsBaseControl.id
- Defined in index.ts:1805

isClosed

get isClosed(): boolean
True if the pane is closed else false.

Returns boolean
- Defined in index.ts:6128

isClosing

get isClosing(): boolean
True if the pane is closing else false.

Returns boolean
- Defined in index.ts:6131

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

isOpaque

get isOpaque(): boolean
This is true if the control background is opaque else false.

Use opaque() and transparent() display / hide the background.

Returns boolean
Inherited from CvsBaseControl.isOpaque
- Defined in index.ts:1823

isOpen

get isOpen(): boolean
True if the pane is open else false.

Returns boolean
- Defined in index.ts:6151

isOpening

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

Returns boolean
- Defined in index.ts:6154

isVisible

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

Use hide() and show() to set visibility.

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

tab

get tab(): any
Get the tab button.

Returns any
- Defined in index.ts:6299

type

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

Returns string
Inherited from CvsBaseControl.type
- Defined in index.ts:1811

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 id
- Optional rx: number
- Optional ry: number
Returns any
Inherited from CvsBaseControl.addChild
- Defined in index.ts:1984

close

close(): CvsPane
Close this pane.

Returns
this control

Returns CvsPane
- Defined in index.ts:6114

depth

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

Returns
the depth

Returns number
- Defined in index.ts:6106

disable

disable(): CvsPane
Disables tab opening / closure

Returns
this control

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

enable

enable(): CvsPane
Enables tab opening / closure

Returns
this control

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

hide

hide(): CvsPane
Make this control invisible

Returns
this control

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

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:6240

moveBy

moveBy(x: number, y: number): CvsPane
Move this control relative to current position.

Returns
this control
Parameters
- x: number
  
  horizontal distance
- y: number
  
  vertical distance
Returns CvsPane
Inherited from CvsBaseControl.moveBy
- Defined in index.ts:1873

moveTo

moveTo(x: number, y: number): CvsPane
Move this control to an absolute position.

Returns
this control
Parameters
- x: number
  
  horizontal position
- y: number
  
  vertical position
Returns CvsPane
Inherited from CvsBaseControl.moveTo
- Defined in index.ts:1861

noIcon

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

Returns
this control

Returns CvsPane
- Defined in index.ts:6249

noText

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

Returns
this control

Returns CvsPane
- Defined in index.ts:6228

open

open(): void
Open this pane.

Returns
this control

Returns void
- Defined in index.ts:6137

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 id
Returns CvsPane
Inherited from CvsBaseControl.removeChild
- Defined in index.ts:2005

scheme

scheme(name?: string): ColorScheme | CvsBaseControl
Sets or gets the color scheme used by the pane's tab and the translucent background. Controls on the pane are not affected.

Returns
this pane or its color scheme
Parameters
- Optional name: string
  
  the color scheme name e.g. 'blue'
Returns ColorScheme | CvsBaseControl
Overrides CvsBaseControl.scheme
- Defined in index.ts:6207

setAction

setAction(event_handler: Function): CvsPane
This sets the event handler to be used when this control fires an event. The parameter can take one of 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 control's events.
Returns CvsPane
Inherited from CvsBaseControl.setAction
- Defined in index.ts:2053

show

show(): CvsPane
Make this control visible

Returns
this control

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

shrink

shrink(dim?: string): any
Shrink the pane tab to fit its 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
- Defined in index.ts:6292

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:6219

textFont

textFont(tf?: any): CvsPane
Sets the text font for the pane tab.

Returns
this control
Parameters
- Optional tf: any
  
  the text font to use
Returns CvsPane
- Defined in index.ts:6280

textSize

textSize(ts?: number): CvsPane
Sets the text size for the pane tab.

Returns
this control
Parameters
- Optional ts: number
  
  the text size to use
Returns CvsPane
- Defined in index.ts:6259

textStyle

textStyle(ty?: number): CvsPane
Sets the text style for the pane tab.

Returns
this control
Parameters
- Optional ty: number
  
  the text style to use
Returns CvsPane
- Defined in index.ts:6270

Generated using TypeDoc