Package | mx.controls |
Class | public class Label |
Inheritance | Label UIComponent FlexSprite flash.display.Sprite |
Implements | IDataRenderer, IDropInListItemRenderer, IFontContextComponent, IListItemRenderer |
Subclasses | GalleryPagingLabel, GalleryPasswordLabel, PopupThumbCaption, PopupThumbTitle, SliderLabel, Text |
You can format Label text by using HTML tags, which are applied after the Label control's CSS styles are applied. You can also put padding around the four sides of the text. The text of a Label is nonselectable by default, but you can make it selectable.
If a Label is sized to be smaller than its text, you can control whether the text is simply clipped or whether it is truncated with a localizable string such as "...". (Note: Plain text can be truncated, but HTML text cannot.) If the entire text of the Label, either plain or HTML, is not completely visible, and you haven't assigned a tooltip to the Label, an automatic "truncation tip" displays the complete plain text when a user holds the mouse over the Label control.
Label controls do not have backgrounds or borders and cannot take focus.
The Label control has the following default sizing characteristics:
Characteristic | Description |
---|---|
Default size | Width and height large enough for the text |
Minimum size | 0 pixels |
Maximum size | 10000 by 10000 pixels |
The <mx:Label>
tag inherits all of the tag attributes
of its superclass, and adds the following tag attributes:
<mx:Label Properties condenseWhite="true|false" data="null" htmlText="" listData="null" selectable="true|false" text="" truncateToFit="true|false" Styles color="0x0B333C" disabledColor="0xAAB3B3" fontAntiAliasType="advanced|normal" fontFamily="Verdana" fontGridFitType="pixel|none|subpixel" fontSharpness="0" fontSize="10" fontStyle="normal|italic" fontThickness="0" fontWeight="normal|bold" paddingLeft="0" paddingRight="0" paddingTop="0" paddingBottom="0" textAlign="left|right|center" textDecoration="none|underline" textIndent="0" Events dataChange="No default" />
See also
Property | Defined by | ||
---|---|---|---|
activeEffects : Array
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | ||
automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | ||
automationName : String
Name that can be used as an identifier for this object.
| UIComponent | ||
automationTabularData : Object
An implementation of the
IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | ||
automationValue : Array
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application.
| UIComponent | ||
baselinePosition : Number
The y-coordinate of the baseline
of the first line of text of the component.
| UIComponent | ||
cacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
| UIComponent | ||
cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | ||
className : String
The name of this instance's class, such as
"Button" . | UIComponent | ||
condenseWhite : Boolean
Specifies whether extra white space (spaces, line breaks,
and so on) should be removed in a Label control with HTML text.
| Label | ||
contentMouseX : Number
Returns the x position of the mouse, in the content coordinate system.
| UIComponent | ||
contentMouseY : Number
Returns the y position of the mouse, in the content coordinate system.
| UIComponent | ||
currentLooperData : Object
When using this component as the child of a DataLooper element, this holds the current element's corresponding looping data.
| UIComponent | ||
currentState : String
The current view state of the component.
| UIComponent | ||
cursorManager : ICursorManager
Gets the CursorManager that controls the cursor for this component
and its peers.
| UIComponent | ||
data : Object
Lets you pass a value to the component
when you use it in an item renderer or item editor.
| Label | ||
descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the
createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | ||
document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | ||
doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives
doubleClick events. | UIComponent | ||
enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | ||
errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | ||
explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
flexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
| UIComponent | ||
focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | ||
fontContext : IFlexModuleFactory
The module factory that provides the font context for this component.
| Label | ||
globalX : Number | UIComponent | ||
globalY : Number | UIComponent | ||
height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | ||
htmlText : String
Specifies the text displayed by the Label control, including HTML markup that
expresses the styles of that text.
| Label | ||
id : String
ID of the component.
| UIComponent | ||
includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | ||
inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | ||
initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | ||
instanceIndex : int
The index of a repeated component.
| UIComponent | ||
instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | ||
isDocument : Boolean
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | ||
isPopUp : Boolean
Set to
true by the PopUpManager to indicate
that component has been popped up. | UIComponent | ||
listData : BaseListData
When a component is used as a drop-in item renderer or drop-in
item editor, Flex initializes the
listData property
of the component with the appropriate data from the List control. | Label | ||
maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | ||
measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | ||
measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | ||
measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | ||
minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | ||
miscHolder : Object
A utility holder for any various properties
| UIComponent | ||
moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | ||
move_enableProtection : Boolean = false | UIComponent | ||
nestLevel : int
Depth of this object in the containment hierarchy.
| UIComponent | ||
nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
| UIComponent | ||
numAutomationChildren : int
The number of automation children this container has.
| UIComponent | ||
owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | ||
parent : DisplayObjectContainer
The parent container or component for this component.
| UIComponent | ||
parentApplication : Object
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | ||
parentDocument : Object
A reference to the parent document object for this UIComponent.
| UIComponent | ||
percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | ||
percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | ||
processedDescriptors : Boolean
Set to
true after immediate or deferred child creation,
depending on which one happens. | UIComponent | ||
repeater : IRepeater
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | ||
repeaterIndex : int
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | ||
repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | ||
repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | ||
scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | ||
scaleY : Number
Number that specifies the vertical scaling factor.
| UIComponent | ||
screen : Rectangle
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | ||
selectable : Boolean
Specifies whether the text can be selected.
| Label | ||
setActualSize_enableProtection : Boolean = false | UIComponent | ||
setVisible_enableProtection : Boolean = true | UIComponent | ||
showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | ||
states : Array
The view states that are defined for this component.
| UIComponent | ||
styleClassOverridesInline : Boolean = true
Specifies if class-specific styles (as defined by the
styleName property) override inline styles. | UIComponent | ||
styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | ||
styleName : Object
The class style used by this component.
| UIComponent | ||
systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | ||
text : String
Specifies the plain text displayed by this control.
| Label | ||
textHeight : Number [read-only]
The height of the text.
| Label | ||
textWidth : Number [read-only]
The width of the text.
| Label | ||
toolTip : String
Text to display in the ToolTip.
| UIComponent | ||
transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs.
| UIComponent | ||
truncateToFit : Boolean = true
If this propery is
true , and the Label control size is
smaller than its text, the text of the
Label control is truncated using
a localizable string, such as "..." . | Label | ||
tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UIComponent | ||
uid : String
A unique identifier for the object.
| UIComponent | ||
updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required).
| UIComponent | ||
validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | ||
visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | ||
visible_unprotected : Boolean
If setVisible_enableProtection is enabled, this allows access to determine what the pseudo-state is -- that is, what's been requested, regardless of any prevention of default behavior.
| UIComponent | ||
width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | ||
x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | ||
xmlDescriptor : XML
For certain dynamically created elements, this represents the XML node used to create that element.
| UIComponent | ||
y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent |
Property | Defined by | ||
---|---|---|---|
textField : IUITextField
The internal UITextField that renders the text of this Label.
| Label | ||
unscaledHeight : Number
A convenience method for determining the unscaled height
of the component.
| UIComponent | ||
unscaledWidth : Number
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to
updateDisplayList() . | UIComponent |
Method | Defined by | ||
---|---|---|---|
Label()
Constructor.
| Label | ||
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
| UIComponent | ||
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
| UIComponent | ||
contentToGlobal(point:Point):Point
Converts a
Point object from content coordinates to global coordinates. | UIComponent | ||
contentToLocal(point:Point):Point
Converts a
Point object from content to local coordinates. | UIComponent | ||
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container.
| UIComponent | ||
createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an
id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the
id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
| UIComponent | ||
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
| UIComponent | ||
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
| UIComponent | ||
drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
| UIComponent | ||
effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component.
| UIComponent | ||
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
| UIComponent | ||
endEffectsStarted():void
Ends all currently playing effects on the component.
| UIComponent | ||
executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object.
| UIComponent | ||
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
| UIComponent | ||
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index.
| UIComponent | ||
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance.
| UIComponent | ||
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component.
| UIComponent | ||
getDescendantByName(name:String):DisplayObject
Searches all children for the first child named with the passed value; returns that child, or null if not found.
| UIComponent | ||
getDescendantsByName(name:String):Array
Searches all children for all children named with the passed value; returns an array with those children, or an empty array if none found.
| UIComponent | ||
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | ||
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | ||
getFocus():InteractiveObject
Gets the object that currently has focus.
| UIComponent | ||
getLineMetrics(lineIndex:int):TextLineMetrics
Returns a TextLineMetrics object with information about the text
position and measurements for a line of text in the control.
| Label | ||
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the
dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | ||
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain.
| UIComponent | ||
getVisibleRect(targetParent:DisplayObject = null):Rectangle
MOVED OVER FROM SDK 3.2 UIComponent - Allows for popped-up alerts to be displayed correctly - NGR MOVED 11-20-08
| UIComponent | ||
globalToContent(point:Point):Point
Converts a
Point object from global to content coordinates. | UIComponent | ||
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | ||
initialize():void
Initializes the internal structure of this component.
| UIComponent | ||
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component.
| UIComponent | ||
invalidateDisplayList():void
Marks a component so that its
updateDisplayList()
method gets called during a later screen update. | UIComponent | ||
invalidateProperties():void
Marks a component so that its
commitProperties()
method gets called during a later screen update. | UIComponent | ||
invalidateSize():void
Marks a component so that its
measure()
method gets called during a later screen update. | UIComponent | ||
localToContent(point:Point):Point
Converts a
Point object from local to content coordinates. | UIComponent | ||
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which may contain HTML tags such
as
<font> and <b> ,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | ||
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
| UIComponent | ||
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
| UIComponent | ||
move_unprotected(x:Number, y:Number):void
Same as move, but cannot be prevented via the protection_move event.
| UIComponent | ||
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
| UIComponent | ||
owns(child:DisplayObject):Boolean
Returns
true if the chain of owner properties
points from child to this UIComponent. | UIComponent | ||
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
| UIComponent | ||
prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing.
| UIComponent | ||
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component
and, if the
recursive parameter is true ,
for all descendants of this component as well. | UIComponent | ||
registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners.
| UIComponent | ||
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
| UIComponent | ||
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
| UIComponent | ||
resumeBackgroundProcessing():void
[static]
Resumes the background processing of methods
queued by
callLater() , after a call to
suspendBackgroundProcessing() . | UIComponent | ||
setActualSize(w:Number, h:Number):void
Sizes the object.
| UIComponent | ||
setActualSize_unprotected(w:Number, h:Number):void
Same as setActualSize, but is not cancelable via the protection_size event.
| UIComponent | ||
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component.
| UIComponent | ||
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
| UIComponent | ||
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
| UIComponent | ||
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the
visible property changes. | UIComponent | ||
setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void
Same as setVisible, but cannot be prevented.
| UIComponent | ||
styleChanged(styleProp:String):void
Detects changes to style properties.
| UIComponent | ||
stylesInitialized():void
Flex calls the
stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | ||
suspendBackgroundProcessing():void
[static]
Blocks the background processing of methods
queued by
callLater() ,
until resumeBackgroundProcessing() is called. | UIComponent | ||
toString():String
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | ||
validateDisplayList():void
Validates the position and size of children and draws other
visuals.
| UIComponent | ||
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary.
| UIComponent | ||
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the
commitProperties() method. | UIComponent | ||
validateSize(recursive:Boolean = false):void
Validates the measured size of the component
If the
LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | ||
validationResultHandler(event:ValidationResultEvent):void
Handles both the
valid and invalid events from a
validator assigned to this component. | UIComponent | ||
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to
drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent |
Event | Summary | Defined by | ||
---|---|---|---|---|
Dispatched when the component is added to a container as a content child
by using the addChild() or addChildAt() method. | UIComponent | |||
Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | |||
Dispatched after the view state has changed. | UIComponent | |||
Dispatched after the currentState property changes,
but before the view state changes. | UIComponent | |||
Dispatched when the data property changes. | Label | |||
Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | |||
Dispatched by the drop target when the user releases the mouse over it. | UIComponent | |||
Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | |||
Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | |||
Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | |||
Dispatched by the drag initiator when starting a drag operation. | UIComponent | |||
Dispatched after an effect ends. | UIComponent | |||
Dispatched just before an effect starts. | UIComponent | |||
Dispatched after the component has returned to the root view state. | UIComponent | |||
Dispatched before the component exits from the root view state. | UIComponent | |||
Dispatched when an object's state changes from visible to invisible. | UIComponent | |||
Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | |||
Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | |||
Dispatched when a user clicks a hyperlink in an
HTML-enabled text field, where the URL begins with "event:" . | Label | |||
Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | |||
Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | |||
Dispatched when the object has moved. | UIComponent | |||
Dispatched at the beginning of the component initialization sequence. | UIComponent | |||
Dispatched when the component is about to be hidden (visible = false); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be moved via move(); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be shown (visible = true); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is about to be sized via setActualSize(); calling event.preventDefault() will stop the action from occuring. | UIComponent | |||
Dispatched when the component is removed from a container as a content child
by using the removeChild() or removeChildAt() method. | UIComponent | |||
Dispatched when the component is resized. | UIComponent | |||
Dispatched when an object's state changes from invisible to visible. | UIComponent | |||
Dispatched by the component when it is time to create a ToolTip. | UIComponent | |||
Dispatched by the component when its ToolTip has been hidden and will be discarded soon. | UIComponent | |||
Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | |||
Dispatched by the component when its ToolTip is about to be shown. | UIComponent | |||
Dispatched by the component when its ToolTip has been shown. | UIComponent | |||
Dispatched by a component whose toolTip property is set,
as soon as the user moves the mouse over it. | UIComponent | |||
Dispatched when an object has had its commitProperties() ,
measure() , and
updateDisplayList() methods called (if needed). | UIComponent | |||
Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | |||
Dispatched when values are changed programmatically or by user interaction. | UIComponent |
Style | Description | Defined by | ||
---|---|---|---|---|
Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | |||
Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area. | UIComponent | |||
Type: Number CSS Inheritance: no The color brightness of the component. | UIComponent | |||
color
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. The default value is 0x0B333C . | Label | ||
Type: Number CSS Inheritance: no The color contrast of the component. | UIComponent | |||
disabledColor
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. The default value is 0xAAB3B3 . | Label | ||
Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | |||
fontAntiAliasType
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields. The possible values are
"normal" (flash.text.AntiAliasType.NORMAL )
and "advanced" (flash.text.AntiAliasType.ADVANCED ).
The default value is This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you cannot apply it to some characters and not others. The default value is"advanced" . | Label | ||
fontFamily
| Type: String CSS Inheritance: yes Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is "Verdana" . | Label | ||
fontGridFitType
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls.
The possible values are "none" (flash.text.GridFitType.NONE ),
"pixel" (flash.text.GridFitType.PIXEL ),
and "subpixel" (flash.text.GridFitType.SUBPIXEL ).
This property only applies when you are using an embedded font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is"pixel" . | Label | ||
fontSharpness
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls.
This property specifies the sharpness of the glyph edges. The possible values are Numbers
from -400 through 400.
This property only applies when you are using an embedded font
and the This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is0 . | Label | ||
fontSize
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11. | Label | ||
fontStyle
| Type: String CSS Inheritance: yes Determines whether the text is italic font. Recognized values are "normal" and "italic" .
The default value is "normal" . | Label | ||
fontThickness
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls.
This property specifies the thickness of the glyph edges.
The possible values are Numbers from -200 to 200.
This property only applies when you are using an embedded font
and the This style has no effect on system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is0 . | Label | ||
fontWeight
| Type: String CSS Inheritance: yes Determines whether the text is boldface. Recognized values are normal and bold .
The default value for Button controls is bold .
The default value for all other controls is normal .
| Label | ||
Type: String CSS Inheritance: no The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | |||
Type: Number CSS Inheritance: no The color hue of the component. | UIComponent | |||
kerning
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true ) or disabled (false ).
Kerning adjusts the gap between certain character pairs
to improve readability, and should be used only when necessary,
such as with headings in large fonts.
Kerning is supported for embedded fonts only.
Certain fonts, such as Verdana, and monospaced fonts,
such as Courier New, do not support kerning.
The default value is false . | Label | ||
Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component. | UIComponent | |||
letterSpacing
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is 0 . | Label | ||
Type: Number CSS Inheritance: no The opacity of the component. | UIComponent | |||
paddingBottom
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the bottom of the Label and the bottom of the text. The default value is 0 . | Label | ||
paddingLeft
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the left of the Label and the left of the text. The default value is 0 . | Label | ||
paddingRight
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the right of the Label and the right of the text. The default value is 0 . | Label | ||
paddingTop
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the top of the Label and the top of the text. The default value is 0 . | Label | ||
Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area. | UIComponent | |||
Type: Number CSS Inheritance: no The color saturation of the component. | UIComponent | |||
textAlign
| Type: String CSS Inheritance: yes Alignment of text within a container. Possible values are "left" , "right" ,
or "center" .
The default value for most components is | Label | ||
textDecoration
| Type: String CSS Inheritance: yes Determines whether the text is underlined. Possible values are "none" and "underline" .
The default value is "none" . | Label | ||
textIndent
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. The default value is 0 . | Label | ||
Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component. | UIComponent | |||
Type: String CSS Inheritance: no The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent |
condenseWhite | property |
condenseWhite:Boolean
[read-write]Specifies whether extra white space (spaces, line breaks, and so on) should be removed in a Label control with HTML text.
The condenseWhite
property affects only text set with
the htmlText
property, not the text
property.
If you set text with the text
property,
condenseWhite
is ignored.
If you set the condenseWhite
property to true
,
you must use standard HTML commands, such as <br>
and <p>
, to place line breaks in the text field.
The default value is false;
.
This property can be used as the source for data binding.
Implementation public function get condenseWhite():Boolean
public function set condenseWhite(value:Boolean):void
data | property |
data:Object
[read-write]
Lets you pass a value to the component
when you use it in an item renderer or item editor.
You typically use data binding to bind a field of the data
property to a property of this component.
When you use the control as a drop-in item renderer or drop-in
item editor, Flex automatically writes the current value of the item
to the text
property of this control.
You do not set this property in MXML.
The default value is null
.
This property can be used as the source for data binding.
Implementation public function get data():Object
public function set data(value:Object):void
See also
fontContext | property |
fontContext:IFlexModuleFactory
[read-write]The module factory that provides the font context for this component.
Implementation public function get fontContext():IFlexModuleFactory
public function set fontContext(value:IFlexModuleFactory):void
htmlText | property |
htmlText:String
[read-write]Specifies the text displayed by the Label control, including HTML markup that expresses the styles of that text. When you specify HTML text in this property, you can use the subset of HTML tags that is supported by the Flash TextField control.
When you set this property, the HTML markup is applied after the CSS styles for the Label instance are applied. When you get this property, the HTML markup includes the CSS styles.
For example, if you set this to be a string such as,
"This is an example of <b>bold</b> markup"
,
the text "This is an example of bold markup" appears
in the Label with whatever CSS styles normally apply.
Also, the word "bold" appears in boldface font because of the
<b>
markup.
HTML markup uses characters such as < and >, which have special meaning in XML (and therefore in MXML). So, code such as the following does not compile:
<mx:Label htmlText="This is an example of <b>bold</b> markup"/>
There are three ways around this problem.
Set the htmlText
property in an ActionScript method called as
an initialize
handler:
<mx:Label id="myLabel" initialize="myLabel_initialize()"/>
where the myLabel_initialize
method is in a script CDATA section:
<mx:Script> <![CDATA[ private function myLabel_initialize():void { myLabel.htmlText = "This is an example of <b>bold</b> markup"; } ]]> </mx:Script>
This is the simplest approach because the HTML markup
remains easily readable.
Notice that you must assign an id
to the label
so you can refer to it in the initialize
handler.
Specify the htmlText
property by using a child tag
with a CDATA section. A CDATA section in XML contains character data
where characters like < and > aren't given a special meaning.
<mx:Label> <mx:htmlText><![CDATA[This is an example of <b>bold</b> markup]]></mx:htmlText> <mx:Label/>
You must write the htmlText
property as a child tag
rather than as an attribute on the <mx:Label>
tag
because XML doesn't allow CDATA for the value of an attribute.
Notice that the markup is readable, but the CDATA section makes
this approach more complicated.
Use an hmtlText
attribute where any occurences
of the HTML markup characters < and > in the attribute value
are written instead as the XML "entities" <
and >
:
<mx:Label htmlText="This is an example of <b>bold</b> markup"/>Adobe does not recommend this approach because the HTML markup becomes nearly impossible to read.
If the condenseWhite
property is true
when you set the htmlText
property, multiple
white-space characters are condensed, as in HTML-based browsers;
for example, three consecutive spaces are displayed
as a single space.
The default value for condenseWhite
is
false
, so you must set condenseWhite
to true
to collapse the white space.
If you read back the htmlText
property quickly
after setting it, you get the same string that you set.
However, after the LayoutManager runs, the value changes
to include additional markup that includes the CSS styles.
Setting the htmlText
property affects the text
property in several ways.
If you read the text
property quickly after setting
the htmlText
property, you get null
,
which indicates that the text
corresponding to the new
htmlText
has not yet been determined.
However, after the LayoutManager runs, the text
property
value changes to the htmlText
string with all the
HTML markup removed; that is,
the value is the characters that the Label actually displays.
Conversely, if you set the text
property,
any previously set htmlText
is irrelevant.
If you read the htmlText
property quickly after setting
the text
property, you get null
,
which indicates that the htmlText
that corresponds to the new
text
has not yet been determined.
However, after the LayoutManager runs, the htmlText
property
value changes to the new text plus the HTML markup for the CSS styles.
To make the LayoutManager run immediately, you can call the
validateNow()
method on the Label.
For example, you could set some htmlText
,
call the validateNow()
method, and immediately
obtain the corresponding text
that doesn't have
the HTML markup.
If you set both text
and htmlText
properties
in ActionScript, whichever is set last takes effect.
Do not set both in MXML, because MXML does not guarantee that
the properties of an instance get set in any particular order.
Setting either text
or htmlText
property
inside a loop is a fast operation, because the underlying TextField
that actually renders the text is not updated until
the LayoutManager runs.
If you try to set this property to null
,
it is set, instead, to the empty string.
If the property temporarily has the value null
,
it indicates that the text
has been recently set
and the corresponding htmlText
has not yet been determined.
The default value is ""
.
This property can be used as the source for data binding.
Implementation public function get htmlText():String
public function set htmlText(value:String):void
See also
listData | property |
listData:BaseListData
[read-write]
When a component is used as a drop-in item renderer or drop-in
item editor, Flex initializes the listData
property
of the component with the appropriate data from the List control.
The component can then use the listData
property
to initialize the data
property of the drop-in
item renderer or drop-in item editor.
You do not set this property in MXML or ActionScript; Flex sets it when the component is used as a drop-in item renderer or drop-in item editor.
The default value is null
.
This property can be used as the source for data binding.
Implementation public function get listData():BaseListData
public function set listData(value:BaseListData):void
See also
selectable | property |
selectable:Boolean
[read-write]Specifies whether the text can be selected. Making the text selectable lets you copy text from the control.
When a link
event is specified in the Label control, the selectable
property must be set
to true
to execute the link
event.
The default value is false;
.
public function get selectable():Boolean
public function set selectable(value:Boolean):void
text | property |
text:String
[read-write]Specifies the plain text displayed by this control. Its appearance is determined by the CSS styles of this Label control.
When you set this property, any characters that might look like HTML markup in the string have no special meaning and appear as entered.
To display text formatted by using HTML tags,
use the htmlText
property instead.
If you set the htmlText
property,
the HTML replaces any text that you set using this property, and the
text
property returns a plain-text version of the
HTML text, with all HTML tags stripped out.
To include the special characters left angle bracket (<),
right angle bracket (>), or ampersand (&) in the text,
wrap the text string in the CDATA tag.
Alternatively, you can use HTML character entities for the
special characters, for example, <
.
If the text is wider than the Label control,
the text is truncated and terminated by an ellipsis (...).
The full text displays as a tooltip when
you move the mouse over the Label control.
If you also set a tooltip by using the tooltip
property, the tooltip is displayed rather than the text.
If you try to set this property to null
,
it is set, instead, to the empty string.
The text
property can temporarily have the value null
,
which indicates that the htmlText
has been recently set
and the corresponding text
value
has not yet been determined.
The default value is ""
.
This property can be used as the source for data binding.
Implementation public function get text():String
public function set text(value:String):void
textField | property |
protected var textField:IUITextField
The internal UITextField that renders the text of this Label.
textHeight | property |
textHeight:Number
[read-only]The height of the text.
The value of the textHeight
property is correct only
after the component has been validated.
If you set text
and then immediately ask for the
textHeight
, you might receive an incorrect value.
You should wait for the component to validate
or call the validateNow()
method before you get the value.
This behavior differs from that of the flash.text.TextField control,
which updates the value immediately.
public function get textHeight():Number
See also
textWidth | property |
textWidth:Number
[read-only]The width of the text.
The value of the textWidth
property is correct only
after the component has been validated.
If you set text
and then immediately ask for the
textWidth
, you might receive an incorrect value.
You should wait for the component to validate
or call the validateNow()
method before you get the value.
This behavior differs from that of the flash.text.TextField control,
which updates the value immediately.
public function get textWidth():Number
See also
truncateToFit | property |
public var truncateToFit:Boolean = true
If this propery is true
, and the Label control size is
smaller than its text, the text of the
Label control is truncated using
a localizable string, such as "..."
.
If this property is false
, text that does not fit is clipped.
The default value is true
.
Label | () | constructor |
public function Label()
Constructor.
getLineMetrics | () | method |
public function getLineMetrics(lineIndex:int):TextLineMetrics
Returns a TextLineMetrics object with information about the text
position and measurements for a line of text in the control.
The component must be validated to get a correct number.
If you set text
and then immediately call
getLineMetrics()
you may receive an incorrect value.
You should either wait for the component to validate
or call validateNow()
.
This is behavior differs from that of the flash.text.TextField class,
which updates the value immediately.
lineIndex:int — The zero-based index of the line for which to get the metrics.
For the Label control, which has only a single line, must be 0.
|
TextLineMetrics — The TextLineMetrics object that contains information about the text.
|
See also
dataChange | event |
mx.events.FlexEvent
mx.events.FlexEvent.DATA_CHANGE
Dispatched when the data
property changes.
When you use a component as an item renderer,
the data
property contains the data to display.
You can listen for this event and update the component
when the data
property changes.
The FlexEvent.DATA_CHANGE
constant defines the value of the
type
property of the event object for a dataChange
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
link | event |
flash.events.TextEvent
Dispatched when a user clicks a hyperlink in an
HTML-enabled text field, where the URL begins with "event:"
.
The remainder of the URL after
"event:"
is placed in the text property of the link
event object.
When you handle the link
event, the hyperlink is not automatically executed;
you need to execute the hyperlink from within your event handler.
You typically use the navigateToURL()
method to execute the hyperlink.
This allows you to modify the hyperlink, or even prohibit it from occurring,
in your application.
The Label control must have the selectable
property set
to true
to generate the link
event.