Skip navigation links

oracle.stellent.wcm.core.project.structure
Class PageTemplate

java.lang.Object
oracle.stellent.wcm.core.project.structure.PageTemplate

public class PageTemplate

extends java.lang.Object

Represents a page template which has a pointer to a layout file and a mapping of placeholder names to placeholder definitions.

Field Summary

static java.lang.String

DEFAULT_LAYOUT name of the default layout

Constructor Summary

PageTemplate(PageTemplate pageTemplate)
Copy constructor.

PageTemplate(java.lang.String template)
Constructor

PageTemplate(java.lang.String template, java.util.Map<java.lang.String,Placeholder> placeholders)
Constructor

PageTemplate(java.lang.String template, java.util.Map<java.lang.String,Placeholder> placeholders, java.lang.String query)
Constructor

Method Summary

Placeholder	getPlaceholder(java.lang.String name) Retrieve the content corresponding to the name
java.lang.String	getPlaceholderDefinitionName(java.lang.String placeholderName) Retrieve the placeholder definition name
java.util.Map<java.lang.String,java.lang.String>	getPlaceholderDefinitions() Returns the map of placeholder definitions for modifications.
java.util.Collection<java.lang.String>	getPlaceholderNames()
java.util.Map<java.lang.String,Placeholder>	getPlaceholders() Returns the map of placeholders for modifications.
java.lang.String	getReplaceableRegion()
java.lang.String	getTemplate()
java.lang.String	getUrlParam()
boolean	isLocal()
boolean	isPrimary()
boolean	isSecondary()
void	setPlaceholderDefinitionMap(java.util.Map<java.lang.String,java.lang.String> placeholderDefinitionMap) Set the placeholder configuration map
void	setPrimary(boolean b) Set this as primary if true or secondary if false
void	setReplaceableRegion(java.lang.String replaceableRegion) set the replaceable region
void	setSecondary(boolean b) Set this as secondary if true or primary if false
void	setTemplate(java.lang.String template) Set the layout
void	setUrlParam(java.lang.String urlParam)
java.lang.String	toString() String representation of the layout

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LAYOUT

public static final java.lang.String DEFAULT_LAYOUT

name of the default layout

See Also:

Constant Field Values

Constructor Detail

PageTemplate

public PageTemplate(java.lang.String template)

Constructor

Parameters:

template - the layout name

PageTemplate

public PageTemplate(java.lang.String template,
                    java.util.Map<java.lang.String,Placeholder> placeholders)

Constructor

Parameters:

template - the layout

placeholders - the content map

PageTemplate

public PageTemplate(java.lang.String template,
                    java.util.Map<java.lang.String,Placeholder> placeholders,
                    java.lang.String query)

Constructor

Parameters:

template - the layout

placeholders - the content map

query - the query parameters

PageTemplate

public PageTemplate(PageTemplate pageTemplate)

Copy constructor. Makes a deep copy of the given template.

Parameters:

pageTemplate - the template to copy

Method Detail

isLocal

public boolean isLocal()

Returns:

true if this file is local to the application

getTemplate

public java.lang.String getTemplate()

Returns:

the master layout

setTemplate

public void setTemplate(java.lang.String template)

Set the layout

Parameters:

template - the layout

isSecondary

public boolean isSecondary()

Returns:

true if this is a secondary layout

setSecondary

public void setSecondary(boolean b)

Set this as secondary if true or primary if false

Parameters:

b - boolean

isPrimary

public boolean isPrimary()

Returns:

true if this is a primary layout

setPrimary

public void setPrimary(boolean b)

Set this as primary if true or secondary if false

Parameters:

b - boolean

getReplaceableRegion

public java.lang.String getReplaceableRegion()

Returns:

the name of the replacable region

setReplaceableRegion

public void setReplaceableRegion(java.lang.String replaceableRegion)

set the replaceable region

Parameters:

replaceableRegion - the region name

getPlaceholders

public java.util.Map<java.lang.String,Placeholder> getPlaceholders()

Returns the map of placeholders for modifications.

Returns:

the map of all placeholders

getPlaceholder

public Placeholder getPlaceholder(java.lang.String name)

Retrieve the content corresponding to the name

Parameters:

name - the content name

Returns:

the content for this name or null if its not mapped

getPlaceholderNames

public java.util.Collection<java.lang.String> getPlaceholderNames()

Returns:

the names of all the placeholder names

getPlaceholderDefinitions

public java.util.Map<java.lang.String,java.lang.String> getPlaceholderDefinitions()

Returns the map of placeholder definitions for modifications.

Returns:

the map of all placeholder definitions

getPlaceholderDefinitionName

public java.lang.String getPlaceholderDefinitionName(java.lang.String placeholderName)

Retrieve the placeholder definition name

Parameters:

placeholderName - the placeholder name

Returns:

the mapped value

setPlaceholderDefinitionMap

public void setPlaceholderDefinitionMap(java.util.Map<java.lang.String,java.lang.String> placeholderDefinitionMap)

Set the placeholder configuration map

Parameters:

placeholderDefinitionMap - a mapping of placeholder name to config for this layout

toString

public java.lang.String toString()

String representation of the layout

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getUrlParam

public java.lang.String getUrlParam()

Returns:

the urlParam

setUrlParam

public void setUrlParam(java.lang.String urlParam)

Parameters:

urlParam - the urlParam to set

Skip navigation links