ardisia.components.gauges.HLinearGauge

Package	ardisia.components.gauges
Class	public class HLinearGauge
Inheritance	HLinearGauge LinearGaugeBase GaugeBase spark.components.supportClasses.SliderBase

Extended horizontal 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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		editable : Boolean Whether the value can be changed via user interaction.	GaugeBase
		labelDefaultPrecision : Number Default precision for the number formatter if a labelsFormatFunction is not provided.	GaugeBase
		labelsFormatFunction : Function The callback function used to format the labels.	GaugeBase
		majorTickCount : int The number of major ticks to display.	GaugeBase
		maximumRangeValue : Number The maximum allowed numerical difference between the values of each thumb.	LinearGaugeBase
		minimumRangeValue : Number The minimum allowed numerical difference between the values of each thumb.	LinearGaugeBase
		minorTickCount : int The number of minor ticks to display between major ticks.	GaugeBase
		showRange : Boolean Display a draggable button between the thumbs.	LinearGaugeBase
		showThumbLabels : Boolean True to display labels along with the thumbs.	LinearGaugeBase
		showTickLabels : Boolean True to display labels along with the major ticks.	GaugeBase
		showTicks : Boolean True to display ticks.	GaugeBase
		useMultiThumbs : Boolean True to display 2 thumbs.	LinearGaugeBase
		values : ArrayCollection Array of thumb values, sorted numerically from the smaller to the larger value.	LinearGaugeBase

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		dispose():void Remove the component from the display list and prepare the component for garbage collection.	GaugeBase
		setValues(newValue:Number, multiNewValue:Number):void Update the "values" property and updates bindings without invalidating properties.	LinearGaugeBase

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		commitProperties():void [override]	LinearGaugeBase
		createChildren():void [override]	LinearGaugeBase
		eventSwallower(event:Event):void Swallows an event and immediately stops propagation.	LinearGaugeBase
		flipThumbs():MouseEvent If multiple thumbs are displayed, switches each thumb's position with one another.	LinearGaugeBase
		formatLabelText(value:Number):Object Format the value to a human readable String.	GaugeBase
		multiThumbInstanceHandler(event:Event):void Handles events on the multiThumb instance	LinearGaugeBase
		rangeThumbInstanceHandler(event:Event):void [override] Handles events on the rangeThumb instance.	HLinearGauge
		setValue(value:Number):void [override]	LinearGaugeBase
		updateMultiThumbPart():void Update the multi thumb skin parts.	LinearGaugeBase
		updateRangeThumbFactoryPart():void Update the range thumb skin part.	LinearGaugeBase
		updateThumbLabels():void Update the thumb labels skin parts.	LinearGaugeBase
		updateTickLabels():void Update the tick labels skin parts.	GaugeBase
		validateRange(proposedValue:Number):Number Ensures that the proposed value will not exceed min/max range bounds.	LinearGaugeBase

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
rangeDragEnd	Dispatched at the end of a range button drag.	LinearGaugeBase
rangeDragging	Dispatched during range button dragging.	LinearGaugeBase
rangeDragStart	Dispatched at the beginning of range button drag.	LinearGaugeBase
valuesCommit	Dispatched when the value(s) change.	LinearGaugeBase

Styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
labelOffset	Type: Number CSS Inheritance: no The number of pixels to offset the labels from the tick marks.	GaugeBase
majorTickColor	Type: uint Format: Color CSS Inheritance: no The color of the major ticks.	GaugeBase
majorTickForm	Type: String CSS Inheritance: no The shape of the major tick mark: line or circle.	GaugeBase
majorTickLength	Type: Number CSS Inheritance: no The length of the major tick.	GaugeBase
majorTickThickness	Type: Number CSS Inheritance: no The thickness of major tick strokes or the radius of the circle.	GaugeBase
minorTickColor	Type: uint Format: Color CSS Inheritance: no The color of the minor ticks.	GaugeBase
minorTickForm	Type: String CSS Inheritance: no The shape of the minor tick mark: line or circle.	GaugeBase
minorTickLength	Type: Number CSS Inheritance: no The length of the minor tick.	GaugeBase
minorTickThickness	Type: Number CSS Inheritance: no The thickness of minor tick strokes or the radius of the circle.	GaugeBase
thumbLabelOffset	Type: Number CSS Inheritance: no Offset applied to the thumb labels.	LinearGaugeBase
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.

Hide Inherited Skin Parts

Show Inherited Skin Parts

	Description	Defined By
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
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
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
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.

Hide Inherited Skin States

Show Inherited Skin States

	Skin State		Description	Defined By
		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

Method Detail

rangeThumbInstanceHandler

()

method

override protected function rangeThumbInstanceHandler(event:Event):void

Handles events on the rangeThumb instance.

Parameters

event:Event — the Event that triggered the handler

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

Ardisia Component Library Documentation	All Packages \| All Classes \| Index \| Frames No Frames
HLinearGauge	Properties \| Methods \| Events \| Styles \| Skin Parts \| Skin States