Package | com.ghostwire.ui.controls |
Class | public class uiLabelButton |
Inheritance | uiLabelButton ![]() ![]() ![]() |
Subclasses | uiCheckBox, uiPushButton |
uiLabelButton
is a button containing a uiLabel
instance allowing you to
display an image or text or both inside the button.
Note: use the uiPushButton
class when you want to create a uiLabelButton
that can be used as the default button in uiForm
containers.
"skin" Property
The default value is "LabelButton"
and the asset(s) used are:
LabelButton.png
~ This class is available in Aspire UI Components Lite Edition ~
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 | |
![]() | data : Object
Indicates the data to be associated with this button.
| uiButton | |
![]() | 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 | |
![]() | displaceX : int
Indicates the amount of pixels to move any embedded child object horizontally to the right when the
button is pressed down.
| uiButton | |
![]() | displaceY : int
Indicates the amount of pixels to move any embedded child object vertically downwards when the
button is pressed down.
| uiButton | |
![]() | 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 | |
![]() | group : uiButtonGroup
Indicates the
uiButtonGroup this button is assigned to. | uiButton | |
![]() | height : Number
Indicates the current
height of the component. | uiComponent | |
image : String
Indicates the source to the image displayed inside/beside the button.
| uiLabelButton | ||
![]() | 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 | |
![]() | selected : Boolean
Indicates whether the button is selected; applicable only if the
toggle property is
set to true . | uiButton | |
![]() | 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 displayed inside/beside the button.
| uiLabelButton | ||
textPosition : int
Indicates the position of the
uiText instance vis-a-vis the uiImage
instance, if any. | uiLabelButton | ||
![]() | textStyle : String
Indicates the style to use for
uiText instances contained in this component. | uiComponent | |
![]() | toggle : Boolean
Indicates whether the button should toggle its
selected property value between
true and false when it is clicked. | uiButton | |
![]() | toolTip : Object
Indicates the content (text) of the tooltip that should be shown when the mouse hovers
over this control.
| uiComponent | |
uilabel : uiLabel
[read-only]
Returns the embedded
uiLabel instance - for advanced users only. | uiLabelButton | ||
![]() | 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. | uiLabelButton | ||
![]() | 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 | ||
---|---|---|---|
uiLabelButton(text:String = null, image:String = null, textPosition:int = 0)
Constructor - creates a new
uiLabelButton instance. | uiLabelButton | ||
![]() |
activate(noEvent:Boolean = false):void
Activates and gives focus to the button as if the button has been clicked on (a
MouseEvent.CLICK event will be dispatched). | uiButton | |
![]() |
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 to the image displayed inside/beside the button. The property returns
null
if no image is displayed.
The default value is null
.
public function get image():String
public function set image(value:String):void
text | property |
text:String
[read-write]
Indicates the text displayed inside/beside the button. The property returns null
if no text is displayed.
The default value is null
.
public function get text():String
public function set text(value:String):void
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
uilabel | property |
uilabel:uiLabel
[read-only]
Returns the embedded uiLabel
instance - for advanced users only. This property
is exposed in case you would like greater control over the embedded uiLabel
instance.
public function get uilabel():uiLabel
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.
This method also helps the setMnemonicKey()
method of the uiForm
class locate the uiText
instance.
public function get uitext():uiText
See also
uiLabelButton | () | constructor |
public function uiLabelButton(text:String = null, image:String = null, textPosition:int = 0)
Constructor - creates a new uiLabelButton
instance.
text:String (default = null ) — A String value specifying the text to be displayed inside the button.
|
|
image:String (default = null ) — A String value indicating the source to the image/icon to be displayed inside the
button.
|
|
textPosition:int (default = 0 ) — A String value indicating the position of the text vis-a-vis
the image. Qualified values are POSITION.LEFT , POSITION.RIGHT ,
POSITION.TOP or POSITION.BOTTOM . By default, the text is positioned to
the right of the image.
|