Package | com.brightcove.api.components |
Class | public class Image |
Inheritance | Image ![]() ![]() ![]() |
Method | Defined By | ||
---|---|---|---|
Image(element:Object)
Constructor. | Image | ||
![]() | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = true):void [override]
Adds a listener for an event. | UIObject | |
![]() | getAlpha():Number
Returns the alpha value of the component. | Component | |
![]() | getBlendMode():String
Returns the blend mode of the component. | UIObject | |
![]() |
Returns the interface for the layout container of the element. | Component | |
getContentHeight():Number
Returns the pixel height of the loaded image. | Image | ||
getContentWidth():Number
Returns the pixel width of the loaded image. | Image | ||
![]() | getCSS():String
Returns the CSS used for this component instance. | UIObject | |
![]() | getDefinition():String
Returns the XML (BEML) definition of the component. | Component | |
![]() | getEnabled():Boolean
Returns whether component is enabled. | UIObject | |
getHAlign():String
Returns the horizontal alignment of the image within the container. | Image | ||
![]() | getHeight():Number
Returns the pixel height of the component. | Component | |
![]() | getID():String
Returns the ID of the component, as defined in the XML. | Component | |
![]() | getIncludeInLayout():Boolean
Returns whether the component is included in layout calculations and rendering in parent layout box. | Component | |
![]() | 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 | ||
![]() | getNextSibling():Object
Returns the interface for the layout element that is the next sibling to this element in the parent containers's element array. | Component | |
![]() | getNodeName():String
Returns the node name of the element. | Component | |
![]() | getPreviousSibling():Object
Returns the interface for the layout element that is the previous sibling to this element in the parent containers's element array. | Component | |
![]() | 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 | ||
![]() | getVisible():Boolean
Returns whether the component is visible. | Component | |
![]() | getWidth():Number
Returns the pixel width of the component. | Component | |
![]() | getX(global:Boolean = false):Number
Returns the position of the component on the x axis. | Component | |
![]() | getY(global:Boolean = false):Number
Returns the position of the component on the y axis. | Component | |
![]() | move(x:Number, y:Number, global:Boolean = false):void
Sets the x,y coordinates of the component. | Component | |
![]() | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void [override]
Removes a listener for an event. | UIObject | |
![]() | setAlpha(alpha:Number):void
Sets the alpha value of the component. | Component | |
![]() | setBlendMode(mode:String):void
Sets the blend mode of the component. | UIObject | |
![]() | 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 | ||
![]() | 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 | ||
![]() | 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 | ||
![]() | 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 | ||
![]() | 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 | ||
![]() | setVisible(visible:Boolean):void
Sets whether the component is visible. | Component |
Image | () | Constructor |
public function Image(element:Object)
Constructor.
Parameterselement:Object — layout element to wrap and delegate all calls to.
|
getContentHeight | () | method |
public function getContentHeight():Number
Returns the pixel height of the loaded image.
ReturnsNumber — The pixel height of the loaded image.
|
getContentWidth | () | method |
public function getContentWidth():Number
Returns the pixel width of the loaded image.
ReturnsNumber — The pixel width of the loaded image.
|
getHAlign | () | method |
public function getHAlign():String
Returns the horizontal alignment of the image within the container.
ReturnsString — 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.
ReturnsNumber — 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.
ReturnsString — 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.
ReturnsString — The string name or path of the image loaded.
|
getTooltip | () | method |
public function getTooltip():String
Returns to the tooltip text for the image.
ReturnsString — Tooltip string text for the image.
|
getURL | () | method |
public function getURL():String
Returns the click-thru URL used by the image.
ReturnsString — The click-thru URL used by the image.
|
getVAlign | () | method |
public function getVAlign():String
Returns the vertical alignment of the image within the container.
ReturnsString — 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.
|