com.objectxp.mms.message.smil
Class Element

java.lang.Object
  com.objectxp.mms.message.smil.Element

Direct Known Subclasses:

Anchor, Area, Body, Head, Layout, Media, Region, RootLayout, SmilDocument, Switch, Timing

public abstract class Element
extends java.lang.Object

Base class form SMIL elements.

Depending on the type of element, a SMIL element may contain zero or more attributes and zero or more child elements.

List of available attributes

Attribute Set Name	Attributes
TIMING-ATTRS	TIMING_BEGIN, TIMING_END, TIMING_DUR, TIMING_ENDSYNC, TIMING_FILL, TIMING_MAX, TIMING_MIN, TIMING_REPEAT_COUNT, TIMING_REPEAT_DUR
CONTCTRL-ATTRS	systemBitrate, systemCaptions, systemLanguage, systemRequired, systemScreenSize, systemScreenDepth, systemOverdubOrSubtitle, systemAudioDesc, systemOperatingSystem, systemCPU, systemComponent CONTCTRL_AUDIO_DESC, CONTCTRL_BITRATE, CONTCTRL_CAPTIONS, CONTCTRL_COMPONENT, CONTCTRL_CPU, CONTCTRL_LANGUAGE, CONTCTRL_OPERATING_SYSTEM, CONTCTRL_OVERDUB_OR_SUBTITLE, CONTCTRL_REQUIRED, CONTCTRL_SCREEN_DEPTH, CONTCTRL_SCREEN_SIZE
MEDIA-ATTRS	MEDIA_SRC, MEDIA_TYPE
LINKING-ATTRS	href, sourceLevel, destinationLevel, sourcePlaystate, destinationPlaystate, show, accesskey, tabindex, target, external, actuate, alt LINKING_ACCESSKEY, LINKING_ACTUATE, LINKING_ALT, LINKING_DEST_LEVEL, LINKING_DEST_PLAYSTATE, LINKING_EXTERNAL, LINKING_HREF, LINKING_SHOW, LINKING_SRC_LEVEL, LINKING_SRC_PLAYSTATE, LINKING_TABINDEX, LINKING_TARGET
COMMON-ATTRS	COMMON_CLASS, COMMON_ID, COMMON_TITLE, COMMON_XML_LANG

Since:

jSMS 2.0

Field Summary

static java.lang.String	COMMON_CLASS COMMON attribute, value: class
static java.lang.String	COMMON_ID COMMON attribute, value: id
static java.lang.String	COMMON_TITLE COMMON attribute, value: title
static java.lang.String	COMMON_XML_LANG COMMON attribute, value: xml:lang
static java.lang.String	CONTCTRL_AUDIO_DESC CONTROL attribute, value: systemOverdubOrSubtitle
static java.lang.String	CONTCTRL_BITRATE CONTROL attribute, value: systemBitrate
static java.lang.String	CONTCTRL_CAPTIONS CONTROL attribute, value: systemCaptions
static java.lang.String	CONTCTRL_COMPONENT CONTROL attribute, value: systemComponent
static java.lang.String	CONTCTRL_CPU CONTROL attribute, value: systemCPU
static java.lang.String	CONTCTRL_LANGUAGE CONTROL attribute, value: systemLanguage
static java.lang.String	CONTCTRL_OPERATING_SYSTEM CONTROL attribute, value: systemOperatingSystem
static java.lang.String	CONTCTRL_OVERDUB_OR_SUBTITLE CONTROL attribute, value: systemOverdubOrSubtitle
static java.lang.String	CONTCTRL_REQUIRED CONTROL attribute, value: systemRequired
static java.lang.String	CONTCTRL_SCREEN_DEPTH CONTROL attribute, value: systemScreenDepth
static java.lang.String	CONTCTRL_SCREEN_SIZE CONTROL attribute, value: systemScreenSize
static java.lang.String	LINKING_ACCESSKEY LINKING attribute, value: accesskey
static java.lang.String	LINKING_ACTUATE LINKING attribute, value: external
static java.lang.String	LINKING_ALT LINKING attribute, value: alt
static java.lang.String	LINKING_DEST_LEVEL LINKING attribute, value: destinationLevel
static java.lang.String	LINKING_DEST_PLAYSTATE LINKING attribute, value: destinationPlaystate
static java.lang.String	LINKING_EXTERNAL LINKING attribute, value: external
static java.lang.String	LINKING_HREF LINKING attribute, value: href
static java.lang.String	LINKING_SHOW LINKING attribute, value: show
static java.lang.String	LINKING_SRC_LEVEL LINKING attribute, value: sourceLevel
static java.lang.String	LINKING_SRC_PLAYSTATE LINKING attribute, value: sourcePlaystate
static java.lang.String	LINKING_TABINDEX LINKING attribute, value: tabindex
static java.lang.String	LINKING_TARGET LINKING attribute, value: target
static java.lang.String	MEDIA_SRC MEDIA attribute, value: src
static java.lang.String	MEDIA_TYPE MEDIA attribute, value: type
static java.lang.String	TIMING_BEGIN TIMING attribute, value: begin
static java.lang.String	TIMING_DUR TIMING attribute, value: dur
static java.lang.String	TIMING_END TIMING attribute, value: end
static java.lang.String	TIMING_ENDSYNC TIMING attribute, value: endsync
static java.lang.String	TIMING_FILL TIMING attribute, value: fill
static java.lang.String	TIMING_MAX TIMING attribute, value: max
static java.lang.String	TIMING_MIN TIMING attribute, value: min
static java.lang.String	TIMING_REPEAT_COUNT TIMING attribute, value: repeatCount
static java.lang.String	TIMING_REPEAT_DUR TIMING attribute, value: repeatDur

