Packagecom.brightcove.api.components
Classpublic class Link
InheritanceLink Inheritance UIObject Inheritance Component Inheritance flash.events.EventDispatcher

The Link UI component in the player.



Public Properties
 PropertyDefined By
 Inheritedcomponent : Object
[read-only] Returns a reference to the wrapped API element in the player, which can be used to get access to new methods that might not be defined within this version of the SWC.
Component
Public Methods
 MethodDefined By
  
Link(element:Object)
Constructor.
Link
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void
[override] Adds a listener for an event.
UIObject
 Inherited
getAlpha():Number
Returns the alpha value of the component.
Component
  
getAutoSize():Boolean
Returns whether the button resizes based on its label and icon.
Link
 Inherited
getBlendMode():String
Returns the blend mode of the component.
UIObject
 Inherited
Returns the interface for the layout container of the element.
Component
 Inherited
getCSS():String
Returns the CSS used for this component instance.
UIObject
 Inherited
getDefinition():String
Returns the XML (BEML) definition of the component.
Component
 Inherited
getEnabled():Boolean
Returns whether component is enabled.
UIObject
  
getFont():String
Returns the name of the font used for the label.
Link
  
getHAlign():String
Gets the horizontal alignment for the textfield in the label.
Link
 Inherited
getHeight():Number
Returns the pixel height of the component.
Component
 Inherited
getID():String
Returns the ID of the component, as defined in the XML.
Component
 Inherited
Returns whether the component is included in layout calculations and rendering in parent layout box.
Component
 Inherited
getIndex():int
Returns the index of this element in its parent's elements array.
Component
  
getMultiline():Boolean
Returns whether the button label is set to be multiline.
Link
 Inherited
Returns the interface for the layout element that is the next sibling to this element in the parent containers's element array.
Component
 Inherited
getNodeName():String
Returns the node name of the element.
Component
 Inherited
Returns the interface for the layout element that is the previous sibling to this element in the parent containers's element array.
Component
 Inherited
getRotation():Number
Returns the rotation of the component.
UIObject
  
getText():String
Gets the text appearing for the link.
Link
  
getTextSize():Number
Returns the font point size used for the label.
Link
  
getTooltip():String
Returns the tooltip, if any, applied to the component.
Link
  
getURL():String
Gets the url for the link.
Link
  
getVAlign():String
Gets the vertical alignment for the textfield in the label.
Link
 Inherited
getVisible():Boolean
Returns whether the component is visible.
Component
 Inherited
getWidth():Number
Returns the pixel width of the component.
Component
 Inherited
getX(global:Boolean = false):Number
Returns the position of the component on the x axis.
Component
 Inherited
getY(global:Boolean = false):Number
Returns the position of the component on the y axis.
Component
 Inherited
move(x:Number, y:Number, global:Boolean = false):void
Sets the x,y coordinates of the component.
Component
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[override] Removes a listener for an event.
UIObject
 Inherited
setAlpha(alpha:Number):void
Sets the alpha value of the component.
Component
  
setAutoSize(autoSize:Boolean):void
Sets whether the button should resize based on its label and icon.
Link
 Inherited
setBlendMode(mode:String):void
Sets the blend mode of the component.
UIObject
 Inherited
setEnabled(enable:Boolean):void
Enables/disables component for events.
UIObject
  
setFont(font:String):void
Sets a font to be used instead of the style format's.
Link
  
setHAlign(align:String):void
Sets the horizontal alignment for the textfield in the label.
Link
 Inherited
setIncludeInLayout(includeInLayout:Boolean):void
Sets whether the component is included in layout calculations and rendering in parent layout box.
Component
  
setMultiline(multiline:Boolean):void
Sets whether the button label should display multiline.
Link
 Inherited
setRotation(rotation:Number):void
Sets the rotation of the component.
UIObject
 Inherited
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the wrapped component.
Component
 Inherited
