Packagecom.ghostwire.ui.controls
Classpublic class uiLink
InheritanceuiLink Inheritance uiButton Inheritance uiComponent Inheritance flash.display.Sprite

The uiLink is a button containing a uiText instance allowing you to display a text inside the button. You can associate the instance with a URL allowing it to behave like a HTML anchor link.

"useHandCursor" Property
The useHandCursor property is set to true by default, which means that a native hand cursor will show when the mouse is over the instance. Set this property to false if this is not desired.

"skin" Property
The default value is Link, and the asset(s) used are:

 Link.png
 

~ 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
 Inheriteddata : Object
Indicates the data to be associated with this button.
uiButton
 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
 InheriteddisplaceX : int
Indicates the amount of pixels to move any embedded child object horizontally to the right when the button is pressed down.
uiButton
 InheriteddisplaceY : int
Indicates the amount of pixels to move any embedded child object vertically downwards when the button is pressed down.
uiButton
 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
 Inheritedgroup : uiButtonGroup
Indicates the uiButtonGroup this button is assigned to.
uiButton
 Inheritedheight : Number
Indicates the current height of the component.
uiComponent
 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
 Inheritedselected : Boolean
Indicates whether the button is selected; applicable only if the toggle property is set to true.
uiButton
 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
  target : String
Indicates the name of the target window where the URL should be loaded.
uiLink
  text : String
Indicates the text displayed inside/beside the button.
uiLink
 InheritedtextStyle : String
Indicates the style to use for uiText instances contained in this component.
uiComponent
 Inheritedtoggle : Boolean
Indicates whether the button should toggle its selected property value between true and false when it is clicked.
uiButton
 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
  uitext : uiText
[read-only] Returns the embedded uiText instance - for advanced users only.
uiLink
  url : String
Indicates the URL to associate with this uiLink instance.
uiLink
 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
  
uiLink(text:String = null, url:String = null, target:String = null)
Constructor - creates a new uiLink instance.
uiLink
 Inherited
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
 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 selected property changes.uiButton
 Inherited Dispatched when the button is activated, either by user clicking on it or pressing the SPACE key while the button is in focus.uiButton
 Inherited Dispatched when the component's visible property is changed from true to false via calling the setVisible() method.uiComponent
   Dispatched when the instance is activated/clicked and the value of its url property is a String value with the "event:" prefix.uiLink
 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
targetproperty
target:String  [read-write]

Indicates the name of the target window where the URL should be loaded. Options include _self, _blank, _parent, and _top. The _self option specifies the current frame in the current window, _blank specifies a new window, _parent specifies the parent of the current frame, and _top specifies the top-level frame in the current window.

This property has no meaning when using the "event:" scheme for the url property.

The default value is null.

Implementation
    public function get target():String
    public function set target(value:String):void
textproperty 
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.

Implementation
    public function get text():String
    public function set text(value:String):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.

Implementation
    public function get uitext():uiText
urlproperty 
url:String  [read-write]

Indicates the URL to associate with this uiLink instance. The URL can be either absolute or relative to the location of the SWF file that is loading the page. An example of an absolute reference to a URL is http://www.ghostwire.com; an example of a relative reference is /index.html. Absolute URLs must be prefixed with http://; otherwise, Flash treats them as relative URLs. If this url is prefixed with "event:", the instance will dispatch a TextEvent.LINK event instead of opening a URL. For example, if you set the url to "event:myText", when the user clicks the uiLink instance, it will dispatch a TextEvent.LINK event with its text property set to "myText". You must listen to this TextEvent.LINK event and handle the event to make the instance useful.

The default value is null.

Implementation
    public function get url():String
    public function set url(value:String):void
Constructor detail
uiLink()constructor
public function uiLink(text:String = null, url:String = null, target:String = null)

Constructor - creates a new uiLink instance.

Parameters
text:String (default = null) — A String value specifying the text to be displayed inside the button.
 
url:String (default = null) — A String value specifying the URL to associate with the instance. The URL can be either absolute or relative to the location of the SWF file that is loading the page. An example of an absolute reference to a URL is http://www.ghostwire.com; an example of a relative reference is /index.html. Absolute URLs must be prefixed with http://; otherwise, Flash treats them as relative URLs. If this url is prefixed with "event:", the instance will dispatch a TextEvent.LINK event instead of opening a URL. For example, if you set the url to "event:myText", when the user clicks the uiLink instance, it will dispatch a TextEvent.LINK event with its text property set to "myText". You must listen to this TextEvent.LINK event and handle the event to make the uiLink instance useful.
 
target:String (default = null) — A String value specifying the name of the target window where the URL should be loaded. Options include _self, _blank, _parent, and _top. The _self option specifies the current frame in the current window, _blank specifies a new window, _parent specifies the parent of the current frame, and _top specifies the top-level frame in the current window.
Event detail
linkevent 
Event object type: flash.events.TextEvent

Dispatched when the instance is activated/clicked and the value of its url property is a String value with the "event:" prefix. The TextEvent object dispatched will have its text property set to the value that comes after the prefix. For example, if you set the url to "event:myText", when the user clicks the uiLink instance, it will dispatch a TextEvent.LINK event with its text property set to "myText". You must listen to this TextEvent.LINK event and handle the event to make the uiLink instance useful.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe uiLink instance dispatching the event.
textThe remainder of the URL after "event:"