Main Page | Packages | Class Tree | Index | Help
Previous | NextFrames | No Frames
Summary: Field | Property | Contructor | MethodDetail: Field | Property | Contructor | Method
com.bjc.controls

class Label

MovieClip
  |
  +--com.bjc.core.BJCComponent
        |
        +--com.bjc.core.LabelWrapper
              |
              +--com.bjc.controls.Label

class Label
extends LabelWrapper

A general purpose label component for displaying a small amount of text.


Author:
Flashloaded - www.flashloaded.com

Fields inherited from class com.bjc.core.BJCComponent

version

Property Summary

public
text: String (write)
Sets or returns the text displayed in the label. Note that this can include basic html tags if Label.html is set to true.

public
text: String (read)
Gets the text displayed in the label. Note that this can include basic html tags if Label.html is set to true.

public
textHeight: Number (read-only)
Read only value returning the actual height in pixels of the text being displayed in the label.

Properties inherited from class com.bjc.core.LabelWrapper

align, disabledColor, disableStyles, embedFont, fontColor, fontFace, fontSize, html

Properties inherited from class com.bjc.core.BJCComponent

disabledAlpha, enabled, focusTime, height, keyEnabled, style, width

Constructor

public
Label ( Void)


Method Summary

public static
create ( target: MovieClip, id: String, depth: Number, initObj: Object ): Label
Static method used to create an instance of a Label on stage at run time.

Methods inherited from class com.bjc.core.BJCComponent

draw, invalidate, move, remove, setSize


Property Documentation

text

public text: String (write)
Sets or returns the text displayed in the label. Note that this can include basic html tags if Label.html is set to true.

Example:
myLabel.text = "Volume";

text

public text: String (read)
Gets the text displayed in the label. Note that this can include basic html tags if Label.html is set to true.

Example:
myVar = myLabel.text;

textHeight

public textHeight: Number (read-only)
Read only value returning the actual height in pixels of the text being displayed in the label.

Example:
nextItem._y = myLabel._y + myLabel.textHeight + 10;

Constructor Documentation

Label

public function Label(Void)

Method Documentation

create

public static function create(target: MovieClip,
 id: String,
 depth: Number,
 initObj: Object): Label
Static method used to create an instance of a Label on stage at run time.

Parameters:
target
the movie clip to which the label will be attached.
id
the instance name given to the new label attached.
depth
the depth at which to attach the new label.
initObj
(optional) an object containing any properties you want to assign to the component when it is created
Returns:
a reference to the new label attached.

Example:
import com.bjc.controls.Label;
var newLabel:Label = Label.create(_root, "myLabel", 0);

The documentation was generated from the following file:

Copyright Flashloaded - www.flashloaded.com