KoolMoves AS3 API Documentation | All Packages | All Classes | Index | Frames No Frames |
Class LabelScroll

Package | km.components
Class | public class LabelScroll
Inheritance | LabelScroll Label UIComponent flash.display.Sprite

The LabelScroll component class is an extended version of the Label class capable of scrolling the label text.

Example

    import km.components.*;

    var ls:LabelScroll = new LabelScroll();
    ls.text = 'This line of text will be scrolling from right to left.';
    ls.scrollInterval = 50;
    ls.background = true;
    ls.backgroundColor = 0xfff8f0;
    ls.move(20,20);

    addChild(ls);

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined by
--- | --- | ---
|  | antiAliasType : String | Label
|  | background : Boolean | Label
|  | backgroundColor : uint | Label
|  | defaultTextFormat : TextFormat | Label
|  | duotone : Array The duotone property can be used to convert the colors of the component into duotone. | UIComponent
|  | embedFonts : Boolean | Label
|  | enabled : Boolean Specifies if the component is enabled. If a component is disabled, it will be turned into grayscale and become partly transparent. | UIComponent
|  | gridFitType : String | Label
|  | height : Number | UIComponent
|  | htmlText : String | Label
|  | icon : BitmapData | Label
|  | labelPlacement : String Placement of the label text. Possible values are 'left' and 'right'. | Label
|  | length : int | Label
|  | scrollInterval : Number Gets or sets the scroll interval (msec). | LabelScroll
|  | scrollStep : Number Gets or sets the scroll step (pixels). | LabelScroll
|  | sharpness : Number | Label
|  | text : String | Label
|  | textColor : uint | Label
|  | thickness : Number | Label
|  | toolTip : String Text to use as toolTip when ToolTip is enabled. | UIComponent
|  | valign : String Vertical alignment within the bounding box. Possible values are 'top', 'bottom' and 'center'. | Label
|  | width : Number | UIComponent
|  | x : Number | UIComponent
|  | y : Number | UIComponent

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined by
--- | --- | ---
|  | LabelScroll() | LabelScroll
|  | 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
|  | setSize(w:int, h:int):void Sets the size width and height. | UIComponent

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined by
--- | --- | --- | ---
|  | animationComplete | The animationComplete event is broadcasted when an animated move is completed. | UIComponent

Property detail

scrollInterval | property

`scrollInterval:Number` [read-write]

Gets or sets the scroll interval (msec).

The default value is `100`.

Implementation
`public function get scrollInterval():Number`
`public function set scrollInterval(value:Number):void`

scrollStep | property |

`scrollStep:Number` [read-write]

Gets or sets the scroll step (pixels).

The default value is `1`.

Implementation
`public function get scrollStep():Number`
`public function set scrollStep(value:Number):void`
Constructor detail

LabelScroll | () | constructor

`public function LabelScroll()`

Last update : 04/05/2008