Package | com.ghostwire.ui.controls |
Class | public class uiLabel |
Inheritance | uiLabel ![]() ![]() |
uiLabel
component is used to display a uiImage
alongside a
uiText
.
~ This class is available in Aspire UI Components Lite Edition ~
See also
Property | Defined by | ||
---|---|---|---|
![]() | alignX : Number
Indicates how the component would like to be aligned horizontally within its allocated space.
| uiComponent | |
![]() | alignY : Number
Indicates how the component would like to be aligned vertically within its allocated space.
| uiComponent | |
![]() | background : Object
Indicates the style of the background for this component.
| uiComponent | |
![]() | container : uiComponent
Indicates the
uiComponent instance that contains this instance. | uiComponent | |
![]() | depth : int
Indicates how deep the component is in the containment hierarchy.
| uiComponent | |
![]() | desiredAllocationHeight : int
Indicates the vertical space this component would like to be allocated.
| uiComponent | |
![]() | desiredAllocationWidth : int
Indicates the horizontal space this component would like to be allocated.
| uiComponent | |
![]() | enabled : Boolean
Indicates whether the component is enabled for user interaction.
| uiComponent | |
![]() | fillX : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated
horizontal space.
| uiComponent | |
![]() | fillY : Boolean
Indicates whether or not the component should automatically expand or shrink to fill its allocated
vertical space.
| uiComponent | |
![]() | focusPadding : Object
Indicates the thickness of the interior space from the edge of the component to the focus
rectangle.
| uiComponent | |
![]() | focusRect : Object
Indicates the class to use when rendering the rectangle around the component to indicate that it
is in focus.
| uiComponent | |
![]() | height : Number
Indicates the current
height of the component. | uiComponent | |
image : String
Indicates the source of the
uiImage component instance used. | uiLabel | ||
![]() | margin : Object
Indicates the thickness of the space surrounding the component.
| uiComponent | |
![]() | maxHeight : int
Indicates the upper limit for
height . | uiComponent | |
![]() | maxWidth : int
Indicates the upper limit for
width . | uiComponent | |
![]() | minHeight : int
Indicates the lower limit for
height . | uiComponent | |
![]() | minWidth : int
Indicates the lower limit for
width . | uiComponent | |
![]() | padding : 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 | |
![]() | skin : String
Indicates the name of the skin to use for this component instance.
| uiComponent | |
![]() | stretch : 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 | ||
![]() | textStyle : String
Indicates the style to use for
uiText instances contained in this component. | uiComponent | |
![]() | toolTip : 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 | ||
![]() | uiskin : 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 | ||
![]() | visible : Boolean
Indicates whether or not the component is visible within its container.
| uiComponent | |
![]() | width : Number
Indicates the current
width of the component. | uiComponent |
Method | Defined by | ||
---|---|---|---|
uiLabel(text:String = null, image:String = null, textPosition:int = 0)
Constructor - creates a new
uiLabel instance. | uiLabel | ||
![]() |
invalidate(type:String):void
Invalidates this component's "size", "display", "layout" or "textstyle".
| uiComponent | |
![]() |
move(x:Number, y:Number, noEvent:Boolean = false):void
Moves the component to the specified position, disregarding its allocation.
| uiComponent | |
![]() |
removeAllChildren(all:Boolean = false):void
Removes all children from this component.
| uiComponent | |
![]() |
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 | |
![]() |
setSize(width:Number, height:Number, noEvent:Boolean = false):void
Sets this component's size to the specified
width and height . | uiComponent | |
![]() |
setVisible(value:Boolean, noEvent:Boolean = false):void
Sets the visibility of this component instance, dispatching a "show" or "hide" event accordingly.
| uiComponent | |
![]() |
validateNow():void
Validates and render the component instance, and any component instances with
depth higher than itself in the validation queue, immediately. | uiComponent |
image | property |
image:String
[read-write]
Indicates the source of the uiImage
component instance used. The property returns
null
if no image is being displayed.
public function get image():String
public function set image(value:String):void
See also
text | property |
text:String
[read-write]
Indicates the text string displayed by this uiLabel
component. The property returns
null
if no text is being displayed.
public function get text():String
public function set text(value:String):void
See also
textPosition | property |
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
.
public function get textPosition():int
public function set textPosition(value:int):void
See also
uiimage | property |
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).
public function get uiimage():uiImage
public function set uiimage(value:uiImage):void
uitext | property |
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.
public function get uitext():uiText
uiLabel | () | constructor |
public function uiLabel(text:String = null, image:String = null, textPosition:int = 0)
Constructor - creates a new uiLabel
instance.
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 .
|