|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.jpublish.Page
A representation of a single web page. A page is defined by an XML document in the pages directory. Each page has a template associated with the page and can have 0 or more actions attached to the page.
Actions attached to a page will be triggered each time the page is requested. Actions will be triggered in the order that they are listed within the Page's configuration.
Fields inherited from interface org.jpublish.XMLConstants |
NS, NS_PREFIX, NS_URL |
Constructor Summary | |
Page(SiteContext siteContext,
java.lang.String path,
java.lang.String pageName,
java.lang.String pageType)
Construct a new Page for the given path. |
Method Summary | |
java.lang.String |
executeActions(org.apache.velocity.VelocityContext context)
Execute the page actions using the given VelocityContext. |
java.util.Map |
getEJBs()
Get a Map of EJBHome interfaces. |
java.util.Map |
getExposedEJBs()
Get a Map of EJB Session beans which are exposed on the page directly. |
java.lang.String |
getFullTemplateName()
Get the full template file name, with the .suffix attached. |
java.util.List |
getPageActions()
Get a List of page actions. |
java.lang.String |
getPageName()
Get the page name. |
java.lang.String |
getPageType()
Get the page type. |
java.lang.String |
getPath()
Get the request path. |
java.lang.String |
getTemplateName()
Get the template name. |
java.lang.String |
getTitle()
Return the page title. |
void |
load(java.io.InputStream in)
Load the page configuration from the page's XML stream. |
void |
setTemplateName(java.lang.String templateName)
Set the template name. |
void |
setTitle(java.lang.String title)
Set the title. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Page(SiteContext siteContext, java.lang.String path, java.lang.String pageName, java.lang.String pageType)
siteContext
- The SiteContextpath
- The request pathpageName
- The name of the pagepageType
- The page typeMethod Detail |
public java.lang.String getPath()
public java.lang.String getPageName()
public java.lang.String getPageType()
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
title
- The page titlepublic java.lang.String getFullTemplateName()
public java.lang.String getTemplateName()
public void setTemplateName(java.lang.String templateName)
templateName
- The new template name or null to resetpublic java.util.List getPageActions()
public java.util.Map getEJBs()
public java.util.Map getExposedEJBs()
public java.lang.String executeActions(org.apache.velocity.VelocityContext context) throws java.lang.Exception
context
- The VelocityContextjava.lang.Exception
- Any Exception which occurs while executing the actionpublic void load(java.io.InputStream in) throws java.lang.Exception
in
- The InputStreamjava.lang.Exception
- Any exception
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |