org.osmf.smpte.tt.model.TimedTextElementBase

	Property	Defined By
		attributes : Vector.<TimedTextAttributeBase> [read-only] List of attributes associated with this node	TreeType
		begin : TimeCode [read-only] Get the time at which this element becomes active	TreeType
		body : BodyElement	TimedTextElementBase
		cachedRegex : Dictionary [static]	TimedTextElementBase
		children : Vector.<TreeType> [read-only] List of time trees that are contained within this node	TreeType
		defaultZ : Number = 0.0001 [static]	TimedTextElementBase
		duration : TimeCode [read-only] Get the time at which this element is no longer active	TreeType
		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
		id : String	TimedTextElementBase
		language : String	TimedTextElementBase
		localName : String	TimedTextElementBase
		metadata : Dictionary [read-only] Metadata associated with this node	TreeType
		namespace : Namespace	TimedTextElementBase
		parent : TreeType tree node which is the unique parent of this node	TreeType
		root : TtElement	TimedTextElementBase
		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

	Method	Defined By
		TimedTextElementBase()	TimedTextElementBase
		clearLocalStyle(property:String):void Clear local style on this element	TimedTextElementBase
		computeTimeIntervals(context:TimeContainer, referenceStart:TimeCode, referenceEnd:TimeCode):void Walk the tree to determine the absolute start and end times of all the elements.	TreeType
		getComputedStyle(propertyName:String, currentRegion:RegionElement):* Get the final computed value for a style property from this element	TimedTextElementBase
		getElementFromName(elem:String):TimedTextElementBase [static] Instantiate one of the TimedText.classes from a string representing its name.	TimedTextElementBase
		getFormattingObject(tick:TimeCode):FormattingObject sub classes need to override this.	TimedTextElementBase
		getInheritedStyle(propertyName:String, currentRegion:RegionElement):Object Get the computed value for a style property from this element's parent region	TimedTextElementBase
		getMetadata(attribute:String):String Get recorded metadata for the given attribute	TimedTextElementBase
		getReferentStyle(property:String):Object Look up a style property in any referent style elements.	TimedTextElementBase
		serialize():String	TimedTextElementBase
		setLocalStyle(property:String, value:*):void Set a local style on this element allows modification at runtime.	TimedTextElementBase
		temporallyActive(time:TimeCode):Boolean Test if the tree is active at the given time	TreeType
		valid():Boolean Test validity of this subtree	TimedTextElementBase
		writeAttributes(writer:XML):void	TimedTextElementBase
		writeElement(writer:XML, isRoot:Boolean = false):void	TimedTextElementBase

	Method	Defined By
		error(message:String):void [static]	TimedTextElementBase
		validateAttributes(parameterSet:Boolean, metadataSet:Boolean, styleSet:Boolean, timingSet:Boolean, regionSet:Boolean, timeContainerSet:Boolean):void Validate attribute classes	TimedTextElementBase
		validAttributes():void Test whether an element's attributes are allowed by Timed Text	TimedTextElementBase
		validElements():void Test whether an element's content model, and all its descendants are valid Timed Text	TimedTextElementBase
		validParameterAttribute(attribute:TimedTextAttributeBase, feature:Boolean = false, value:String):void Validate a parameter attribute	TimedTextElementBase
		validProfileAttribute(attribute:TimedTextAttributeBase):void [static] Validate a profile attribute	TimedTextElementBase
		validRegionAttribute(attribute:TimedTextAttributeBase):void Validate a region attribute	TimedTextElementBase
		validStyleReference(attribute:TimedTextAttributeBase):void Validate a style reference attribute	TimedTextElementBase
		validTimeContainerAttribute(attribute:TimedTextAttributeBase):void Validate a time container attribute	TimedTextElementBase
		validXmlAttributeValue(attribute:TimedTextAttributeBase):void Validate an XML attribute value	TimedTextElementBase

Property Detail

body

property

public var body:BodyElement

cachedRegex

property

public static var cachedRegex:Dictionary

defaultZ

property

public static var defaultZ:Number = 0.0001

property

public var id:String

language

property

public var language:String

localName

property

public var localName:String

namespace

property

public var namespace:Namespace

root

property

public var root:TtElement

Constructor Detail

TimedTextElementBase

()

Constructor

public function TimedTextElementBase()

Method Detail

clearLocalStyle

()

method

public function clearLocalStyle(property:String):void

Clear local style on this element

Parameters

