atg.portal.framework
Interface Layout

public interface Layout

Represents a layout

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Method Summary

java.lang.String	getAuthor() Access the author
java.util.Date	getCreationDate() Access the creation date of the layout
java.lang.String	getDescription() Access the description of the layout
DisplayMode	getDisplayMode(java.lang.String pDisplayMode) Access a named display mode from the layout
DisplayMode[]	getDisplayModes() Access all display modes
java.lang.String	getId() Access the id of the layout
java.lang.String	getLargeImageURL() Access the large image URL
java.util.Date	getLastModified() Access the last modified date of the layout
java.lang.String	getName() Access the name of the layout
RegionDefinition	getRegionDefinition(java.lang.String pName) Access a named region definition
RegionDefinition[]	getRegionDefinitions() Deprecated.
java.util.Set	getRegionDefinitionSet() Access the region definitions
java.lang.String	getServletContext() Access the servlet context
java.lang.String	getSmallImageURL() Access the small image URL
java.lang.String	getVersion() Access the version
boolean	hasDisplayMode(java.lang.String pDisplayMode) Returns true if this layout has a particuar display mode
boolean	hasRegionDefinition(java.lang.String pName) Returns true if this layout has a particular region definition
void	setAuthor(java.lang.String pAuthor) Set the author of the layout
void	setDescription(java.lang.String pDescription) Set the description of the layout
void	setDisplayModes(DisplayMode pDisplayModes) Set the display modes property
void	setImage(java.lang.String pProperty, java.lang.String pImageUrl) Set the image property passed of the layout
void	setName(java.lang.String pName) Set the name of the layout
void	setRegionDefinitions(java.util.Collection pRegionDefinitions) Set the region definition property
void	setServletContext(java.lang.String pServletContext) Set the servlet context of the page template
void	setVersion(java.lang.String pVersion) Set the version of the layout

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Access the id of the layout

Returns:

an id

getName

java.lang.String getName()

Access the name of the layout

Returns:

a name

setName

void setName(java.lang.String pName)

Set the name of the layout

Parameters:

a - name

getDescription

java.lang.String getDescription()

Access the description of the layout

Returns:

an id

setDescription

void setDescription(java.lang.String pDescription)

Set the description of the layout

Parameters:

a - description

getCreationDate

java.util.Date getCreationDate()

Access the creation date of the layout

Returns:

a date

getLastModified

java.util.Date getLastModified()

Access the last modified date of the layout

Returns:

a date

getAuthor

java.lang.String getAuthor()

Access the author

Returns:

the author

setAuthor

void setAuthor(java.lang.String pAuthor)

Set the author of the layout

Parameters:

a - author

getVersion

java.lang.String getVersion()

Access the version

Returns:

the version

setVersion

void setVersion(java.lang.String pVersion)

Set the version of the layout

Parameters:

a - version

getSmallImageURL

java.lang.String getSmallImageURL()

Access the small image URL

Returns:

the small image url

getLargeImageURL

java.lang.String getLargeImageURL()

Access the large image URL

Returns:

the large image url

setImage

void setImage(java.lang.String pProperty,
              java.lang.String pImageUrl)

Set the image property passed of the layout

Parameters:

an - image property

an - image Url

getServletContext

java.lang.String getServletContext()

Access the servlet context

Returns:

the servlet context

setServletContext

void setServletContext(java.lang.String pServletContext)

Set the servlet context of the page template

Parameters:

a - servlet context

hasDisplayMode

boolean hasDisplayMode(java.lang.String pDisplayMode)

Returns true if this layout has a particuar display mode

Parameters:

pDisplayMode - the name of a display mode

Returns:

true if display mode exists, false otherwise

getDisplayMode

DisplayMode getDisplayMode(java.lang.String pDisplayMode)

Access a named display mode from the layout

Parameters:

pDisplayMode - the name of a display mode

Returns:

a display mode

getDisplayModes

DisplayMode[] getDisplayModes()

Access all display modes

Returns:

an array of display modes

setDisplayModes

void setDisplayModes(DisplayMode pDisplayModes)

Set the display modes property

Parameters:

a - displayModes

hasRegionDefinition

boolean hasRegionDefinition(java.lang.String pName)

Returns true if this layout has a particular region definition

Parameters:

pName - the name of a region

Returns:

true if the region definition exists, false otherwise

getRegionDefinition

RegionDefinition getRegionDefinition(java.lang.String pName)

Access a named region definition

Parameters:

pName - the name of a region

Returns:

a region definition

getRegionDefinitions

RegionDefinition[] getRegionDefinitions()

Deprecated.

Access the region definitions

Returns:

an array of region definitions

getRegionDefinitionSet

java.util.Set getRegionDefinitionSet()

Access the region definitions

Returns:

a Set of region definitions

setRegionDefinitions

void setRegionDefinitions(java.util.Collection pRegionDefinitions)

Set the region definition property

Parameters:

a - region definition list