com.liferay.wiki.engine

Class BaseWikiEngine

java.lang.Object

com.liferay.wiki.engine.BaseWikiEngine

All Implemented Interfaces:

WikiEngine

public abstract class BaseWikiEngine
extends java.lang.Object
implements WikiEngine

Constructor Summary

Constructors

Constructor and Description
BaseWikiEngine()

Method Summary

Modifier and Type	Method and Description
java.lang.String	convert(WikiPage page, javax.portlet.PortletURL viewPageURL, javax.portlet.PortletURL editPageURL, java.lang.String attachmentURLPrefix) Returns the content of the given page converted to HTML using the view and edit URLs to build links.
static BaseWikiEngine	getBaseWikiEngine(javax.servlet.ServletRequest servletRequest)
abstract java.lang.String	getEditorName()
protected java.lang.String	getEditPageJSP()
protected abstract javax.servlet.ServletContext	getEditPageServletContext()
java.lang.String	getFormatLabel(java.util.Locale locale)
java.lang.String	getHelpPageHTML(javax.servlet.jsp.PageContext pageContext)
protected java.lang.String	getHelpPageJSP()
protected abstract javax.servlet.ServletContext	getHelpPageServletContext()
java.lang.String	getHelpPageTitle(javax.servlet.http.HttpServletRequest httpServletRequest)
abstract java.lang.String	getHelpURL()
java.util.Map<java.lang.String,java.lang.Boolean>	getOutgoingLinks(WikiPage page) Returns a map of the links included in the given page.
protected com.liferay.portal.kernel.resource.bundle.ResourceBundleLoader	getResourceBundleLoader()
java.lang.String	getToolbarSet()
static WikiNode	getWikiNode(javax.servlet.ServletRequest servletRequest)
static WikiPage	getWikiPage(javax.servlet.ServletRequest servletRequest)
boolean	isHelpPageDefined()
void	renderEditPage(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, WikiNode node, WikiPage page)
boolean	validate(long nodeId, java.lang.String newContent) Returns true if the content of a wiki page for this engine is valid.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.liferay.wiki.engine.WikiEngine

getFormat

Constructor Detail

BaseWikiEngine

public BaseWikiEngine()

Method Detail

getBaseWikiEngine

public static BaseWikiEngine getBaseWikiEngine(javax.servlet.ServletRequest servletRequest)

getWikiNode

public static WikiNode getWikiNode(javax.servlet.ServletRequest servletRequest)

getWikiPage

public static WikiPage getWikiPage(javax.servlet.ServletRequest servletRequest)

convert

public java.lang.String convert(WikiPage page,
                                javax.portlet.PortletURL viewPageURL,
                                javax.portlet.PortletURL editPageURL,
                                java.lang.String attachmentURLPrefix)

Description copied from interface: WikiEngine

Returns the content of the given page converted to HTML using the view and edit URLs to build links.

Specified by:

convert in interface WikiEngine

Parameters:

page - the wiki page

viewPageURL - the URL to view the page

editPageURL - the URL to edit the page

attachmentURLPrefix - the URL prefix to use for attachments to the page

Returns:

the content of the given page converted to HTML

getEditorName

public abstract java.lang.String getEditorName()

getFormatLabel

public java.lang.String getFormatLabel(java.util.Locale locale)

Specified by:

getFormatLabel in interface WikiEngine

getHelpPageHTML

public java.lang.String getHelpPageHTML(javax.servlet.jsp.PageContext pageContext)
                                 throws java.io.IOException,
                                        javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException

getHelpPageTitle

public java.lang.String getHelpPageTitle(javax.servlet.http.HttpServletRequest httpServletRequest)

getHelpURL

public abstract java.lang.String getHelpURL()

getOutgoingLinks

public java.util.Map<java.lang.String,java.lang.Boolean> getOutgoingLinks(WikiPage page)
                                                                   throws PageContentException

Description copied from interface: WikiEngine

Returns a map of the links included in the given page. The key of each map entry is the title of the linked page. The value is a Boolean object that indicates if the linked page exists or not.

Specified by:

getOutgoingLinks in interface WikiEngine

Parameters:

page - the page

Returns:

a map of links included in the given page

Throws:

PageContentException

getToolbarSet

public java.lang.String getToolbarSet()

Specified by:

getToolbarSet in interface WikiEngine

isHelpPageDefined

public boolean isHelpPageDefined()

renderEditPage

public void renderEditPage(javax.servlet.ServletRequest servletRequest,
                           javax.servlet.ServletResponse servletResponse,
                           WikiNode node,
                           WikiPage page)
                    throws java.io.IOException,
                           javax.servlet.ServletException

Specified by:

renderEditPage in interface WikiEngine

Throws:

java.io.IOException

javax.servlet.ServletException

validate

public boolean validate(long nodeId,
                        java.lang.String newContent)

Description copied from interface: WikiEngine

Returns true if the content of a wiki page for this engine is valid.

Specified by:

validate in interface WikiEngine

Parameters:

nodeId - the ID of the wiki page node

newContent - the page content

Returns:

true if the content of a wiki page for this engine is valid; false otherwise

getEditPageJSP

protected java.lang.String getEditPageJSP()

getEditPageServletContext

protected abstract javax.servlet.ServletContext getEditPageServletContext()

getHelpPageJSP

protected java.lang.String getHelpPageJSP()

getHelpPageServletContext

protected abstract javax.servlet.ServletContext getHelpPageServletContext()

getResourceBundleLoader

protected com.liferay.portal.kernel.resource.bundle.ResourceBundleLoader getResourceBundleLoader()