Packageorg.osmf.smpte.tt.media
Classpublic class RegionLayoutTargetSprite
InheritanceRegionLayoutTargetSprite Inheritance RootLayoutTargetSprite Inheritance org.osmf.layout.LayoutTargetSprite


Public Properties
 PropertyDefined By
 InheritedbackgroundAlpha : Number
Defines the container's background alpha.
RootLayoutTargetSprite
 InheritedbackgroundColor : Number
Defines the container's background color.
RootLayoutTargetSprite
  captionRegion : CaptionRegion
RegionLayoutTargetSprite
 InheritedclipChildren : Boolean
Defines if the children of the container that display outside of its bounds will be clipped or not.
RootLayoutTargetSprite
  height : Number
[override] [write-only]
RegionLayoutTargetSprite
  id : String
RegionLayoutTargetSprite
 InheritedlayoutRenderer : LayoutRendererBase
[read-only] The layout renderer that renders the LayoutTarget instances within this container.
RootLayoutTargetSprite
 InheritedmediaElement : MediaElement
RootLayoutTargetSprite
  showBackground : String
RegionLayoutTargetSprite
  width : Number
[override] [write-only]
RegionLayoutTargetSprite
Protected Properties
 PropertyDefined By
 InheritedlastAvailableHeight : Number
RootLayoutTargetSprite
 InheritedlastAvailableWidth : Number
RootLayoutTargetSprite
Public Methods
 MethodDefined By
  
RegionLayoutTargetSprite(captionRegion:CaptionRegion, layoutRenderer:LayoutRendererBase = null, layoutMetadata:LayoutMetadata = null)
RegionLayoutTargetSprite
  
addCaption(value:CaptionElement):void
RegionLayoutTargetSprite
  
clear():void
RegionLayoutTargetSprite
  
layout(availableWidth:Number, availableHeight:Number, deep:Boolean = true):void
[override]
RegionLayoutTargetSprite
  
redrawCaption():void
RegionLayoutTargetSprite
  
removeCaption(value:CaptionElement = null):void
RegionLayoutTargetSprite
  
validateCaption(begin:Number, end:Number, currentTime:Number):void
RegionLayoutTargetSprite
Property Detail
captionRegionproperty
captionRegion:CaptionRegion


Implementation
    public function get captionRegion():CaptionRegion
    public function set captionRegion(value:CaptionRegion):void
heightproperty 
height:Number  [write-only] [override]


Implementation
    public function set height(value:Number):void
idproperty 
id:String


Implementation
    public function get id():String
    public function set id(value:String):void
showBackgroundproperty 
showBackground:String


Implementation
    public function get showBackground():String
    public function set showBackground(value:String):void
widthproperty 
width:Number  [write-only] [override]


Implementation
    public function set width(value:Number):void
Constructor Detail
RegionLayoutTargetSprite()Constructor
public function RegionLayoutTargetSprite(captionRegion:CaptionRegion, layoutRenderer:LayoutRendererBase = null, layoutMetadata:LayoutMetadata = null)



Parameters
captionRegion:CaptionRegion
 
layoutRenderer:LayoutRendererBase (default = null)
 
layoutMetadata:LayoutMetadata (default = null)
Method Detail
addCaption()method
public function addCaption(value:CaptionElement):void

Parameters

value:CaptionElement

clear()method 
public function clear():void

layout()method 
override public function layout(availableWidth:Number, availableHeight:Number, deep:Boolean = true):void

Parameters

availableWidth:Number
 
availableHeight:Number
 
deep:Boolean (default = true)

redrawCaption()method 
public function redrawCaption():void

removeCaption()method 
public function removeCaption(value:CaptionElement = null):void

Parameters

value:CaptionElement (default = null)

validateCaption()method 
public function validateCaption(begin:Number, end:Number, currentTime:Number):void

Parameters

begin:Number (default = NaN)
 
end:Number (default = NaN)
 
currentTime:Number (default = NaN)




Generated by Flexmojos

Fri May 6 2016, 10:06 AM +05:30