org.sakaiproject.portal.xsltcharon.impl

Class XsltRenderContext

java.lang.Object

org.sakaiproject.portal.xsltcharon.impl.XsltRenderContext

All Implemented Interfaces:

org.sakaiproject.portal.api.PortalRenderContext

public class XsltRenderContext
extends Object
implements org.sakaiproject.portal.api.PortalRenderContext

Created by IntelliJ IDEA. User: johnellis Date: Jul 13, 2007 Time: 12:07:00 PM To change this template use File | Settings | File Templates.

Constructor Summary

Constructors

Constructor and Description
XsltRenderContext(org.sakaiproject.portal.api.PortalRenderEngine renderEngine, org.sakaiproject.portal.api.PortalRenderContext baseContext, HttpServletRequest request)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addExtraConfig(Element config)
protected void	appendTextElementNode(Document doc, String name, String text, Element parent)
protected void	appendTextElementNodeFromProp(Document doc, String nodeName, String propName, Element parent)
protected void	appendTextElementNodes(Document doc, String[] strings, Element parent, String topNodeName, String nodeName)
protected Element	createCategory(Document doc, Element categories, Map page, String name, int index)
protected Element	createColumnToolsXml(Document doc, List tools, Map page)
protected Element	createConfixXml(Document doc, boolean loggedIn, Map sitePages)
protected Element	createExternalizedEntryXml(Document doc, Object key, Object value)
protected Element	createExternalizedXml(Document doc)
protected Element	createLoginXml(Document doc, HttpServletRequest req)
protected Element	createPageCategories(Document doc, List pageTools)
protected Element	createPageXml(Document doc, Map page)
protected Element	createPoweredByXml(Document doc, String text, String image, String url)
protected Element	createSite(Document doc, Map siteMap, int index)
protected Element	createSitePages(Document doc, List<Map<String,?>> navPages)
protected Element	createSites(Document doc)
protected Element	createSitesList(Document doc, Map currentContext, String prop, String elementName)
protected Map	createSiteTypesMap()
protected Element	createSkin(Document doc)
protected Element	createTermSites(Document doc, Map tabSites)
protected Element	createToolXml(Document doc, Map tool, Map page)
protected Element	createUncategorizedPage(Document doc, Map page, int index)
protected Element	createUserXml(Document doc, org.sakaiproject.user.api.User current)
String	dump()
protected void	dumpDocument(Node node)
Object	get(String key)
String	getAlternateTemplate()
org.sakaiproject.portal.api.PortalRenderContext	getBaseContext()
protected String[]	getListAsStringArray(String key)
org.sakaiproject.portal.api.PortalRenderEngine	getRenderEngine() Get the render engine associated with this context.
boolean	isDisplayToolCategories()
Document	produceDocument()
void	put(String string, Object value)
protected void	safeAppendTextNode(Document doc, Element element, String text, boolean cdata)
void	setBaseContext(org.sakaiproject.portal.api.PortalRenderContext baseContext)
boolean	uses(String includeOption)

Methods inherited from class java.lang.Object

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

Constructor Detail

XsltRenderContext

public XsltRenderContext(org.sakaiproject.portal.api.PortalRenderEngine renderEngine,
                 org.sakaiproject.portal.api.PortalRenderContext baseContext,
                 HttpServletRequest request)

Method Detail

put

public void put(String string,
       Object value)

Specified by:

put in interface org.sakaiproject.portal.api.PortalRenderContext

get

public Object get(String key)

dump

public String dump()

Specified by:

dump in interface org.sakaiproject.portal.api.PortalRenderContext

uses

public boolean uses(String includeOption)

Specified by:

uses in interface org.sakaiproject.portal.api.PortalRenderContext

getRenderEngine

public org.sakaiproject.portal.api.PortalRenderEngine getRenderEngine()

Get the render engine associated with this context.

Specified by:

getRenderEngine in interface org.sakaiproject.portal.api.PortalRenderContext

Returns:

the render engine

getBaseContext

public org.sakaiproject.portal.api.PortalRenderContext getBaseContext()

setBaseContext

public void setBaseContext(org.sakaiproject.portal.api.PortalRenderContext baseContext)

produceDocument

public Document produceDocument()

createExternalizedXml

protected Element createExternalizedXml(Document doc)

createExternalizedEntryXml

protected Element createExternalizedEntryXml(Document doc,
                                 Object key,
                                 Object value)

createSites

protected Element createSites(Document doc)

createTermSites

protected Element createTermSites(Document doc,
                      Map tabSites)

createSitesList

protected Element createSitesList(Document doc,
                      Map currentContext,
                      String prop,
                      String elementName)

createSite

protected Element createSite(Document doc,
                 Map siteMap,
                 int index)

createSitePages

protected Element createSitePages(Document doc,
                      List<Map<String,?>> navPages)

createPageCategories

protected Element createPageCategories(Document doc,
                           List pageTools)
                                throws org.sakaiproject.portal.render.api.ToolRenderException

Throws:

org.sakaiproject.portal.render.api.ToolRenderException

createCategory

protected Element createCategory(Document doc,
                     Element categories,
                     Map page,
                     String name,
                     int index)

createUncategorizedPage

protected Element createUncategorizedPage(Document doc,
                              Map page,
                              int index)
                                   throws org.sakaiproject.portal.render.api.ToolRenderException

Throws:

org.sakaiproject.portal.render.api.ToolRenderException

createPageXml

protected Element createPageXml(Document doc,
                    Map page)
                         throws org.sakaiproject.portal.render.api.ToolRenderException

Throws:

org.sakaiproject.portal.render.api.ToolRenderException

createColumnToolsXml

protected Element createColumnToolsXml(Document doc,
                           List tools,
                           Map page)
                                throws org.sakaiproject.portal.render.api.ToolRenderException

Throws:

org.sakaiproject.portal.render.api.ToolRenderException

createToolXml

protected Element createToolXml(Document doc,
                    Map tool,
                    Map page)
                         throws org.sakaiproject.portal.render.api.ToolRenderException

Throws:

org.sakaiproject.portal.render.api.ToolRenderException

createSiteTypesMap

protected Map createSiteTypesMap()

createConfixXml

protected Element createConfixXml(Document doc,
                      boolean loggedIn,
                      Map sitePages)

addExtraConfig

protected void addExtraConfig(Element config)

createPoweredByXml

protected Element createPoweredByXml(Document doc,
                         String text,
                         String image,
                         String url)

getListAsStringArray

protected String[] getListAsStringArray(String key)

createSkin

protected Element createSkin(Document doc)

createLoginXml

protected Element createLoginXml(Document doc,
                     HttpServletRequest req)

appendTextElementNodeFromProp

protected void appendTextElementNodeFromProp(Document doc,
                                 String nodeName,
                                 String propName,
                                 Element parent)

createUserXml

protected Element createUserXml(Document doc,
                    org.sakaiproject.user.api.User current)

appendTextElementNode

protected void appendTextElementNode(Document doc,
                         String name,
                         String text,
                         Element parent)

safeAppendTextNode

protected void safeAppendTextNode(Document doc,
                      Element element,
                      String text,
                      boolean cdata)

dumpDocument

protected void dumpDocument(Node node)

appendTextElementNodes

protected void appendTextElementNodes(Document doc,
                          String[] strings,
                          Element parent,
                          String topNodeName,
                          String nodeName)

getAlternateTemplate

public String getAlternateTemplate()

isDisplayToolCategories

public boolean isDisplayToolCategories()