org.osmf.smpte.tt.formatting.FormattingObject

	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
		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

	Property	Defined By
		actualDrawing : Rectangle	FormattingObject

	Method	Defined By
		FormattingObject()	FormattingObject
		actualArea():Rectangle The ActualArea area is where this element draws itself into	FormattingObject
		applyAnimations():void Override animated attributes.	FormattingObject
		calculateExtentStyle(renderObject:IRenderObject):Extent	FormattingObject
		calculateFontSizeStyle(renderObject:IRenderObject):FontSize	FormattingObject
		calculateLineHeightStyle(renderObject:IRenderObject):LineHeight	FormattingObject
		calculateOriginStyle(renderObject:IRenderObject):Origin	FormattingObject
		calculatePaddingStyle(renderObject:IRenderObject):PaddingThickness	FormattingObject
		clearStyle(property:String):void clear a local style	FormattingObject
		computeRelativeStyles(renderObject:IRenderObject):void Calculate the context font size.	FormattingObject
		computeTimeIntervals(context:TimeContainer, referenceStart:TimeCode, referenceEnd:TimeCode):void Walk the tree to determine the absolute start and end times of all the elements.	TreeType
		createFormatter():Function Return a formatting function for this element.	FormattingObject
		prune(regionId:String):void Remove any subtrees which are not selected into the region.	FormattingObject
		referenceArea():Rectangle The reference area is where this element computes its dimensions from	FormattingObject
		removeAppliedAnimations():void Undo all the animated overrides.	FormattingObject
		renderTree(timeSpan:TimeCode, tree:TimedTextElementBase):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

Property Detail

actualDrawing

property

protected var actualDrawing:Rectangle

animations

property

animations:Vector.<Animation>

Implementation
public function get animations():Vector.<Animation>
public function set animations(value:Vector.<Animation>):void

assignedRegion

property

assignedRegion:RegionElement [read-only]

Return the currently assigned region for this Formatting object

Implementation
public function get assignedRegion():RegionElement

backgroundColorStyleProperty

property

backgroundColorStyleProperty:ColorExpression [read-only]

Implementation
public function get backgroundColorStyleProperty():ColorExpression

colorStyleProperty

property

colorStyleProperty:ColorExpression [read-only]

Implementation
public function get colorStyleProperty():ColorExpression

contextualFontSize

property

contextualFontSize:FontSize

Implementation
public function get contextualFontSize():FontSize
public function set contextualFontSize(value:FontSize):void

directionStyleProperty

property

directionStyleProperty:String [read-only]

Implementation
public function get directionStyleProperty():String

displayAlignStyleProperty

property

displayAlignStyleProperty:String [read-only]

Implementation
public function get displayAlignStyleProperty():String

displayStyleProperty

property

displayStyleProperty:String [read-only]

Implementation
public function get displayStyleProperty():String

element

property

element:TimedTextElementBase

Implementation
public function get element():TimedTextElementBase
public function set element(value:TimedTextElementBase):void

formatter

property

public var formatter:Function

Formatter is a function which takes a rendering engine and applies it to the element

leftStyleProperty

property

leftStyleProperty:Number [read-only]

Implementation
public function get leftStyleProperty():Number

opacityStyleProperty

property

opacityStyleProperty:Number [read-only]

Implementation
public function get opacityStyleProperty():Number

overflowStyleProperty

property

overflowStyleProperty:String [read-only]

Implementation
public function get overflowStyleProperty():String

preserveStyleProperty

property

preserveStyleProperty:Boolean [read-only]

Implementation
public function get preserveStyleProperty():Boolean

regionId

property

regionId:String [read-only]

Get the region for this formatting object

Implementation
public function get regionId():String

renderPassProperty

property

renderPassProperty:int [read-only]

Implementation
public function get renderPassProperty():int

showBackgroundStyleProperty

property

showBackgroundStyleProperty:String [read-only]

Implementation
public function get showBackgroundStyleProperty():String