setStyles(styles:String):void
Overrides specific styles for a component by accepting a semicolon-delimited list of style names and colors.
UIObject
  
setText(text:String):void
Sets the text appearing for the link.
Link
  
setTextSize(size:Number):void
Sets a font size to be used instead of the style format's.
Link
  
setTooltip(toolTip:String):void
Sets the tooltip for the component.
Link
  
setURL(url:String):void
Sets the url for the link.
Link
  
setVAlign(align:String):void
Sets the vertical alignment for the textfield in the label.
Link
 Inherited
setVisible(visible:Boolean):void
Sets whether the component is visible.
Component
Protected Methods
 MethodDefined By
 Inherited
redispatchEvent(event:Event):void
Sends the specified event, usually sent from a handler in order to bubble up non-bubbling events.
UIObject
Events
 Event Summary Defined By
 InheritedDispatched when a UI element in the player is clicked.Component
 InheritedDispatched when a UI element in the player is rolled off.Component
 InheritedDispatched when a UI element in the player is rolled over.Component
 InheritedDispatched when a property changes in a bindable component.Component
Constructor Detail
Link()Constructor
public function Link(element:Object)

Constructor.

Parameters
element:Object — layout element to wrap and delegate all calls to.
Method Detail
getAutoSize()method
public function getAutoSize():Boolean

Returns whether the button resizes based on its label and icon.

Returns
Boolean — True if the button resizes based on its label and icon.
getFont()method 
public function getFont():String

Returns the name of the font used for the label.

Returns
String — The name of the font used.
getHAlign()method 
public function getHAlign():String

Gets the horizontal alignment for the textfield in the label.

Returns
String — The horizontal alignment for the textfield in the label.
getMultiline()method 
public function getMultiline():Boolean

Returns whether the button label is set to be multiline.

Returns
Boolean — True if the button label is multiline.
getText()method 
public function getText():String

Gets the text appearing for the link.

Returns
String — The text appearing for the link.
getTextSize()method 
public function getTextSize():Number

Returns the font point size used for the label.

Returns
Number — The point size of the font.
getTooltip()method 
public function getTooltip():String

Returns the tooltip, if any, applied to the component.

Returns
String — Returns the string tooltip text.
getURL()method 
public function getURL():String

Gets the url for the link.

Returns
String — The url the link should navigate to.
getVAlign()method 
public function getVAlign():String

Gets the vertical alignment for the textfield in the label.

Returns
String — The vertical alignment for the textfield in the label.
setAutoSize()method 
public function setAutoSize(autoSize:Boolean):void

Sets whether the button should resize based on its label and icon.

Parameters

autoSize:Boolean — if the button should resize based on its label and icon.

setFont()method 
public function setFont(font:String):void

Sets a font to be used instead of the style format's.

Parameters

font:String — name of the font to use -- MUST be embedded, if the style format embeds the font.

setHAlign()method 
public function setHAlign(align:String):void

Sets the horizontal alignment for the textfield in the label.

Parameters

align:String — horizontal alignment for the textfield in the label.

setMultiline()method 
public function setMultiline(multiline:Boolean):void

Sets whether the button label should display multiline.

Parameters

multiline:Boolean — if the button label should display as multiline.

setText()method 
public function setText(text:String):void

Sets the text appearing for the link.

Parameters

text:String — text to appear for the link.

setTextSize()method 
public function setTextSize(size:Number):void

Sets a font size to be used instead of the style format's.

Parameters

size:Number — point size of the font.

setTooltip()method 
public function setTooltip(toolTip:String):void

Sets the tooltip for the component.

Parameters

toolTip:String — string to use for the tooltip text.

setURL()method 
public function setURL(url:String):void

Sets the url for the link.

Parameters

url:String — url the link should navigate to.

setVAlign()method 
public function setVAlign(align:String):void

Sets the vertical alignment for the textfield in the label.

Parameters

align:String — vertical alignment for the textfield in the label.