public interface Layout
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Modifier and Type | Method and Description |
---|---|
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
|
static final java.lang.String CLASS_VERSION
java.lang.String getId()
java.lang.String getName()
void setName(java.lang.String pName)
a
- namejava.lang.String getDescription()
void setDescription(java.lang.String pDescription)
a
- descriptionjava.util.Date getCreationDate()
java.util.Date getLastModified()
java.lang.String getAuthor()
void setAuthor(java.lang.String pAuthor)
a
- authorjava.lang.String getVersion()
void setVersion(java.lang.String pVersion)
a
- versionjava.lang.String getSmallImageURL()
java.lang.String getLargeImageURL()
void setImage(java.lang.String pProperty, java.lang.String pImageUrl)
an
- image propertyan
- image Urljava.lang.String getServletContext()
void setServletContext(java.lang.String pServletContext)
a
- servlet contextboolean hasDisplayMode(java.lang.String pDisplayMode)
pDisplayMode
- the name of a display modeDisplayMode getDisplayMode(java.lang.String pDisplayMode)
pDisplayMode
- the name of a display modeDisplayMode[] getDisplayModes()
void setDisplayModes(DisplayMode pDisplayModes)
a
- displayModesboolean hasRegionDefinition(java.lang.String pName)
pName
- the name of a regionRegionDefinition getRegionDefinition(java.lang.String pName)
pName
- the name of a regionRegionDefinition[] getRegionDefinitions()
java.util.Set getRegionDefinitionSet()
void setRegionDefinitions(java.util.Collection pRegionDefinitions)
a
- region definition list