property:String

error

()

method

protected static function error(message:String):void

Parameters

message:String

getComputedStyle

()

method

public function getComputedStyle(propertyName:String, currentRegion:RegionElement):*

Get the final computed value for a style property from this element

Parameters

	`propertyName:String`

	`currentRegion:RegionElement`

Returns

*

getElementFromName

()

method

public static function getElementFromName(elem:String):TimedTextElementBase

Instantiate one of the TimedText.classes from a string representing its name.

Parameters

elem:String — name of the class to instantiate

Returns

TimedTextElementBase

getFormattingObject

()

method

public function getFormattingObject(tick:TimeCode):FormattingObject

sub classes need to override this.

Parameters

tick:TimeCode

Returns

FormattingObject

getInheritedStyle

()

method

public function getInheritedStyle(propertyName:String, currentRegion:RegionElement):Object

Get the computed value for a style property from this element's parent region

Parameters

	`propertyName:String`

	`currentRegion:RegionElement`

Returns

Object

getMetadata

()

method

public function getMetadata(attribute:String):String

Get recorded metadata for the given attribute

Parameters

attribute:String — metadata attribute to retrieve

Returns

String

getReferentStyle

()

method

public function getReferentStyle(property:String):Object

Look up a style property in any referent style elements.

Parameters

property:String

Returns

Object

serialize

()

method

public function serialize():String

Returns

String

setLocalStyle

()

method

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

Set a local style on this element allows modification at runtime.

Parameters

	`property:String`

	`value:*`

valid

()

method

public function valid():Boolean

Test validity of this subtree

Returns

Boolean

validateAttributes

()

method

 protected function validateAttributes(parameterSet:Boolean, metadataSet:Boolean, styleSet:Boolean, timingSet:Boolean, regionSet:Boolean, timeContainerSet:Boolean):void

Validate attribute classes

Parameters

	`parameterSet:Boolean` — true if required to validate parameter attributes

	`metadataSet:Boolean` — true if required to validate metadata attributes

	`styleSet:Boolean` — true if required to validate style attributes

	`timingSet:Boolean` — true if required to validate timing attributes

	`regionSet:Boolean` — true if required to validate region attributes

	`timeContainerSet:Boolean` — true if required to time container parameter attributes

validAttributes

()

method

protected function validAttributes():void

Test whether an element's attributes are allowed by Timed Text

Throws

an — exception if invalid.

validElements

()

method

protected function validElements():void

Test whether an element's content model, and all its descendants are valid Timed Text

Throws

an — exception if invalid.

validParameterAttribute

()

method

 protected function validParameterAttribute(attribute:TimedTextAttributeBase, feature:Boolean = false, value:String):void

Validate a parameter attribute

Parameters

	`attribute:TimedTextAttributeBase`

	`feature:Boolean` (default = `false`)

	`value:String`

validProfileAttribute

()

method

protected static function validProfileAttribute(attribute:TimedTextAttributeBase):void

Validate a profile attribute

Parameters

attribute:TimedTextAttributeBase

validRegionAttribute

()

method

protected function validRegionAttribute(attribute:TimedTextAttributeBase):void

Validate a region attribute

Parameters

attribute:TimedTextAttributeBase

validStyleReference

()

method

protected function validStyleReference(attribute:TimedTextAttributeBase):void

Validate a style reference attribute

Parameters

attribute:TimedTextAttributeBase

validTimeContainerAttribute

()

method

protected function validTimeContainerAttribute(attribute:TimedTextAttributeBase):void

Validate a time container attribute

Parameters

attribute:TimedTextAttributeBase

validXmlAttributeValue

()

method

protected function validXmlAttributeValue(attribute:TimedTextAttributeBase):void

Validate an XML attribute value

Parameters

attribute:TimedTextAttributeBase

writeAttributes

()

method

public function writeAttributes(writer:XML):void

Parameters

writer:XML

writeElement

()

method

public function writeElement(writer:XML, isRoot:Boolean = false):void

Parameters

	`writer:XML`

	`isRoot:Boolean` (default = `false`)

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

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

Package	org.osmf.smpte.tt.model
Class	public class TimedTextElementBase
Inheritance	TimedTextElementBase TreeType Object
Subclasses	BodyElement, DivElement, HeadElement, LayoutElement, MetadataElement, MetadataElement, ParameterElement, PElement, RegionElement, SetElement, SpanElement, StyleElement, StylingElement, TtElement