qnx.fuse.ui.text.Label

	Property	Defined By
		autoSize : String Gets or sets a String that indicates how a label is sized and aligned to fit the value of its text property.	Label
		embedFonts : Boolean Gets or sets the embedFonts property of the internal TextField of the label.	Label
		explicitHeight : Number [read-only]	UIComponent
		explicitWidth : Number [read-only]	UIComponent
		format : TextFormat Gets or sets the TextFormat object of the label.	Label
		htmlText : String Gets or sets the html text of the label	Label
		includeInLayout : Boolean Specifies if the component should be included in it's parent containers layout.	UIComponent
		layoutData : Object Returns the layout data for the object.	UIComponent
		minHeight : Number Sets the minimum preferred height of the control.	UIComponent
		minWidth : Number Sets the minimum preferred width of the control.	UIComponent
		multiline : Boolean Gets or sets a Boolean that determines whether or not the TextField supports multiline display.	Label
		preferredWrappingPoint : Number	Label
		removeGutters : Boolean	Label
		selectable : Boolean Gets or sets a Boolean that determines whether or not the text can be selected.	Label
		text : String Gets or sets the text of the label.	Label
		textField : TextField [read-only] Gets a reference to the internal textField of the label.	Label
		textHeight : Number [read-only] Returns the height of the label text (in pixels).	Label
		textWidth : Number [read-only] Returns the width of the label text (in pixels).	Label
		truncationMode : String Gets or sets the truncationMode of the label.	Label
		wordWrap : Boolean Gets or sets a Boolean that determines whether or not the label supports word wrapping.	Label

	Property	Defined By
		displayListIsInvalid : Boolean = false	UIComponent
		propertiesAreInvalid : Boolean = false	UIComponent
		sizeChange : Boolean	UIComponent
		stateChanged : Boolean	UIComponent

	Method	Defined By
		Label() Creates a new Label instance.	Label
		childChanged(resizedChild:DisplayObject = null):Boolean Notifies the UIComponent that one or more of its children has changed in a manner that may affect this object's layout.	UIComponent
		destroy():void Call this method when you want to have your object collected by the garbage collector.	UIComponent
		getLineMetrics(index:int):TextLineMetrics Temporary method to layout text correctly.	Label
		getSizeOptions():int [override]	Label
		invalidateDisplayList():void Calling this method results in a call to the components validateDisplayList() method before the display list is rendered.	UIComponent
		invalidateProperties():void Calling this method results in a call to the components validateProperties() method before the display list is rendered.	UIComponent
		measure(availableWidth:Number, availableHeight:Number):LayoutMeasurement	UIComponent
		setActualSize(w:Number, h:Number):void Sets the width and height of the object without setting the explicitWidth and explicitHeight.	UIComponent
		setLayoutBounds(bounds:Rectangle):void Sets the receiver's size and location to the rectangular area specified by the arguments.	UIComponent
		setPosition(x:Number, y:Number):void Sets the x and y position of the component.	UIComponent
		validateDisplayList():void Validates the display list of the component by calling the updateDisplayList().	UIComponent
		validateNow():void Validates the component immediately by calling validateProperties(), validateSizes(), and validateDisplayList() if necessary.	UIComponent
		validateProperties():void Validates the properties of the component by calling the commitProperties() method.	UIComponent

	Method	Defined By
		commitProperties():void Process properties of the component.	UIComponent
		commitState():void Process the state of the component.	UIComponent
		doMeasure(availableWidth:Number, availableHeight:Number):LayoutMeasurement [override]	Label
		flushCache():void [override]	Label
		onAdded():void Called when the instance is added to the stage.	UIComponent
		onRemoved():void Called when the instance is removed from the stage.	UIComponent
		parentLayoutChanged():void Invalidates the parent's size and display list if includeInLayout property is set to true.	UIComponent
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override]	Label

Property Detail

autoSize

property

autoSize:String

Gets or sets a String that indicates how a label is sized and aligned to fit the value of its text property.

The following are valid values:

TextFieldAutoSize.NONE: The label is not resized or aligned to fit the text.
TextFieldAutoSize.LEFT: The right and bottom sides of the label are resized to fit the text. The left and top sides are not resized.
TextFieldAutoSize.CENTER: The left and right sides of the label resize to fit the text. The horizontal center of the label stays anchored at its original horizontal center position.
TextFieldAutoSize.RIGHT: The left and bottom sides of the label are resized to fit the text. The top and right sides are not resized.

The default value is The default value is TextFieldAutoSize.NONE.

