Packagekm.components
Classpublic class ScrollBar
InheritanceScrollBar Inheritance UIComponent Inheritance flash.display.Sprite

The ScrollBar component class.



Public Properties
 PropertyDefined by
  autoDisable : Boolean
Disable the scrollbar when there's nothing to scroll.
ScrollBar
  bar : BaseButton
[read-only] >> Reference to the bar.
ScrollBar
  down : BaseButton
[read-only] >> Reference to the left / down button.
ScrollBar
  dragging : Boolean
ScrollBar
 Inheritedduotone : Array
The duotone property can be used to convert the colors of the component into duotone.
UIComponent
 Inheritedenabled : Boolean
Specifies if the component is enabled.
If a component is disabled, it will be turned into grayscale and become partly transparent.
UIComponent
  groupButtons : Boolean
Group the up/down and left/right buttons.
ScrollBar
 Inheritedheight : Number
UIComponent
  left : BaseButton
[read-only] >> Reference to the left / down button.
ScrollBar
  lineScrollSize : Number
Gets or sets how much to scroll when the scroll bar up/right or down/left button is pressed.
ScrollBar
  maxScrollPosition : Number
Gets or sets the maximum scroll position.
ScrollBar
  minScrollPosition : Number
Gets or sets the minimum scroll position.
ScrollBar
  onScroll : Function
onScroll handler.
ScrollBar
  orientation : int
The orientation of the scrollbar ( ScrollBar.HORIZONTAL or ScrollBar.VERTICAL ).
This property should be set before you apply a skin and should not be changed once it has been set.
ScrollBar
  pageScrollSize : Number
Gets or sets how much to scroll when the scroll bar track is pressed.
ScrollBar
  pageSize : Number
Gets or sets the page size.
ScrollBar
  right : BaseButton
[read-only] >> Reference to the right / up button.
ScrollBar
  scrollPosition : Number
Gets or sets the current scroll position.
ScrollBar
  thickness : int
[read-only] Gets the thickness of the scrollbar.
ScrollBar
 InheritedtoolTip : String
Text to use as toolTip when ToolTip is enabled.
UIComponent
  track : Image
[read-only] >> Reference to the track.
ScrollBar
  up : BaseButton
[read-only] >> Reference to the right / up button.
ScrollBar
 Inheritedwidth : Number
UIComponent
 Inheritedx : Number
UIComponent
 Inheritedy : Number
UIComponent
Public Methods
 MethodDefined by
  
ScrollBar
 Inherited
clone():*
Returns a clone of the component.
The skin of the component is cloned but other things like the text of a label or the items of a list aren't.
UIComponent
 Inherited
move(x:int, y:int, animationMode:int = 0, animationFrames:int = 12, easeInOut:Boolean = false):void
Moves the component to the specified coordinates.
UIComponent
 Inherited
setProperties(o:Object):void
Sets a number of properties at once.
UIComponent
  
setScrollProperties(pageSize:Number, minScrollPosition:Number, maxScrollPosition:Number, pageScrollSize:Number = 0):void
Sets multiple scroll properties at once.
ScrollBar
 Inherited
setSize(w:int, h:int):void
Sets the size width and height.
UIComponent
Events
 EventSummaryDefined by
 Inherited The animationComplete event is broadcasted when an animated move is completed.UIComponent
    ScrollBar
Public Constants
 ConstantDefined by
  HORIZONTAL : int = 1
[static]
ScrollBar
  VERTICAL : int = 0
[static]
ScrollBar
Property detail
autoDisableproperty
public var autoDisable:Boolean

Disable the scrollbar when there's nothing to scroll.

The default value is false.

barproperty 
bar:BaseButton  [read-only]

>> Reference to the bar.

Implementation
    public function get bar():BaseButton
downproperty 
down:BaseButton  [read-only]

>> Reference to the left / down button.

Implementation
    public function get down():BaseButton
draggingproperty 
public var dragging:Boolean
groupButtonsproperty 
public var groupButtons:Boolean

Group the up/down and left/right buttons.

The default value is false.

leftproperty 
left:BaseButton  [read-only]

>> Reference to the left / down button.

Implementation
    public function get left():BaseButton
lineScrollSizeproperty 
lineScrollSize:Number  [read-write]

Gets or sets how much to scroll when the scroll bar up/right or down/left button is pressed.

Implementation
    public function get lineScrollSize():Number
    public function set lineScrollSize(value:Number):void
maxScrollPositionproperty 
maxScrollPosition:Number  [read-write]

Gets or sets the maximum scroll position.

Implementation
    public function get maxScrollPosition():Number
    public function set maxScrollPosition(value:Number):void
minScrollPositionproperty 
minScrollPosition:Number  [read-write]

Gets or sets the minimum scroll position.

Implementation
    public function get minScrollPosition():Number
    public function set minScrollPosition(value:Number):void
onScrollproperty 
public var onScroll:Function

onScroll handler.

orientationproperty 
public var orientation:int

The orientation of the scrollbar ( ScrollBar.HORIZONTAL or ScrollBar.VERTICAL ).
This property should be set before you apply a skin and should not be changed once it has been set.

The default value is ScrollBar.VERTICAL.

pageScrollSizeproperty 
pageScrollSize:Number  [read-write]

Gets or sets how much to scroll when the scroll bar track is pressed.

Implementation
    public function get pageScrollSize():Number
    public function set pageScrollSize(value:Number):void
pageSizeproperty 
pageSize:Number  [read-write]

Gets or sets the page size.

Implementation
    public function get pageSize():Number
    public function set pageSize(value:Number):void
rightproperty 
right:BaseButton  [read-only]

>> Reference to the right / up button.

Implementation
    public function get right():BaseButton
scrollPositionproperty 
scrollPosition:Number  [read-write]

Gets or sets the current scroll position.

Implementation
    public function get scrollPosition():Number
    public function set scrollPosition(value:Number):void
thicknessproperty 
thickness:int  [read-only]

Gets the thickness of the scrollbar.

Implementation
    public function get thickness():int
trackproperty 
track:Image  [read-only]

>> Reference to the track.

Implementation
    public function get track():Image
upproperty 
up:BaseButton  [read-only]

>> Reference to the right / up button.

Implementation
    public function get up():BaseButton
Constructor detail
ScrollBar()constructor
public function ScrollBar()
Method detail
setScrollProperties()method
public function setScrollProperties(pageSize:Number, minScrollPosition:Number, maxScrollPosition:Number, pageScrollSize:Number = 0):void

Sets multiple scroll properties at once.

Parameters
pageSize:Number
 
minScrollPosition:Number
 
maxScrollPosition:Number
 
pageScrollSize:Number (default = 0)
Event detail
scrollevent 
Event object type: flash.events.Event

Constant detail
HORIZONTALconstant
public static const HORIZONTAL:int = 1
VERTICALconstant 
public static const VERTICAL:int = 0