qnx.fuse.ui.slider.SliderBase

SliderBase

Properties | Methods


Packageqnx.fuse.ui.slider
Classpublic class SliderBase
InheritanceSliderBase Inheritance UIComponent Inheritance flash.display.MovieClip
Subclasses Slider, ToggleSwitch

The base class for the Slider and VolumeSlider classes.

Do not instantiate this class. Instead, use the Slider or VolumeSlider class.



Class information:
PlayBook Tablet OS Version:   1.0.6

See also

Slider
VolumeSlider



Public Properties

 PropertyDefined By
 InheritedexplicitHeight : Number
[read-only] Returns the explicit height (actual height, in pixels) of the UI component.
UIComponent
 InheritedexplicitWidth : Number
[read-only] Returns the explicit width (actual width, in pixels) of the UI component.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether or not the component should be included in its parent container's layout.
UIComponent
 InheritedlayoutData : Object
Returns the layout data for the object.
UIComponent
 InheritedminHeight : Number
Gets or sets the minimum preferred height of the control.
UIComponent
 InheritedminWidth : Number
Gets or sets the minimum preferred width of the control.
UIComponent

Public Methods

 MethodDefined By
  
Do not instantiate this class.
SliderBase
 Inherited
childChanged(resizedChild:DisplayObject = null):Boolean
Notifies the UIComponent that one or more of its children has changed in a manner that may affect this object's layout.
UIComponent
 Inherited
destroy():void
Call this method when you want to have your object collected by the garbage collector.
UIComponent
 Inherited
Returns the size options for the given control.
UIComponent
 Inherited
Calling this method results in a call to the components validateDisplayList() method before the display list is rendered.
UIComponent
 Inherited
Calling this method results in a call to the components validateProperties() method before the display list is rendered.
UIComponent
 Inherited
measure(availableWidth:Number, availableHeight:Number):LayoutMeasurement
This method calls doMeasure() in order to calculate the preferred size of the control.
UIComponent
 Inherited
setActualSize(w:Number, h:Number):void
Sets the width and height of the object without setting the explicitWidth and explicitHeight.
UIComponent
  
setFillSkin(skin:Object):void
Sets the fill skin for the slider.
SliderBase
 Inherited
setLayoutBounds(bounds:Rectangle):void
Sets the receiver's size and location to the rectangular area specified by the arguments.
UIComponent
 Inherited
setPosition(x:Number, y:Number):void
Sets the x and y position of the component.
UIComponent
  
setThumbSkin(skin:Object):void
Sets the skin for the slider thumb button.
SliderBase
  
setTrackSkin(skin:Object):void
Sets the skin for the track of the slider.
SliderBase
 Inherited
Validates the display list of the component by calling the updateDisplayList().
UIComponent
 Inherited
Validates the component immediately by calling validateProperties(), validateSizes(), and validateDisplayList() if necessary.
UIComponent
 Inherited
Validates the properties of the component by calling the commitProperties() method.
UIComponent

Protected Methods

 MethodDefined By
 Inherited
Process properties of the component.
UIComponent
 Inherited
Process the state of the component.
UIComponent
  
createFill(linkage:Object):void
SliderBase
  
createThumb(linkage:Object):void
SliderBase
  
createTrack(linkage:Object):void
SliderBase
  
doMeasure(availableWidth:Number, availableHeight:Number):LayoutMeasurement
[override] Measures the size of the component so that it can be reported to the layout framework for laying the component out properly.
SliderBase
  
drawFill():void
Draws the fill of the slider.
SliderBase
 Inherited
flushCache():void
Invoked as part of parentLayoutChanged.
UIComponent
 Inherited
onAdded():void
Called when the instance is added to the stage.
UIComponent
 Inherited
onRemoved():void
Called when the instance is removed from the stage.
UIComponent
 Inherited
Invalidates the parent's size and display list if includeInLayout property is set to true.
UIComponent
  
Called when the position of the thumb on the x axis has changed.
SliderBase
  
Called when the thumb has been pressed by the user.
SliderBase
  
Called when the thumb has been released by the user.
SliderBase
  
Called when the thumb has been pressed by the user.
SliderBase
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Sets the size and position of the children of the component.
UIComponent

Constructor Detail

SliderBase()


public function SliderBase()

Do not instantiate this class.

Method Detail

createFill()


protected function createFill(linkage:Object):void

Parameters

linkage:Object

createThumb()


protected function createThumb(linkage:Object):void

Parameters

linkage:Object

createTrack()


protected function createTrack(linkage:Object):void

Parameters

linkage:Object

doMeasure()


override protected function doMeasure(availableWidth:Number, availableHeight:Number):LayoutMeasurement

Measures the size of the component so that it can be reported to the layout framework for laying the component out properly.

Parameters

availableWidth:Number — The avaliable size in the x dimension dictated by the measurements of the parent. Controls should not exceed this size.
availableHeight:Number — The avaliable size in the y dimension dictated by the measurements of the parent. Controls should not exceed this size.

Returns

LayoutMeasurement

drawFill()


protected function drawFill():void

Draws the fill of the slider. The default implentation sets the width of the fill based on a percenatge of the track width.

setFillSkin()


public function setFillSkin(skin:Object):void

Sets the fill skin for the slider. The fill skin is the area of the track to the left of the slider thumb button (in a horizontal slider) that represents the current value of the slider.

You can pass in a qualified class name String, or the actual class. In either instance the class that is used must implement the ISkin interface.

Note: Do not pass in an instance of a skin class. This may cause unexpected behavior.

Parameters

skin:Object — The fill skin to set.

setThumbSkin()


public function setThumbSkin(skin:Object):void

Sets the skin for the slider thumb button. The thumb is the button that the user moves along the track to change the value of the slider.

You can pass in a qualified class name String, or the actual class. In either instance the class that is used must implement the ISkin interface.

Note: Do not pass in an instance of a skin class. This may cause unexpected behavior.

Parameters

skin:Object — The button skin to set.

setTrackSkin()


public function setTrackSkin(skin:Object):void

Sets the skin for the track of the slider. The track is the vertical or horizontal line that the thumb button moves along.

You can pass in a qualified class name String, or the actual class. In either instance the class that is used must implement the ISkin interface.

Note: Do not pass in an instance of a skin class. This may cause unexpected behavior.

Parameters

skin:Object — The track skin to set.

thumbPositionChanged()


protected function thumbPositionChanged():void

Called when the position of the thumb on the x axis has changed. Occurs when the user drags the thumb or has clicked on the track. You can override this method if you wish to have elements update themselves based on the value property.

thumbPressed()


protected function thumbPressed():void

Called when the thumb has been pressed by the user.

You can override this method to perform custom actions when the user presses the thumb.

thumbReleased()


protected function thumbReleased():void

Called when the thumb has been released by the user.

You can override this method to perform custom actions when the user has released the thumb.

trackPressed()


protected function trackPressed():void

Called when the thumb has been pressed by the user.

You can override this method to perform custom actions when the user presses the thumb. The default implementation of this method moves the thumb to where the user has pressed and initiates a drag operation.