Class ch.component.scrollbar.ScrollType

Description

Define the scroll types.

This class allows you to create your own scroll types. By default, two types are defined : VERTICAL and HORIZONTAL. Note that if you want to create your own scroll types, there must be a correlation between the two properties (_x/_width or _y/_height).

Field Index

HORIZONTAL, VERTICAL

Method Index

new ScrollType()
getScrollProperty(), getSizeProperty(), toString()

Constructor Detail

ScrollType

public function ScrollType(scrollProperty:String, sizeProperty:String)

Create a new ScrollType.

Parameters

scrollPropertyThe property to be moved by the scroller.
sizePropertyThe property representing the size.

Field Detail

VERTICAL

static public VERTICAL:ScrollType [Read Only]
Type vertical.

This type uses _y as scroll property and _height as size property.

HORIZONTAL

static public HORIZONTAL:ScrollType [Read Only]
Type horizontal.

This type uses _x as scroll property and _width as size property.

Method Detail

getScrollProperty

public function getScrollProperty(Void):String

Get the scroll property.

Return

The scroll property;

getSizeProperty

public function getSizeProperty(Void):String

Get the size property.

Return

The size property.

toString

public function toString(Void):String

Represent the current instance into a String.

Return

A String representing the ScrollType instance.