Method Summary

Element	addAttribute(java.lang.String name, java.lang.String value) Add an attribute to the Element.
java.util.List	getElements() Returns an Iterator of child Elements, which are instances of the Media class.
java.lang.String	toXML() Returns a String representation of the element with all its children and attributes.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TIMING_BEGIN

public static final java.lang.String TIMING_BEGIN

TIMING attribute, value: begin

See Also:

Constant Field Values

TIMING_END

public static final java.lang.String TIMING_END

TIMING attribute, value: end

See Also:

Constant Field Values

TIMING_DUR

public static final java.lang.String TIMING_DUR

TIMING attribute, value: dur

See Also:

Constant Field Values

TIMING_REPEAT_DUR

public static final java.lang.String TIMING_REPEAT_DUR

TIMING attribute, value: repeatDur

See Also:

Constant Field Values

TIMING_REPEAT_COUNT

public static final java.lang.String TIMING_REPEAT_COUNT

TIMING attribute, value: repeatCount

See Also:

Constant Field Values

TIMING_MAX

public static final java.lang.String TIMING_MAX

TIMING attribute, value: max

See Also:

Constant Field Values

TIMING_MIN

public static final java.lang.String TIMING_MIN

TIMING attribute, value: min

See Also:

Constant Field Values

TIMING_FILL

public static final java.lang.String TIMING_FILL

TIMING attribute, value: fill

See Also:

Constant Field Values

TIMING_ENDSYNC

public static final java.lang.String TIMING_ENDSYNC

TIMING attribute, value: endsync

See Also:

Constant Field Values

CONTCTRL_BITRATE

public static final java.lang.String CONTCTRL_BITRATE

CONTROL attribute, value: systemBitrate

See Also:

Constant Field Values

CONTCTRL_CAPTIONS

public static final java.lang.String CONTCTRL_CAPTIONS

CONTROL attribute, value: systemCaptions

See Also:

Constant Field Values

CONTCTRL_LANGUAGE

public static final java.lang.String CONTCTRL_LANGUAGE

CONTROL attribute, value: systemLanguage

See Also:

Constant Field Values

CONTCTRL_REQUIRED

public static final java.lang.String CONTCTRL_REQUIRED

CONTROL attribute, value: systemRequired

See Also:

Constant Field Values

CONTCTRL_SCREEN_SIZE

public static final java.lang.String CONTCTRL_SCREEN_SIZE

CONTROL attribute, value: systemScreenSize

See Also:

Constant Field Values

CONTCTRL_SCREEN_DEPTH

public static final java.lang.String CONTCTRL_SCREEN_DEPTH

CONTROL attribute, value: systemScreenDepth

See Also:

Constant Field Values

CONTCTRL_OVERDUB_OR_SUBTITLE

