Package | com.ghostwire.ui.controls |
Class | public class uiText |
Inheritance | uiText ![]() ![]() |
Subclasses | uiTextInput |
uiText
component is used to display single or multiline noneditable text.
~ 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 | |
defaultEmbedFonts : Boolean [static]
Deprecated.
| uiText | ||
![]() | 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 | |
ellipsis : String = "..." [static]
Indicates the string to use as an ellipsis if
ellipsize is set to true . | uiText | ||
ellipsize : Boolean
Indicates whether an ellipsis (...) should be shown if there is not enough space to show the
complete text.
| uiText | ||
embedFonts : Boolean
Indicates whether this
uiText object should use embedded fonts. | uiText | ||
![]() | 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 | |
html : Boolean
Indicates whether the text is HTML enabled.
| uiText | ||
![]() | 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 | |
selectable : Boolean
Indicates whether the text is selectable.
| uiText | ||
![]() | 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 current text displayed by the component.
| uiText | ||
textField : TextField [read-only]
Indicates the native Flash Player
TextField object embedded in this uiText
instance. | uiText | ||
![]() | 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 | |
![]() | uiskin : uiBitmapImage
Returns the
uiBitmapImage rendered as the skin - for advanced users only. | uiComponent | |
![]() | visible : Boolean
Indicates whether or not the component is visible within its container.
| uiComponent | |
![]() | width : Number
Indicates the current
width of the component. | uiComponent | |
wrap : Boolean
Indicates whether the text should wrap.
| uiText |
Method | Defined by | ||
---|---|---|---|
uiText(txt:String = "")
Constructor - creates a new
uiText instance. | uiText | ||
![]() |
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 |
defaultEmbedFonts | property |
public static var defaultEmbedFonts:Boolean
Deprecated. Ignored. No effect.
Previously you would use this class property to set embedFonts
property to
true
globally but this is no longer necessary.
As of Version 1.1, if you do not set the embedFonts
property explicitly, it is
assumed that the property should automatically assume a value of true
or
false
depending on whether the embedded version of the required font (used by the
uiText
instance) is available or not. Therefore, it is no longer necessary to set
a default value globally.
ellipsis | property |
public static var ellipsis:String = "..."
Indicates the string to use as an ellipsis if ellipsize
is set to true
.
You may want to set this to a single character Unicode Ellipsis symbol "…" instead of the three
character string "...".
The default value is "..."
.
See also
ellipsize | property |
ellipsize:Boolean
[read-write]
Indicates whether an ellipsis (...) should be shown if there is not enough space to show the
complete text. This property has no effect if html
is true
.
The default value is true
.
public function get ellipsize():Boolean
public function set ellipsize(value:Boolean):void
See also
embedFonts | property |
embedFonts:Boolean
[read-write]
Indicates whether this uiText
object should use embedded fonts. Note that setting
this property to true
does not actually embed the fonts, it merely tells
the component to use the embedded version of the font.
As of Version 1.1, if you do not set this property explicitly, it is assumed that the property
should automatically assume a value of true
or false
depending on
whether the embedded version of the font used by this uiText
instance is available
or not.
Note: If you set this property to true
but the required embedded font does not
exist, the property will return false
.
Effectively, you should not have to set this property explicitly unless you want to prevent
this uiText
instance from using an embedded font (set property to
false
).
public function get embedFonts():Boolean
public function set embedFonts(value:Boolean):void
html | property |
public var html:Boolean
Indicates whether the text is HTML enabled. If set to true
, and HTML tags will be
parsed. If set to false
(default), HTML tags are not parsed.
Changing this property takes effect the next time the component is rendered. Therefore, you are expected to set this property before the component is added to the display list.
The default value is false
.
selectable | property |
selectable:Boolean
[read-write]Indicates whether the text is selectable.
The default value is false
.
public function get selectable():Boolean
public function set selectable(value:Boolean):void
text | property |
text:String
[read-write]Indicates the current text displayed by the component.
Implementation public function get text():String
public function set text(value:String):void
textField | property |
textField:TextField
[read-only]
Indicates the native Flash Player TextField
object embedded in this uiText
instance.
public function get textField():TextField
wrap | property |
wrap:Boolean
[read-write]Indicates whether the text should wrap.
The default value is false
.
public function get wrap():Boolean
public function set wrap(value:Boolean):void
uiText | () | constructor |
public function uiText(txt:String = "")
Constructor - creates a new uiText
instance.
txt:String (default = " ") — Indicates the text string to display.
|