Packagecom.ghostwire.ui.controls
Classpublic class uiText
InheritanceuiText Inheritance uiComponent Inheritance flash.display.Sprite
SubclassesuiTextInput

The uiText component is used to display single or multiline noneditable text.

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



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
  defaultEmbedFonts : Boolean
[static] Deprecated.
uiText
 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
  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
 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
  html : Boolean
Indicates whether the text is HTML enabled.
uiText
 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
  selectable : Boolean
Indicates whether the text is selectable.
uiText
 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 current text displayed by the component.
uiText
  textField : TextField
[read-only] Indicates the native Flash Player TextField object embedded in this uiText instance.
uiText
 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
 Inheriteduiskin : uiBitmapImage
Returns the uiBitmapImage rendered as the skin - for advanced users only.
uiComponent
 Inheritedvisible : Boolean
Indicates whether or not the component is visible within its container.
uiComponent
 Inheritedwidth : Number
Indicates the current width of the component.
uiComponent
  wrap : Boolean
Indicates whether the text should wrap.
uiText
Public Methods
 MethodDefined by
  
uiText(txt:String = "")
Constructor - creates a new uiText instance.
uiText
 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
defaultEmbedFontsproperty
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.

ellipsisproperty 
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

ellipsizeproperty 
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.

Implementation
    public function get ellipsize():Boolean
    public function set ellipsize(value:Boolean):void

See also

embedFontsproperty 
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).

Implementation
    public function get embedFonts():Boolean
    public function set embedFonts(value:Boolean):void
htmlproperty 
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.

selectableproperty 
selectable:Boolean  [read-write]

Indicates whether the text is selectable.

The default value is false.

Implementation
    public function get selectable():Boolean
    public function set selectable(value:Boolean):void
textproperty 
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
textFieldproperty 
textField:TextField  [read-only]

Indicates the native Flash Player TextField object embedded in this uiText instance.

Implementation
    public function get textField():TextField
wrapproperty 
wrap:Boolean  [read-write]

Indicates whether the text should wrap.

The default value is false.

Implementation
    public function get wrap():Boolean
    public function set wrap(value:Boolean):void
Constructor detail
uiText()constructor
public function uiText(txt:String = "")

Constructor - creates a new uiText instance.

Parameters
txt:String (default = "") — Indicates the text string to display.