Packagecom.ghostwire.ui.controls
Classpublic class uiLabel
InheritanceuiLabel Inheritance uiComponent Inheritance flash.display.Sprite

The uiLabel component is used to display a uiImage alongside a uiText.

~ This class is available in Aspire UI Components Lite Edition ~

See also

com.ghostwire.ui.controls.uiImage
com.ghostwire.ui.controls.uiText


Public Properties
 PropertyDefined by
 InheritedalignX : Number
Indicates how the component would like to be aligned horizontally within its allocated space.
uiComponent
 InheritedalignY : Number
Indicates how the component would like to be aligned vertically within its allocated space.
uiComponent
 Inheritedbackground : Object
Indicates the style of the background for this component.
uiComponent
 Inheritedcontainer : uiComponent
Indicates the uiComponent instance that contains this instance.
uiComponent
 Inheriteddepth : int
Indicates how deep the component is in the containment hierarchy.
uiComponent
 InheriteddesiredAllocationHeight : int
Indicates the vertical space this component would like to be allocated.
uiComponent
 InheriteddesiredAllocationWidth : int
Indicates the horizontal space this component would like to be allocated.
uiComponent
 Inheritedenabled : Boolean
Indicates whether the component is enabled for user interaction.
uiComponent
 InheritedfillX : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated horizontal space.
uiComponent
 InheritedfillY : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated vertical space.
uiComponent
 InheritedfocusPadding : Object
Indicates the thickness of the interior space from the edge of the component to the focus rectangle.
uiComponent
 InheritedfocusRect : Object
Indicates the class to use when rendering the rectangle around the component to indicate that it is in focus.
uiComponent
 Inheritedheight : Number
Indicates the current height of the component.
uiComponent
  image : String
Indicates the source of the uiImage component instance used.
uiLabel
 Inheritedmargin : Object
Indicates the thickness of the space surrounding the component.
uiComponent
 InheritedmaxHeight : int
Indicates the upper limit for height.
uiComponent
 InheritedmaxWidth : int
Indicates the upper limit for width.
uiComponent
 InheritedminHeight : int
Indicates the lower limit for height.
uiComponent
 InheritedminWidth : int
Indicates the lower limit for width.
uiComponent
 Inheritedpadding : Object
Indicates the thickness of the interior space from the edge of the component to the content area, which is where child components, if any, are contained.
uiComponent
 Inheritedskin : String
Indicates the name of the skin to use for this component instance.
uiComponent
 Inheritedstretch : Boolean
Indicates whether surplus space available in the parent container should be allocated to this component.
uiComponent
  text : String
Indicates the text string displayed by this uiLabel component.
uiLabel
  textPosition : int
Indicates the position of the uiText instance vis-a-vis the uiImage instance, if any.
uiLabel
 InheritedtextStyle : String
Indicates the style to use for uiText instances contained in this component.
uiComponent
 InheritedtoolTip : Object
Indicates the content (text) of the tooltip that should be shown when the mouse hovers over this control.
uiComponent
  uiimage : uiImage
Returns the embedded uiImage instance - for advanced users only.
uiLabel
 Inheriteduiskin : uiBitmapImage
Returns the uiBitmapImage rendered as the skin - for advanced users only.
uiComponent
  uitext : uiText
[read-only] Returns the embedded uiText instance - for advanced users only.
uiLabel
 Inheritedvisible : Boolean
Indicates whether or not the component is visible within its container.
uiComponent
 Inheritedwidth : Number
Indicates the current width of the component.
uiComponent
Public Methods
 MethodDefined by
  
uiLabel(text:String = null, image:String = null, textPosition:int = 0)
Constructor - creates a new uiLabel instance.
uiLabel
 Inherited
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
uiComponent
 Inherited
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
uiComponent
 Inherited
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
uiComponent
 Inherited
setFocus(flag:Boolean = true):void
Gives this component instance the focus; the component must be on the display list and has its tabEnabled property set to true, otherwise this method will fail silently.
uiComponent
 Inherited
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified width and height.
uiComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
uiComponent
 Inherited
validateNow():void
Validates and render the component instance, and any component instances with depth higher than itself in the validation queue, immediately.
uiComponent
Events
 EventSummaryDefined by
 Inherited Dispatched when the component's visible property is changed from true to false via calling the setVisible() method.uiComponent
 Inherited Dispatched when the component's position within its parent container has changed via calling the move() method.uiComponent
 Inherited Dispatched when the component's size has changed via calling the setSize() method.uiComponent
 Inherited Dispatched when the component's visible property is changed from false to true via calling the setVisible() method.uiComponent
Property detail
imageproperty
image:String  [read-write]

Indicates the source of the uiImage component instance used. The property returns null if no image is being displayed.

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

See also

textproperty 
text:String  [read-write]

Indicates the text string displayed by this uiLabel component. The property returns null if no text is being displayed.

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

See also

textPositionproperty 
textPosition:int  [read-write]

Indicates the position of the uiText instance vis-a-vis the uiImage instance, if any. Qualified values are POSITION.LEFT, POSITION.RIGHT, POSITION.TOP or POSITION.BOTTOM. By default, the uiText is placed to the right of the uiImage.

Implementation
    public function get textPosition():int
    public function set textPosition(value:int):void

See also

uiimageproperty 
uiimage:uiImage  [read-write]

Returns the embedded uiImage instance - for advanced users only. This property is exposed in case you would like greater control over the embedded uiImage instance.

The property returns null if no image is being displayed.

As of v1.2.0+, this property is read-write. You can use this property or the image property to specify the image to display within the label.

Note the difference between this property and the image property. This property indicates the uiImage instance, while the image property indicates the source (String value).

Implementation
    public function get uiimage():uiImage
    public function set uiimage(value:uiImage):void
uitextproperty 
uitext:uiText  [read-only]

Returns the embedded uiText instance - for advanced users only. This property is exposed in case you would like greater control over the embedded uiText instance.

The property returns null if no text is being displayed.

Implementation
    public function get uitext():uiText
Constructor detail
uiLabel()constructor
public function uiLabel(text:String = null, image:String = null, textPosition:int = 0)

Constructor - creates a new uiLabel instance.

Parameters
text:String (default = null) — A String value indicating the text to display.
 
image:String (default = null) — A String value indicating the source of the image to display.
 
textPosition:int (default = 0) — A String value indicating the position of the uiText instance vis-a-vis the uiImage instance, if any. Qualified values are POSITION.LEFT, POSITION.RIGHT, POSITION.TOP or POSITION.BOTTOM. By default, the uiText is placed to the right of the uiImage.