Packageardisia.components.gauges
Classpublic class VLinearGauge
InheritanceVLinearGauge Inheritance LinearGaugeBase Inheritance GaugeBase Inheritance spark.components.supportClasses.SliderBase

Extended vertical slider that supports labels, tick marks, multiple thumbs, and a range button between multiple thumbs.

At first, may appear to be much heavier than the Flex SDK Slider, but the additional functionality optional.

View the technical documentation on the Ardisia Labs website for more information.


Public Properties
 PropertyDefined By
 Inheritededitable : Boolean
Whether the value can be changed via user interaction.
GaugeBase
 InheritedlabelDefaultPrecision : Number
Default precision for the number formatter if a labelsFormatFunction is not provided.
GaugeBase
 InheritedlabelsFormatFunction : Function
The callback function used to format the labels.
GaugeBase
 InheritedmajorTickCount : int
The number of major ticks to display.
GaugeBase
 InheritedmaximumRangeValue : Number
The maximum allowed numerical difference between the values of each thumb.
LinearGaugeBase
 InheritedminimumRangeValue : Number
The minimum allowed numerical difference between the values of each thumb.
LinearGaugeBase
 InheritedminorTickCount : int
The number of minor ticks to display between major ticks.
GaugeBase
 InheritedshowRange : Boolean
Display a draggable button between the thumbs.
LinearGaugeBase
 InheritedshowThumbLabels : Boolean
True to display labels along with the thumbs.
LinearGaugeBase
 InheritedshowTickLabels : Boolean
True to display labels along with the major ticks.
GaugeBase
 InheritedshowTicks : Boolean
True to display ticks.
GaugeBase
 InheriteduseMultiThumbs : Boolean
True to display 2 thumbs.
LinearGaugeBase
 Inheritedvalues : ArrayCollection
Array of thumb values, sorted numerically from the smaller to the larger value.
LinearGaugeBase
Public Methods
 MethodDefined By
 Inherited
dispose():void
Remove the component from the display list and prepare the component for garbage collection.
GaugeBase
 Inherited
setValues(newValue:Number, multiNewValue:Number):void
Update the "values" property and updates bindings without invalidating properties.
LinearGaugeBase
Protected Methods
 MethodDefined By
 Inherited
commitProperties():void
[override]
LinearGaugeBase
 Inherited
createChildren():void
[override]
LinearGaugeBase
 Inherited
eventSwallower(event:Event):void
Swallows an event and immediately stops propagation.
LinearGaugeBase
 Inherited
flipThumbs():MouseEvent
If multiple thumbs are displayed, switches each thumb's position with one another.
LinearGaugeBase
 Inherited
formatLabelText(value:Number):Object
Format the value to a human readable String.
GaugeBase
 Inherited
multiThumbInstanceHandler(event:Event):void
Handles events on the multiThumb instance
LinearGaugeBase
 Inherited
rangeThumbInstanceHandler(event:Event):void
LinearGaugeBase
 Inherited
setValue(value:Number):void
[override]
LinearGaugeBase
 Inherited
updateMultiThumbPart():void
Update the multi thumb skin parts.
LinearGaugeBase
 Inherited
updateRangeThumbFactoryPart():void
Update the range thumb skin part.
LinearGaugeBase
 Inherited
updateThumbLabels():void
Update the thumb labels skin parts.
LinearGaugeBase
 Inherited
updateTickLabels():void
Update the tick labels skin parts.
GaugeBase
 Inherited
validateRange(proposedValue:Number):Number
Ensures that the proposed value will not exceed min/max range bounds.
LinearGaugeBase
Events
 Event Summary Defined By
 Inherited
rangeDragEnd
Dispatched at the end of a range button drag.LinearGaugeBase
 Inherited
rangeDragging
Dispatched during range button dragging.LinearGaugeBase
 Inherited
rangeDragStart
Dispatched at the beginning of range button drag.LinearGaugeBase
 Inherited
valuesCommit
Dispatched when the value(s) change.LinearGaugeBase
Styles
 Style Description Defined By
 Inherited
labelOffset
Type: Number CSS Inheritance: no
The number of pixels to offset the labels from the tick marks.		GaugeBase
 Inherited
majorTickColor
Type: uint Format: Color CSS Inheritance: no
The color of the major ticks.		GaugeBase
 Inherited
majorTickForm
Type: String CSS Inheritance: no
The shape of the major tick mark: line or circle.		GaugeBase
 Inherited
majorTickLength
Type: Number CSS Inheritance: no
The length of the major tick.		GaugeBase
 Inherited
majorTickThickness
Type: Number CSS Inheritance: no
The thickness of major tick strokes or the radius of the circle.		GaugeBase
 Inherited
minorTickColor
Type: uint Format: Color CSS Inheritance: no
The color of the minor ticks.		GaugeBase
 Inherited
minorTickForm
Type: String CSS Inheritance: no
The shape of the minor tick mark: line or circle.		GaugeBase
 Inherited
minorTickLength
Type: Number CSS Inheritance: no
The length of the minor tick.		GaugeBase
 Inherited
minorTickThickness
Type: Number CSS Inheritance: no
The thickness of minor tick strokes or the radius of the circle.		GaugeBase
 Inherited
thumbLabelOffset
Type: Number CSS Inheritance: no
Offset applied to the thumb labels.		LinearGaugeBase
 Inherited
tickOffset
Type: Number CSS Inheritance: no
The number of pixels to offset the tick marks from the track.		GaugeBase
Skin Parts

This component uses skins made up of skin parts. Do not set the skin parts directly. The component's skin sets the skin parts.


 Skin Part Description Defined By
 Inherited
labelsFactoryPart:mx.core.IFactory
Required: false Part Type: Dynamic
Factory that creates the labels that are displayed along with the major ticks. Used by both the linear and radial gauges.

The IFactory must return an object of type Label		GaugeBase
 Inherited
multiThumbFactoryPart:mx.core.IFactory
Required: false Part Type: Dynamic
Factory that creates the optional second, multi thumb.

The IFactory must return an object of type ButtonBase		LinearGaugeBase
 Inherited
rangeThumbFactoryPart:mx.core.IFactory
Required: false Part Type: Dynamic
Factory that creates the optional, draggable, button that fills the range between the thumb buttons. Only exists if there are multiple thumbs and if the "showRange" property is true.

The IFactory must return an object of type ButtonBase		LinearGaugeBase
 Inherited
thumbLabelsFactoryPart:mx.core.IFactory
Required: false Part Type: Dynamic
Factory that creates the labels that are displayed along with the thumbs.

The IFactory must return an object of type Label		LinearGaugeBase
Skin States

To skin the component, implement a skin that defines the following states. Although you must implement all skin states, a skin state can be empty. An empty skin state specifies no changes to the default skin state.


 Skin State Description Defined By
 Inherited
notEditable
 State used when the control is disabled, but the component should not be displayed as disabled. Useful to statically present information via a slider. For example: a thermometer to show fundraising totals. GaugeBase




Mon Sep 15 2014, 01:55 AM -06:00