Implementation
public function get autoSize():String
public function set autoSize(value:String):void

embedFonts

property

embedFonts:Boolean

Gets or sets the embedFonts property of the internal TextField of the label. When set to false, fonts are rendered as device fonts. When set to true, you must specify a font using the font property of a TextFormat object and set it to the format property. This font must be included in the in your application. If it is not included, the text will not be rendererd.

The default value is false.

Implementation
public function get embedFonts():Boolean
public function set embedFonts(value:Boolean):void

format

property

format:TextFormat

Gets or sets the TextFormat object of the label.

The TextFormat object is used to format and style the text of the label. The label has the following default text format:

format.size = 16;
format.font = "BBAlpha Sans";
format.color = 0xFFFFFF;

The following listing creates a TextFormat object and applies it to a Label instance:

        var labelFormat:TextFormat = new TextFormat();
        labelFormat.size = 22;
        
        firstLabel = new Label();
        firstLabel.format = labelFormat;
        firstLabel.text = "First label";

Implementation
public function get format():TextFormat
public function set format(value:TextFormat):void

htmlText

property

htmlText:String

Gets or sets the html text of the label

Implementation
public function get htmlText():String
public function set htmlText(value:String):void

multiline

property

multiline:Boolean

Gets or sets a Boolean that determines whether or not the TextField supports multiline display.

Implementation
public function get multiline():Boolean
public function set multiline(value:Boolean):void

preferredWrappingPoint

property

preferredWrappingPoint:Number

Implementation
public function get preferredWrappingPoint():Number
public function set preferredWrappingPoint(value:Number):void

removeGutters

property

removeGutters:Boolean

Implementation
public function get removeGutters():Boolean
public function set removeGutters(value:Boolean):void

selectable

property

selectable:Boolean

Gets or sets a Boolean that determines whether or not the text can be selected.

Implementation
public function get selectable():Boolean
public function set selectable(value:Boolean):void

text

property

text:String

Gets or sets the text of the label.

Implementation
public function get text():String
public function set text(value:String):void

textField

property

textField:TextField [read-only]

Gets a reference to the internal textField of the label.

This is a helper method in order to gain more access to the internal textField of the label. However, it is strongly recommended that you limit the use of this method to set or get values of the textField. Instead you should use the public methods of the Label class itself. As an example you should always use Label.textWidth and Label.textHeight instead of accessing these properties on the textField property, as the textField.textWidth value could change if the text has been truncated.

Implementation
public function get textField():TextField

textHeight

property

textHeight:Number [read-only]

Returns the height of the label text (in pixels).

Implementation
public function get textHeight():Number

textWidth

property

textWidth:Number [read-only]

Returns the width of the label text (in pixels).

Implementation
public function get textWidth():Number

truncationMode

property

truncationMode:String

Gets or sets the truncationMode of the label.

Valid values can be found in the TextTruncationMode class.

Truncating text will only occur when setting the text property of the label. Truncation will not occur on the htmlText property.

The default value is TextTruncationMode.TRUNCATE_TAIL.

Implementation
public function get truncationMode():String
public function set truncationMode(value:String):void

See also

com.ui.text.TextTruncationMode

wordWrap

property

wordWrap:Boolean

Gets or sets a Boolean that determines whether or not the label supports word wrapping.

Implementation
public function get wordWrap():Boolean
public function set wordWrap(value:Boolean):void

Constructor Detail

Label

()

Constructor

public function Label()

Creates a new Label instance.

Method Detail

doMeasure

()

method

override protected function doMeasure(availableWidth:Number, availableHeight:Number):LayoutMeasurement

Parameters

	`availableWidth:Number`

	`availableHeight:Number`

Returns

LayoutMeasurement

flushCache

()

method

override protected function flushCache():void

getLineMetrics

()

method

public function getLineMetrics(index:int):TextLineMetrics

Temporary method to layout text correctly. This will change once we go to FTE.

Parameters

index:int

Returns

TextLineMetrics

getSizeOptions

()

method

override public function getSizeOptions():int

Returns

int

updateDisplayList

()

method

override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

Parameters

	`unscaledWidth:Number`

	`unscaledHeight:Number`

BlackBerry® Tablet OS SDK for Adobe® AIR® API Reference v 2.0 Beta	All Packages \| All Classes \| Index \| Frames No Frames
Label	Properties \| Methods

Package	qnx.fuse.ui.text
Class	public class Label
Inheritance	Label UIComponent flash.display.MovieClip
Implements	ILayoutElement