Package | km.components |
Class | public class ScrollBar |
Inheritance | ScrollBar ![]() ![]() |
Property | Defined 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 | ||
![]() | duotone : Array The duotone property can be used to convert the colors of the component into duotone.
| UIComponent | |
![]() | enabled : 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 | ||
![]() | height : 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 | ||
![]() | toolTip : 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 | ||
![]() | width : Number | UIComponent | |
![]() | x : Number | UIComponent | |
![]() | y : Number | UIComponent |
Method | Defined by | ||
---|---|---|---|
ScrollBar | |||
![]() |
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 | |
![]() |
move(x:int, y:int, animationMode:int = 0, animationFrames:int = 12, easeInOut:Boolean = false):void
Moves the component to the specified coordinates.
| UIComponent | |
![]() |
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 | ||
![]() |
setSize(w:int, h:int):void
Sets the size width and height.
| UIComponent |
Event | Summary | Defined by | ||
---|---|---|---|---|
![]() | The animationComplete event is broadcasted when an animated move is completed. | UIComponent | ||
ScrollBar |
Constant | Defined by | ||
---|---|---|---|
HORIZONTAL : int = 1 [static]
| ScrollBar | ||
VERTICAL : int = 0 [static]
| ScrollBar |
autoDisable | property |
public var autoDisable:Boolean
Disable the scrollbar when there's nothing to scroll.
The default value is false
.
bar | property |
bar:BaseButton
[read-only]>> Reference to the bar.
Implementation public function get bar():BaseButton
down | property |
down:BaseButton
[read-only]>> Reference to the left / down button.
Implementation public function get down():BaseButton
dragging | property |
public var dragging:Boolean
groupButtons | property |
public var groupButtons:Boolean
Group the up/down and left/right buttons.
The default value is false
.
left | property |
left:BaseButton
[read-only]>> Reference to the left / down button.
Implementation public function get left():BaseButton
lineScrollSize | property |
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
maxScrollPosition | property |
maxScrollPosition:Number
[read-write]Gets or sets the maximum scroll position.
Implementation public function get maxScrollPosition():Number
public function set maxScrollPosition(value:Number):void
minScrollPosition | property |
minScrollPosition:Number
[read-write]Gets or sets the minimum scroll position.
Implementation public function get minScrollPosition():Number
public function set minScrollPosition(value:Number):void
onScroll | property |
public var onScroll:Function
onScroll handler.
orientation | property |
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
.
pageScrollSize | property |
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
pageSize | property |
pageSize:Number
[read-write]Gets or sets the page size.
Implementation public function get pageSize():Number
public function set pageSize(value:Number):void
right | property |
right:BaseButton
[read-only]>> Reference to the right / up button.
Implementation public function get right():BaseButton
scrollPosition | property |
scrollPosition:Number
[read-write]Gets or sets the current scroll position.
Implementation public function get scrollPosition():Number
public function set scrollPosition(value:Number):void
thickness | property |
thickness:int
[read-only]Gets the thickness of the scrollbar.
Implementation public function get thickness():int
track | property |
up | property |
up:BaseButton
[read-only]>> Reference to the right / up button.
Implementation public function get up():BaseButton
ScrollBar | () | constructor |
public function ScrollBar()
setScrollProperties | () | method |
public function setScrollProperties(pageSize:Number, minScrollPosition:Number, maxScrollPosition:Number, pageScrollSize:Number = 0):void
Sets multiple scroll properties at once.
ParameterspageSize:Number |
|
minScrollPosition:Number |
|
maxScrollPosition:Number |
|
pageScrollSize:Number (default = 0 )
|
scroll | event |
HORIZONTAL | constant |
public static const HORIZONTAL:int = 1
VERTICAL | constant |
public static const VERTICAL:int = 0