christophedelory.playlist.smil
Class Layout

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

public class Layout
extends Core

Defines a collection of rendering regions that determine how the elements in the document's body are positioned on an abstract rendering surface.

Version:

$Revision: 92 $

Author:

Christophe Delory

Constructor Summary

Layout()

Method Summary

void	acceptDown(SmilVisitor visitor) Accepts the specified SMIL playlist visitor.
void	addRegion(Region region) Adds a region to this layout.
void	addRegistrationPoint(RegistrationPoint regPoint) Adds a registration point to this layout.
void	addTopLayout(TopLayout topLayout) Adds the specified top layout to this layout.
Region	findRegionById(String regionId) Returns the first region found with the specified identifier.
List<Region>	getRegions() Returns the list of regions defined in this layout.
List<RegistrationPoint>	getRegistrationPoints() Returns the list of registration points defined in this layout.
RootLayout	getRootLayout() Returns the root layout defined in this layout.
List<TopLayout>	getTopLayouts() Returns the list of top layouts defined in this layout.
String	getType() Returns the type of layout language which is used in the layout element.
void	setRootLayout(RootLayout rootLayout) Initializes the root layout associated to this layout.
void	setType(String type) Initializes the type of layout language which is used in the layout element.

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

Layout

public Layout()

Method Detail

getTopLayouts

public List<TopLayout> getTopLayouts()

Returns the list of top layouts defined in this layout.

Returns:

a list of top layouts. May be empty but not null.

See Also:

addTopLayout(christophedelory.playlist.smil.TopLayout)

addTopLayout

public void addTopLayout(TopLayout topLayout)

Adds the specified top layout to this layout.

Parameters:

topLayout - a top layout. Shall not be null.

Throws:

NullPointerException - if topLayout is null.

See Also:

getTopLayouts()

getRootLayout

public RootLayout getRootLayout()

Returns the root layout defined in this layout.

Returns:

a root layout. May be null.

See Also:

setRootLayout(christophedelory.playlist.smil.RootLayout)

setRootLayout

public void setRootLayout(RootLayout rootLayout)

Initializes the root layout associated to this layout.

Parameters:

rootLayout - a root layout. May be null.

See Also:

getRootLayout()

getRegions

public List<Region> getRegions()

Returns the list of regions defined in this 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 layout.

Parameters:

region - a region. Shall not be null.

Throws:

NullPointerException - if region is null.

See Also:

getRegions()

findRegionById

public Region findRegionById(String regionId)

Returns the first region found with the specified identifier.

Parameters:

regionId - the region identifier. Shall not be null.

Returns:

a region, or null if none is found.

Throws:

NullPointerException - if regionId is null.

See Also:

Core.getId()

getRegistrationPoints

public List<RegistrationPoint> getRegistrationPoints()

Returns the list of registration points defined in this layout.

Returns:

a list of registration points. May be empty but not null.

See Also:

addRegistrationPoint(christophedelory.playlist.smil.RegistrationPoint)

addRegistrationPoint

public void addRegistrationPoint(RegistrationPoint regPoint)

Adds a registration point to this layout.

Parameters:

regPoint - a registration point. Shall not be null.

Throws:

NullPointerException - if regPoint is null.

See Also:

getRegistrationPoints()

getType

public String getType()

Returns the type of layout language which is used in the layout element. The default value is "text/smil-basic-layout". If the type value equals "text/smil-basic-layout", it may contain the rootLayout and region elements.

Returns:

the type of layout language. May be null.

See Also:

setType(java.lang.String)

setType

public void setType(String type)

Initializes the type of layout language which is used in the layout element.

Parameters:

type - the type of layout language. May be null.

See Also:

getType()

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.