christophedelory.playlist.smil
Class RootLayout

java.lang.Object
  christophedelory.playlist.smil.Core
      christophedelory.playlist.smil.RootLayout

Direct Known Subclasses:

TopLayout

public class RootLayout
extends Core

The root layout determines the value of the layout properties of the root element, which in turn determines the size of the window in which the SMIL presentation is rendered.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

RootLayout()

Method Summary

void	acceptDown(SmilVisitor visitor) Accepts the specified SMIL playlist visitor.
String	getBackgroundColor() Returns the background color used to fill the area of a region displaying media that is not filled by the media.
String	getBackgroundImage() Returns the background image as a string.
String	getHeightString() Returns the height of this root layout as a string.
Boolean	getSkipContent() Checks if the content may be skipped or not.
String	getWidthString() Returns the width of this root layout as a string.
boolean	isSkipContent() Checks if the content may be skipped or not.
void	setBackgroundColor(String color) Initializes the background color.
void	setBackgroundImage(String image) Initializes the background image as a string.
void	setHeight(int height) Initializes the height of this root layout as an integer.
void	setHeightString(String height) Initializes the height of this root layout as a string.
void	setSkipContent(Boolean skipContent) Specifies if the content may be skipped or not.
void	setWidth(int width) Initializes the width of this root layout as an integer.
void	setWidthString(String width) Initializes the width of this root layout as a string.

Methods inherited from class christophedelory.playlist.smil.Core

getClassName, getId, getLang, getTitle, setClassName, setId, setLang, setTitle

Methods inherited from class java.lang.Object

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

Constructor Detail

RootLayout

public RootLayout()

Method Detail

getBackgroundColor

public String getBackgroundColor()

Returns the background color used to fill the area of a region displaying media that is not filled by the media.

Returns:

the background color. May be null.

See Also:

setBackgroundColor(java.lang.String)

setBackgroundColor

public void setBackgroundColor(String color)

Initializes the background color.

Parameters:

color - the background color. May be null.

See Also:

getBackgroundColor()

getBackgroundImage

public String getBackgroundImage()

Returns the background image as a string. The attribute may be used to specify an image that may be placed as the background of a region. Default value is none.

Returns:

the background image as a string. May be null.

See Also:

setBackgroundImage(java.lang.String)

setBackgroundImage

public void setBackgroundImage(String image)

Initializes the background image as a string.

Parameters:

image - the background image. May be null.

See Also:

getBackgroundImage()

getHeightString

public String getHeightString()

Returns the height of this root layout as a string. The use and definition of this attribute are identical to the "height" property in the CSS2 specification.

Returns:

a height. May be null.

See Also:

setHeightString(java.lang.String)

setHeightString

public void setHeightString(String height)

Initializes the height of this root layout as a string.

Parameters:

height - a height. May be null.

See Also:

getHeightString(), setHeight(int)

setHeight

public void setHeight(int height)

Initializes the height of this root layout as an integer.

Parameters:

height - a height.

See Also:

setHeightString(java.lang.String)

getWidthString

public String getWidthString()

Returns the width of this root layout as a string. The use and definition of this attribute are identical to the "width" property in the CSS2 specification.

Returns:

a width. May be null.

See Also:

setWidthString(java.lang.String)

setWidthString

public void setWidthString(String width)

Initializes the width of this root layout as a string.

Parameters:

width - a width. May be null.

See Also:

getWidthString(), setWidth(int)

setWidth

public void setWidth(int width)

Initializes the width of this root layout as an integer.

Parameters:

width - a width.

See Also:

setWidthString(java.lang.String)

isSkipContent

public boolean isSkipContent()

Checks if the content may be skipped or not.

Returns:

the associated boolean.

See Also:

getSkipContent()

getSkipContent

public Boolean getSkipContent()

Checks if the content may be skipped or not. The skip content controls whether the content of an element is evaluated or should be skipped.

Returns:

the associated boolean. May be null.

See Also:

setSkipContent(java.lang.Boolean)

setSkipContent

public void setSkipContent(Boolean skipContent)

Specifies if the content may be skipped or not.

Parameters:

skipContent - the associated boolean. May be null.

See Also:

getSkipContent()

acceptDown

public void acceptDown(SmilVisitor visitor)

Accepts the specified SMIL playlist visitor.

Parameters:

visitor - a SMIL playlist visitor. Shall not be null.

Throws:

NullPointerException - if visitor is null.