Packageorg.osmf.smpte.tt.rendering
Interfacepublic interface IRenderObject



Public Methods
 MethodDefined By
  
clear the drawing surface to the specified color.
IRenderObject
  
close():void
IRenderObject
  
computeTextExtent(text:String, font:Font):Rectangle
IRenderObject
  
drawLine(color:ColorExpression, startX:Number, startY:Number, endX:Number, endY:Number):void
Draw a line in the specified colour from x to y
IRenderObject
  
drawOutlineText(text:String, font:Font, fill:ColorExpression, outline:TextOutline, startX:Number, startY:Number, data:MetadataInformation):void
IRenderObject
  
drawRectangle(color:ColorExpression, startX:Number, startY:Number, endX:Number, endY:Number):void
Draw a rectangle outline with specified pen, filled with specified brush from top left (x1,y1) to bottom right (x2,y2)
IRenderObject
  
drawText(text:String, font:Font, fill:ColorExpression, decoration:TextDecorationAttributeValue, startX:Number, startY:Number, data:MetadataInformation):void
Draws a series of glyphs identified by the specified text and font.
IRenderObject
  
height():Number
IRenderObject
  
open():void
IRenderObject
  
popClip():void
Unset clipping rectangle
IRenderObject
  
pushClip(rectangle:Rectangle):void
Set clipping rectangle.
IRenderObject
  
pushScroll(horizontalDistance:Number, verticalDistance:Number):void
IRenderObject
  
setOpacity(level:Number):void
Set the drawing opacity
IRenderObject
  
width():Number
IRenderObject
Method Detail
clear()method
public function clear(color:ColorExpression):void

clear the drawing surface to the specified color.

Parameters

color:ColorExpression

close()method 
public function close():void

computeTextExtent()method 
public function computeTextExtent(text:String, font:Font):Rectangle

Parameters

text:String
 
font:Font

Returns
Rectangle
drawLine()method 
public function drawLine(color:ColorExpression, startX:Number, startY:Number, endX:Number, endY:Number):void

Draw a line in the specified colour from x to y

Parameters

color:ColorExpression
 
startX:Number
 
startY:Number
 
endX:Number
 
endY:Number

drawOutlineText()method 
public function drawOutlineText(text:String, font:Font, fill:ColorExpression, outline:TextOutline, startX:Number, startY:Number, data:MetadataInformation):void

Parameters

text:String
 
font:Font
 
fill:ColorExpression
 
outline:TextOutline
 
startX:Number
 
startY:Number
 
data:MetadataInformation

drawRectangle()method 
public function drawRectangle(color:ColorExpression, startX:Number, startY:Number, endX:Number, endY:Number):void

Draw a rectangle outline with specified pen, filled with specified brush from top left (x1,y1) to bottom right (x2,y2)

Parameters

color:ColorExpression — top left x coordinate
 
startX:Number — top left y coordinate
 
startY:Number — bottom right x coordinate
 
endX:Number — bottom right y coordinate
 
endY:Number

drawText()method 
public function drawText(text:String, font:Font, fill:ColorExpression, decoration:TextDecorationAttributeValue, startX:Number, startY:Number, data:MetadataInformation):void

Draws a series of glyphs identified by the specified text and font.

Parameters

text:String
 
font:Font
 
fill:ColorExpression
 
decoration:TextDecorationAttributeValue
 
startX:Number
 
startY:Number
 
data:MetadataInformation

height()method 
public function height():Number

Returns
Number
open()method 
public function open():void

popClip()method 
public function popClip():void

Unset clipping rectangle

pushClip()method 
public function pushClip(rectangle:Rectangle):void

Set clipping rectangle.

Parameters

rectangle:Rectangle — clipping rectangle

pushScroll()method 
public function pushScroll(horizontalDistance:Number, verticalDistance:Number):void

Parameters

horizontalDistance:Number
 
verticalDistance:Number

setOpacity()method 
public function setOpacity(level:Number):void

Set the drawing opacity

Parameters

level:Number — level

width()method 
public function width():Number

Returns
Number