Package | org.osmf.smpte.tt.formatting |
Class | public class Paragraph |
Inheritance | Paragraph FormattingObject TreeType Object |
Property | Defined By | ||
---|---|---|---|
animations : Vector.<Animation> | FormattingObject | ||
assignedRegion : RegionElement [read-only]
Return the currently assigned region for this Formatting object
| FormattingObject | ||
attributes : Vector.<TimedTextAttributeBase> [read-only]
List of attributes associated with this node
| TreeType | ||
backgroundColorStyleProperty : ColorExpression [read-only] | FormattingObject | ||
begin : TimeCode [read-only]
Get the time at which this element becomes active
| TreeType | ||
children : Vector.<TreeType> [read-only]
List of time trees that are contained within this node
| TreeType | ||
colorStyleProperty : ColorExpression [read-only] | FormattingObject | ||
contextualFontSize : FontSize | FormattingObject | ||
directionStyleProperty : String [read-only] | FormattingObject | ||
displayAlignStyleProperty : String [read-only] | FormattingObject | ||
displayStyleProperty : String [read-only] | FormattingObject | ||
duration : TimeCode [read-only]
Get the time at which this element is no longer active
| TreeType | ||
element : TimedTextElementBase | FormattingObject | ||
end : TimeCode [read-only]
Get the time at which this element is no longer active
| TreeType | ||
events : Vector.<TimeCode> [read-only]
return an ordered list of the significant time events
in the time tree. | TreeType | ||
formatter : Function
Formatter is a function which takes a rendering engine
and applies it to the element
| FormattingObject | ||
leftStyleProperty : Number [read-only] | FormattingObject | ||
metadata : Dictionary [read-only]
Metadata associated with this node
| TreeType | ||
opacityStyleProperty : Number [read-only] | FormattingObject | ||
overflowStyleProperty : String [read-only] | FormattingObject | ||
parent : TreeType
tree node which is the unique parent of this node
| TreeType | ||
preserveStyleProperty : Boolean [read-only] | FormattingObject | ||
regionId : String [read-only]
Get the region for this formatting object
| FormattingObject | ||
renderPassProperty : int [read-only] | FormattingObject | ||
showBackgroundStyleProperty : String [read-only] | FormattingObject | ||
text : String | Paragraph | ||
textAlignStyleProperty : String [read-only] | FormattingObject | ||
textDecorationStyleProperty : TextDecorationAttributeValue [read-only] | FormattingObject | ||
textOutlineStyleProperty : TextOutline [read-only] | FormattingObject | ||
timeSemantics : TimeContainer
Specifies whether children are sequential or parallel in time. | TreeType | ||
timing : Dictionary [read-only]
The begin, end and dur times for this node
| TreeType | ||
topStyleProperty : Number [read-only] | FormattingObject | ||
unicodeBidirectionStyleProperty : String [read-only] | FormattingObject | ||
visibilityStyleProperty : String [read-only] | FormattingObject | ||
wrapOptionStyleProperty : Boolean [read-only] | FormattingObject | ||
writingModeStyleProperty : WritingMode [read-only] | FormattingObject |
Method | Defined By | ||
---|---|---|---|
Paragraph(p_element:TimedTextElementBase) | Paragraph | ||
actualArea():Rectangle [override] | Paragraph | ||
addBidirectionEncoding(text:String, unicodeBidirection:String, direction:String):String [static]
collect up the Unicode Bidi algorithm on this paragraph
| Paragraph | ||
applyAnimations():void
Override animated attributes. | FormattingObject | ||
FormattingObject | |||
FormattingObject | |||
FormattingObject | |||
FormattingObject | |||
FormattingObject | |||
clearStyle(property:String):void
clear a local style
| FormattingObject | ||
computeRelativeStyles(renderObject:IRenderObject):void
Calculate the context font size. | FormattingObject | ||
Walk the tree to determine the absolute start and end times of all the elements. | TreeType | ||
createFormatter():Function [override]
Return a formatting function for paragraphs. | Paragraph | ||
prune(regionId:String):void
Remove any subtrees which are not selected into the region. | FormattingObject | ||
referenceArea():Rectangle [override] | Paragraph | ||
removeAppliedAnimations():void
Undo all the animated overrides. | FormattingObject | ||
[static]
return the formatting object which represents the timed text tree at the given time
| FormattingObject | ||
setStyle(property:String, value:*):void
Set a local style on the element
| FormattingObject | ||
temporallyActive(time:TimeCode):Boolean
Test if the tree is active at the given time
| TreeType |
text | property |
text:String
public function get text():String
public function set text(value:String):void
Paragraph | () | Constructor |
actualArea | () | method |
override public function actualArea():Rectangle
ReturnsRectangle |
addBidirectionEncoding | () | method |
public static function addBidirectionEncoding(text:String, unicodeBidirection:String, direction:String):String
collect up the Unicode Bidi algorithm on this paragraph
Parameters
text:String — one of embed, normal, bidiOveride
| |
unicodeBidirection:String — one of ltr or rtl
| |
direction:String |
String |
createFormatter | () | method |
override public function createFormatter():Function
Return a formatting function for paragraphs.
ReturnsFunction |
referenceArea | () | method |
override public function referenceArea():Rectangle
ReturnsRectangle |