christophedelory.playlist.smil
Class TopLayout

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

public class TopLayout
extends RootLayout

Determines the size of the window in which the SMIL presentation is rendered, as well as serving as a top level window in which to place child region elements.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

TopLayout()

Method Summary

void	addRegion(Region region) Adds a region to this top layout.
String	getClose() Specifies when the top level window should be closed.
String	getOpen() Specifies when the top level window should be opened.
List<Region>	getRegions() Returns the list of regions defined in this top layout.
void	setClose(String close) Specifies when the top level window should be closed.
void	setOpen(String open) Specifies when the top level window should be opened.

Methods inherited from class christophedelory.playlist.smil.RootLayout

acceptDown, getBackgroundColor, getBackgroundImage, getHeightString, getSkipContent, getWidthString, isSkipContent, setBackgroundColor, setBackgroundImage, setHeight, setHeightString, setSkipContent, setWidth, setWidthString

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

TopLayout

public TopLayout()

Method Detail

getClose

public String getClose()

Specifies when the top level window should be closed. Could be equal to onRequest, whenActive.

Returns:

the close condition as a string. May be null.

See Also:

setClose(java.lang.String)

setClose

public void setClose(String close)

Specifies when the top level window should be closed.

Parameters:

close - the close condition. May be null.

See Also:

getClose()

getOpen

public String getOpen()

Specifies when the top level window should be opened. Could be equal to onStart, whenActive.

Returns:

the open condition as a string. May be null.

See Also:

setOpen(java.lang.String)

setOpen

public void setOpen(String open)

Specifies when the top level window should be opened.

Parameters:

open - the open condition as a string. May be null.

See Also:

getOpen()

getRegions

public List<Region> getRegions()

Returns the list of regions defined in this top layout.

Returns:

a list of regions. May be empty but not null.

See Also:

addRegion(christophedelory.playlist.smil.Region)

addRegion

public void addRegion(Region region)

Adds a region to this top layout.

Parameters:

region - a region. Shall not be null.

Throws:

NullPointerException - if region is null.

See Also:

getRegions()