AbstractThe unique identifier for this control.
True if the pane is closed else false.
True if the pane is closing else false.
This is true if the control can respond to UI events else false.
Use enable() and disable() to enable and disable it.
This is true if the control background is opaque else false.
Use opaque() and transparent() display / hide the background.
True if the pane is open else false.
true if the pane is opening else false.
This is true if the control is visible else false.
Use hide() and show() to set visibility.
The type name for this control.
(type name = class name without the Cvs prefix)
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.
is the actual control or its id
Optionalrx: numberOptionalry: numberthis control
Execute one or more configuration methods on this control.
The parameter is a user defined object where each field is the name of a configuration method and its value is the method's parameter(s). Multiple parameters should be in an array and use 'undefined' if the method expects no parameters.
This object will change the color scheme, text size and alignment, it will also make sure it is visible.
{ scheme : 'red', textSize : 12, textAlign: ['left', 'top'], show : undefined }
If the field name does not exist or not a valid function of this
control it will be silently ignored.
There is no error checking on the parameters, it is up to the user to ensure they are valid for the control method.
the configuration object
this control
ProtectedcreateGet the 'depth' the pane will intrude into the canvas when open.
the depth
Sets the icon and its alignment relative to any text in the control.
Processing constants are used to define the icon alignment.
the icon to use for this control
OptionalalignH: string'left', 'right' or 'center'
OptionalalignV: string'top', 'bottom' or 'center'
this control
Open this pane.
this control
Remove a child control from this one so that it stays in same screen position.
the control to remove or its id
this control
Sets or gets the color scheme used by the pane's tab and the translucent background. Controls on the pane are not affected.
Optionalname: stringthe color scheme name e.g. 'blue'
this pane or its color scheme
This sets the event handler to be used when this control fires an event. The parameter can take one of three forms:
the function to handle this control's events.
this control
An alternative to the enable / disable methods.
true / false
Optionalcascade: booleantrue apply to all children
this control
An alternative to the show / hide methods.
true / false
Optionalcascade: booleanif true hide children
this control
ProtectedtabGets or sets the global minimum height for pane tabs.
the minimum tab height (must be ≥10)
this gui instance
Sets the current text.
Processing constants are used to define the alignment.
the text toset
this control
Sets the text font for the pane tab.
Optionalfont: stringthe text font to use
this control
Sets the text size for the pane tab.
Optionalts: numberthe text size to use
this control
Sets the text style for the pane tab.
Optionalstyle: stringthe text style to use
Optionalslant: numberthis control
An offscreen placeholder for other controls
Panes are controls that can slide into and out the display area along with any other controls placed on them.
Panes are attached to one of the 4 display sides with only a tab visible. Clicking on the tab will cause the pane to slide into the display area. Clicking on the pane background or on it's tab will close the pane.
Only one pane can be open at a time, so opening a second pane will close any open pane.
This control is useful for freeing up the dsplay area for other purposes.