textAlignStyleProperty

property

textAlignStyleProperty:String [read-only]

Implementation
public function get textAlignStyleProperty():String

textDecorationStyleProperty

property

textDecorationStyleProperty:TextDecorationAttributeValue [read-only]

Implementation
public function get textDecorationStyleProperty():TextDecorationAttributeValue

textOutlineStyleProperty

property

textOutlineStyleProperty:TextOutline [read-only]

Implementation
public function get textOutlineStyleProperty():TextOutline

topStyleProperty

property

topStyleProperty:Number [read-only]

Implementation
public function get topStyleProperty():Number

unicodeBidirectionStyleProperty

property

unicodeBidirectionStyleProperty:String [read-only]

Implementation
public function get unicodeBidirectionStyleProperty():String

visibilityStyleProperty

property

visibilityStyleProperty:String [read-only]

Implementation
public function get visibilityStyleProperty():String

wrapOptionStyleProperty

property

wrapOptionStyleProperty:Boolean [read-only]

Implementation
public function get wrapOptionStyleProperty():Boolean

writingModeStyleProperty

property

writingModeStyleProperty:WritingMode [read-only]

Implementation
public function get writingModeStyleProperty():WritingMode

Constructor Detail

FormattingObject

()

Constructor

public function FormattingObject()

Method Detail

actualArea

()

method

public function actualArea():Rectangle

The ActualArea area is where this element draws itself into

Returns

Rectangle

applyAnimations

()

method

public function applyAnimations():void

Override animated attributes.

calculateExtentStyle

()

method

public function calculateExtentStyle(renderObject:IRenderObject):Extent

Parameters

renderObject:IRenderObject

Returns

Extent

calculateFontSizeStyle

()

method

public function calculateFontSizeStyle(renderObject:IRenderObject):FontSize

Parameters

renderObject:IRenderObject

Returns

FontSize

calculateLineHeightStyle

()

method

public function calculateLineHeightStyle(renderObject:IRenderObject):LineHeight

Parameters

renderObject:IRenderObject

Returns

LineHeight

calculateOriginStyle

()

method

public function calculateOriginStyle(renderObject:IRenderObject):Origin

Parameters

renderObject:IRenderObject

Returns

Origin

calculatePaddingStyle

()

method

public function calculatePaddingStyle(renderObject:IRenderObject):PaddingThickness

Parameters

renderObject:IRenderObject

Returns

PaddingThickness

clearStyle

()

method

public function clearStyle(property:String):void

clear a local style

Parameters

property:String

computeRelativeStyles

()

method

public function computeRelativeStyles(renderObject:IRenderObject):void

Calculate the context font size.

Parameters

renderObject:IRenderObject

createFormatter

()

method

public function createFormatter():Function

Return a formatting function for this element.

Returns

Function

prune

()

method

public function prune(regionId:String):void

Remove any subtrees which are not selected into the region.

Parameters

regionId:String — region to select

referenceArea

()

method

public function referenceArea():Rectangle

The reference area is where this element computes its dimensions from

Returns

Rectangle

removeAppliedAnimations

()

method

public function removeAppliedAnimations():void

Undo all the animated overrides.

renderTree

()

method

public static function renderTree(timeSpan:TimeCode, tree:TimedTextElementBase):FormattingObject

return the formatting object which represents the timed text tree at the given time

Parameters

	`timeSpan:TimeCode`

	`tree:TimedTextElementBase`

Returns

FormattingObject

setStyle

()

method

public function setStyle(property:String, value:*):void

Set a local style on the element

Parameters

	`property:String`

	`value:*`

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

HDCore Documentation	All Packages \| All Classes \| Index \| Frames No Frames
FormattingObject	Properties \| Methods

Package	org.osmf.smpte.tt.formatting
Class	public class FormattingObject
Inheritance	FormattingObject TreeType Object
Subclasses	Animation, Block, BlockContainer, Flow, Inline, InlineContent, Paragraph, Root