PageDefinition Class
- public class PageDefinition
extends Object
implements NavigableDefinition
, Serializable
This class represents a persistant page.
-
Hierarchy
-
Object
PageDefinition
-
All Implemented Interfaces
-
NavigableDefinition
, Serializable
-
PageDefinition(
LocalizationResource localizationResource, MarkupDefinitionId markupDefinitionId, String definitionLabel, boolean hidden, boolean _public, String webAppName, LayoutDefinitionId layoutDefinitionId, ThemeDefinitionId themeDefinitionId)
- Constructors to create a new
PageDefinition object.
|
-
PageDefinition(
LocalizationResource localizationResource, MarkupDefinitionId markupDefinitionId, String definitionLabel, boolean hidden, boolean _public, String webAppName, PageInstance pageInstance)
- Constructor that takes a
PageInstance .
|
pageInstance
protected PageInstance
pageInstance
PageDefinition
public PageDefinition(LocalizationResource
localizationResource,
MarkupDefinitionId
markupDefinitionId,
String
definitionLabel,
boolean hidden,
boolean _public,
String
webAppName,
LayoutDefinitionId
layoutDefinitionId,
ThemeDefinitionId
themeDefinitionId)
- Constructors to create a new
PageDefinition
object.
PageDefinition
protected PageDefinition(LocalizationResource
localizationResource,
MarkupDefinitionId
markupDefinitionId,
String
definitionLabel,
boolean hidden,
boolean _public,
String
webAppName,
PageInstance
pageInstance)
- Constructor that takes a
PageInstance
.
getDefinitionLabel() Method
public String
getDefinitionLabel()
Returns the definitionLabel associated with this page.
Returns
- definitionLabel for this page
getDescription() Method
public String
getDescription()
Retrieves this page's localized description
from it's LocalizationResource
.
Returns
- localized description for this page
getLayoutDefinitionId() Method
public LayoutDefinitionId
getLayoutDefinitionId()
Returns LayoutDefinitionId
for menu associated with this
LayoutDefinition
Returns
LayoutDefinitionId
getLocalizationIntersectionId() Method
public LocalizationIntersectionId
getLocalizationIntersectionId()
Returns the LocalizationIntersectionId
for this page.
Returns NULL
if no LocalizationResource is associated with
this page. A LocalizationIntersectionId
is a reference to all
localized versions of title and description for an entity.
Returns
LocalizationIntersectionId
for this page
getLocalizationResource() Method
public LocalizationResource
getLocalizationResource()
Returns the LocalizationResource
associated with this
PageDefinition
based on the locale of the request used
for retrieving the PageDefinition
.
Returns
LocalizationResource
associated with this page
getMarkupDefinitionId() Method
public MarkupDefinitionId
getMarkupDefinitionId()
Returns the MarkupDefinitionId
for the MarkupDefinition
associated with this page.
Returns
MarkupDefinitionId
Related Topics
MarkupDefinition
getNavigableDefinitionId() Method
public NavigableDefinitionId
getNavigableDefinitionId()
Returns the NavigableDefinitionId
associated with this page.
Returns NULL
when the PageDefinition has not been retrieved
by using the persistence API.
Returns
NaviagableDefinitionId
associated with this page
Related Topics
NavigableDefinition
getPageDefinitionId() Method
public PageDefinitionId
getPageDefinitionId()
Returns the PageDefinitionId
for this page.
Returns NULL
when the PageDefinition has not been retrieved
by using the persistence API.
Returns
PageDefinitionId
for this page
getPrimaryInstanceId() Method
public PageInstanceId
getPrimaryInstanceId()
Returns the BookInstanceId
for the primary
page instance associated with this page.
Returns
- BookInstanceId
getThemeDefinitionId() Method
public ThemeDefinitionId
getThemeDefinitionId()
Returns the ThemeDefinitionId
of theme associated with this
PageDefinition
.
Returns
ThemeDefinitionId
getTitle() Method
public String
getTitle()
Retrieves this page's localized title
from it's LocalizationResource
.
Returns
- localized title for this page
getWebAppName() Method
public String
getWebAppName()
Returns the name of the J2EE web application this page
is scoped to.
Returns
- name of web application
isHidden() Method
public boolean isHidden()
Returns true if this page is configured to not
be rendered.
Returns
- true if
PageDefinition
is hidden
isPublic() Method
public boolean isPublic()
Returns whether this page is end-user created.
Returns
- true if this page is end-user created.
setDefinitionLabel(String) Method
public void setDefinitionLabel(String
definitionLabel)
Sets the definitionLabel for this page.
setHidden(boolean) Method
public void setHidden(boolean hidden)
Sets whether or not this page renders.
Parameters
-
hidden
- configures this page to not
render if set to true
setLayoutDefinitionId(LayoutDefinitionId) Method
public void setLayoutDefinitionId(LayoutDefinitionId
layoutDefinitionId)
Associates a layout with this page.
Parameters
-
layoutDefinitionId
- of menu associated with this page
setLocalizationResource(LocalizationResource) Method
public void setLocalizationResource(LocalizationResource
localizationResource)
Sets the LocalizationResource
for this page.
setMarkupDefinitionId(MarkupDefinitionId) Method
public void setMarkupDefinitionId(MarkupDefinitionId
markupDefinitionId)
Sets the MarkupDefinitionId
for this page.
setPublic(boolean) Method
public void setPublic(boolean _public)
Sets whether this page is end-user created.
setThemeDefinitionId(ThemeDefinitionId) Method
public void setThemeDefinitionId(ThemeDefinitionId
themeDefinitionId)
Associates a theme with this page.
Parameters
-
themeDefinitionId
- of theme associated with this page
setWebAppName(String) Method
public void setWebAppName(String
webAppName)
Scopes this page to specified J2EE web application
Parameters
-
webAppName
- name of the web application to scope this page to
toString() Method
public String
toString()
-
Overrides
-
Object.toString()