public static final java.lang.String CONTCTRL_OVERDUB_OR_SUBTITLE

CONTROL attribute, value: systemOverdubOrSubtitle

See Also:

Constant Field Values

CONTCTRL_AUDIO_DESC

public static final java.lang.String CONTCTRL_AUDIO_DESC

CONTROL attribute, value: systemOverdubOrSubtitle

See Also:

Constant Field Values

CONTCTRL_OPERATING_SYSTEM

public static final java.lang.String CONTCTRL_OPERATING_SYSTEM

CONTROL attribute, value: systemOperatingSystem

See Also:

Constant Field Values

CONTCTRL_CPU

public static final java.lang.String CONTCTRL_CPU

CONTROL attribute, value: systemCPU

See Also:

Constant Field Values

CONTCTRL_COMPONENT

public static final java.lang.String CONTCTRL_COMPONENT

CONTROL attribute, value: systemComponent

See Also:

Constant Field Values

COMMON_ID

public static final java.lang.String COMMON_ID

COMMON attribute, value: id

See Also:

Constant Field Values

COMMON_CLASS

public static final java.lang.String COMMON_CLASS

COMMON attribute, value: class

See Also:

Constant Field Values

COMMON_XML_LANG

public static final java.lang.String COMMON_XML_LANG

COMMON attribute, value: xml:lang

See Also:

Constant Field Values

COMMON_TITLE

public static final java.lang.String COMMON_TITLE

COMMON attribute, value: title

See Also:

Constant Field Values

MEDIA_SRC

public static final java.lang.String MEDIA_SRC

MEDIA attribute, value: src

See Also:

Constant Field Values

MEDIA_TYPE

public static final java.lang.String MEDIA_TYPE

MEDIA attribute, value: type

See Also:

Constant Field Values

LINKING_HREF

public static final java.lang.String LINKING_HREF

LINKING attribute, value: href

See Also:

Constant Field Values

LINKING_SRC_LEVEL

public static final java.lang.String LINKING_SRC_LEVEL

LINKING attribute, value: sourceLevel

See Also:

Constant Field Values

LINKING_DEST_LEVEL

public static final java.lang.String LINKING_DEST_LEVEL

LINKING attribute, value: destinationLevel

See Also:

Constant Field Values

LINKING_SRC_PLAYSTATE

public static final java.lang.String LINKING_SRC_PLAYSTATE

LINKING attribute, value: sourcePlaystate

See Also:

Constant Field Values

LINKING_DEST_PLAYSTATE

public static final java.lang.String LINKING_DEST_PLAYSTATE

LINKING attribute, value: destinationPlaystate

See Also:

Constant Field Values

LINKING_SHOW

public static final java.lang.String LINKING_SHOW

LINKING attribute, value: show

See Also:

Constant Field Values

LINKING_ACCESSKEY

public static final java.lang.String LINKING_ACCESSKEY

LINKING attribute, value: accesskey

See Also:

Constant Field Values

LINKING_TABINDEX

public static final java.lang.String LINKING_TABINDEX

LINKING attribute, value: tabindex

See Also:

Constant Field Values

LINKING_TARGET

public static final java.lang.String LINKING_TARGET

LINKING attribute, value: target

See Also:

Constant Field Values

LINKING_EXTERNAL

public static final java.lang.String LINKING_EXTERNAL

LINKING attribute, value: external

See Also:

Constant Field Values

LINKING_ACTUATE

public static final java.lang.String LINKING_ACTUATE

LINKING attribute, value: external

See Also:

Constant Field Values

LINKING_ALT

public static final java.lang.String LINKING_ALT

LINKING attribute, value: alt

See Also:

Constant Field Values

Method Detail

getElements

public java.util.List getElements()

Returns an Iterator of child Elements, which are instances of the Media class.

addAttribute

public Element addAttribute(java.lang.String name,
                            java.lang.String value)
                     throws java.lang.IllegalArgumentException

Add an attribute to the Element.

Parameters:

name - the name of the attribute

value - the value of the attribute

Returns:

this Element

Throws:

java.lang.IllegalArgumentException - if the attribute is not valid for the element.

toXML

public java.lang.String toXML()

Returns a String representation of the element with all its children and attributes.