Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_Protected_The unique identifier for this control.
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.
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
Get or set the corner radii used for this control.
To set the radii the parameters must be one of the following
If no parameter is passed or does not match one of the above then an array of the currently used radii values.
valid radii combination
an array of the currently used radii values
Disables this control.
Optionalcascade: booleanif true disable child controls
this control
Enables this control.
Optionalcascade: booleanif true enable child controls
this control
Make this control invisible.
Optionalcascade: booleanif true hide any children
this control
the high value of the range
Checks whether a value is between the lower and upper limits for this control. It allows the user to prevalidate a value before attempting to change the control's value.
value to test
true if the value lies within the control's limits else false
Set the lower and upper limits for the slider
lower limit
upper limit
this slider object
the low value of the range
Move this control relative to current position.
horizontal distance
vertical distance
this control
Move this control to an absolute position.
horizontal position
vertical position
this control
Makes the controls background opaque. The actual color depends on the controls color scheme.
The second parameter, alpha, is optional and controls the level of opaqueness from 0 - transparent to 255 - fully opaque (default value).
alpha value for controls background color.
this control
Sets this controls display orientation to one of the four cardinal compass points. An invalid parameter will set the orientation to 'east' which is the default value.
'north', 'south', 'east' or 'west'
this control
Adds this control to another control which becomes its parent.
is the parental control or its id
Optionalrx: numberx position relative to parent
Optionalry: numbery position relative to parent
this control
Sets or gets the low and high thumb values for this control. If both parameters are within the ranger limits then they are accepted and the thumbs are moved to the correct position.
If either of the parameters are invalid then they are ignored and the method returns the current range low and high values.
Optionalv0: numberlow value
Optionalv1: numberhigh value
this control or the low/high values
Remove a child control from this one so that it stays in same screen position.
the control to remove or its id
this control
If the name of a valid color scheme is provided then it will use it to display the control, non-existant scheme names will be ignored. In both cases this control is returned.
If there is no parameter it returns the name of the current color scheme used by this control.
Optionalname: stringthe color scheme name e.g. 'blue'
Optionalcascade: booleanif true propogate scheme to all child controls.
this control or the control's 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
Make this control visible.
Optionalcascade: booleanif true then show any children
this control
The track can be divided up into a number of domains separated with major ticks. The major domains and be further divided into subdomains separated with minor ticks. If the final parameter is true then values returned by the slider are consrained to the tick values.
the number of major domains on the track
the number of minor domains between major ticks
Optionalstick2ticks: booleanslider value is constrainged to tick values
this slider object
Sets the size of the text to use in the tooltip.
Optionaltsize: numbertext size for this tooltip
Create a tooltip for this control.
the text to appear in the tooltip
this control
If both parameter values are within the ranger's limits it will move the thumbs to the appropriate positions. If no parameters are passed or if either is outside the ranger's limits this methods returns the an array containing the current ranger values.
Optionalv0: numbervalue to set the first thumbs.
Optionalv1: numbervalue to set the second thumbs.
an array of the current values or this ranger object.
Gets or sets the thickness of the track.
The thickness is constrained to the range ≥ 4 and ≤ 0.1 * control width.
the required track thickness)
the curent track thickness or this control
A slider with two draggable thumbs
This control has 2 thumbs that can be dragged along a track. The thumbs' positions represent a low and high value both within user defined limits.
Major and minor tick marks can be added to the bar and supports stick-to-ticks if wanted.