Packagecom.brightcove.api.components
Classpublic class Image
InheritanceImage Inheritance UIObject Inheritance Component Inheritance flash.events.EventDispatcher

The Image 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
  
Image(element:Object)
Constructor.
Image
 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
 Inherited
getBlendMode():String
Returns the blend mode of the component.
UIObject
 Inherited
Returns the interface for the layout container of the element.
Component
  
Returns the pixel height of the loaded image.
Image
  
Returns the pixel width of the loaded image.
Image
 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
  
getHAlign():String
Returns the horizontal alignment of the image within the container.
Image
 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
  
getInset():Number
Returns the pixel amount on each side that the loaded image is inset within the container.
Image
 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
  
getScaleMode():String
Returns the method for scaling up or down the image within the container.
Image
  
getSource():String
Returns the name or path of the image loaded.
Image
  
getTooltip():String
Returns to the tooltip text for the image.
Image
  
getURL():String
Returns the click-thru URL used by the image.
Image
  
getVAlign():String
Returns the vertical alignment of the image within the container.
Image
 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
 Inherited
setBlendMode(mode:String):void
Sets the blend mode of the component.
UIObject
 Inherited
setEnabled(enable:Boolean):void
Enables/disables component for events.
UIObject
  
setHAlign(align:String):void
Sets the horizontal alignment of the image within the container.
Image
 Inherited
setIncludeInLayout(includeInLayout:Boolean):void
Sets whether the component is included in layout calculations and rendering in parent layout box.
Component
  
setInset(inset:Number):void
Sets the pixel amount on each side that the loaded image should be inset within the container.
Image
 Inherited
setRotation(rotation:Number):void
Sets the rotation of the component.
UIObject
  
setScaleMode(mode:String):void
Sets the method for scaling up or down the image within the container.
Image
 Inherited
setSize(width:Number, height:Number):void
Sets the pixel dimensions for the wrapped component.
Component
  
setSource(image:String):void
Loads the specified file in the wrapped image.
Image
 Inherited
setStyles(styles:String):void
Overrides specific styles for a component by accepting a semicolon-delimited list of style names and colors.
UIObject
  
setTooltip(tooltip:String):void
Sets the tooltip text for the image.
Image
  
setURL(url:String):void
Sets the click-thru URL to be used by the image.
Image
  
setVAlign(align:String):void
Sets the vertical alignment of the image within the container.
Image
 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
Image()Constructor
public function Image(element:Object)

Constructor.

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

Returns the pixel height of the loaded image.

Returns
Number — The pixel height of the loaded image.
getContentWidth()method 
public function getContentWidth():Number

Returns the pixel width of the loaded image.

Returns
Number — The pixel width of the loaded image.
getHAlign()method 
public function getHAlign():String

Returns the horizontal alignment of the image within the container.

Returns
String — The horizontal alignment of the image within the container. Should be a constant of Alignment.
getInset()method 
public function getInset():Number

Returns the pixel amount on each side that the loaded image is inset within the container.

Returns
Number — The pixel amount on each side that the loaded image is inset within the container.
getScaleMode()method 
public function getScaleMode():String

Returns the method for scaling up or down the image within the container.

Returns
String — The method for scaling up or down the image within the container. Should be a constant of ScaleModes.
getSource()method 
public function getSource():String

Returns the name or path of the image loaded.

Returns
String — The string name or path of the image loaded.
getTooltip()method 
public function getTooltip():String

Returns to the tooltip text for the image.

Returns
String — Tooltip string text for the image.
getURL()method 
public function getURL():String

Returns the click-thru URL used by the image.

Returns
String — The click-thru URL used by the image.
getVAlign()method 
public function getVAlign():String

Returns the vertical alignment of the image within the container.

Returns
String — The vertical alignment of the image within the container. Should be a constant of Alignment.
setHAlign()method 
public function setHAlign(align:String):void

Sets the horizontal alignment of the image within the container.

Parameters

align:String — horizontal alignment of the image within the container. Should be a constant of Alignment.

setInset()method 
public function setInset(inset:Number):void

Sets the pixel amount on each side that the loaded image should be inset within the container.

Parameters

inset:Number — pixel amount on each side that the loaded image is inset within the container.

setScaleMode()method 
public function setScaleMode(mode:String):void

Sets the method for scaling up or down the image within the container.

Parameters

mode:String — method for scaling up or down the image within the container. Should be a constant of ScaleModes.

setSource()method 
public function setSource(image:String):void

Loads the specified file in the wrapped image.

Parameters

image:String — file path to the image, the name of the symbol to instantiate preceded by "lib:", or image class.

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

Sets the tooltip text for the image.

Parameters

tooltip:String — string text for the image.

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

Sets the click-thru URL to be used by the image.

Parameters

url:String — click-thru URL to be used by the image.

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

Sets the vertical alignment of the image within the container.

Parameters

align:String — vertical alignment of the image within the container. Should be a constant of Alignment.