com.objectxp.mms.message.smil
Class Region

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

public class Region

extends Element

A class representing the SMIL "region" element. The region element controls the position, size and scaling of media object elements.

Since:

jSMS 2.0

Field Summary

static java.lang.String	BACKGROUND_COLOR attribute, value: backgroundColor
static java.lang.String	BOTTOM attribute, value: bottom
static java.lang.String	FIT attribute, value: fit
static java.lang.String	HEIGHT attribute, value: height
static java.lang.String	LEFT attribute, value: left
static java.lang.String	REGION_NAME attribute, value: regionName
static java.lang.String	RIGHT attribute, value: right
static java.lang.String	SHOW_BACKGROUND attribute, value: showBackground
static java.lang.String	SKIP_CONTENT attribute, value: skip-content
static java.lang.String	TOP attribute, value: top
static java.lang.String	WIDTH attribute, value: width
static java.lang.String	Z_INDEX attribute, value: z-index

Fields inherited from class com.objectxp.mms.message.smil.Element

COMMON_CLASS, COMMON_ID, COMMON_TITLE, COMMON_XML_LANG, 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, 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, MEDIA_SRC, MEDIA_TYPE, TIMING_BEGIN, TIMING_DUR, TIMING_END, TIMING_ENDSYNC, TIMING_FILL, TIMING_MAX, TIMING_MIN, TIMING_REPEAT_COUNT, TIMING_REPEAT_DUR

Constructor Summary

Region()
Construct a new Region.

Method Summary

Element

addAttribute(java.lang.String name, java.lang.String value) Add an attribute for this region element.

Methods inherited from class com.objectxp.mms.message.smil.Element

getElements, toXML

Methods inherited from class java.lang.Object

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

Field Detail

BACKGROUND_COLOR

public static final java.lang.String BACKGROUND_COLOR

attribute, value: backgroundColor

See Also:

Constant Field Values

BOTTOM

public static final java.lang.String BOTTOM

attribute, value: bottom

See Also:

Constant Field Values

FIT

public static final java.lang.String FIT

attribute, value: fit

See Also:

Constant Field Values

HEIGHT

public static final java.lang.String HEIGHT

attribute, value: height

See Also:

Constant Field Values

LEFT

public static final java.lang.String LEFT

attribute, value: left

See Also:

Constant Field Values

RIGHT

public static final java.lang.String RIGHT

attribute, value: right

See Also:

Constant Field Values

SHOW_BACKGROUND

public static final java.lang.String SHOW_BACKGROUND

attribute, value: showBackground

See Also:

Constant Field Values

TOP

public static final java.lang.String TOP

attribute, value: top

See Also:

Constant Field Values

WIDTH

public static final java.lang.String WIDTH

attribute, value: width

See Also:

Constant Field Values

Z_INDEX

public static final java.lang.String Z_INDEX

attribute, value: z-index

See Also:

Constant Field Values

SKIP_CONTENT

public static final java.lang.String SKIP_CONTENT

attribute, value: skip-content

See Also:

Constant Field Values

REGION_NAME

public static final java.lang.String REGION_NAME

attribute, value: regionName

See Also:

Constant Field Values

Constructor Detail

Region

public Region()

Construct a new Region.

Method Detail

addAttribute

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

Add an attribute for this region element. Attributes allowed are:

• COMMON attributes
• BACKGROUND_COLOR
• BOTTOM
• FIT
• HEIGHT
• LEFT
• RIGHT
• SHOW_BACKGROUND
• TOP
• WIDTH
• Z_INDEX
• SKIP_CONTENT
• REGION_NAME

Overrides:

addAttribute in class Element

Parameters:

name - the attribute name

value - the attribute value

Returns:

this Element

Throws:

java.lang.IllegalArgumentException - for invalid attributes