Package com.liferay.wiki.engine
Class BaseWikiEngine
java.lang.Object
com.liferay.wiki.engine.BaseWikiEngine
- All Implemented Interfaces:
WikiEngine
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionconvert
(WikiPage page, javax.portlet.PortletURL viewPageURL, javax.portlet.PortletURL editPageURL, 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 String
protected String
protected abstract javax.servlet.ServletContext
getFormatLabel
(Locale locale) getHelpPageHTML
(javax.servlet.jsp.PageContext pageContext) protected String
protected abstract javax.servlet.ServletContext
getHelpPageTitle
(javax.servlet.http.HttpServletRequest httpServletRequest) abstract String
getOutgoingLinks
(WikiPage page) Returns a map of the links included in the given page.protected com.liferay.portal.kernel.resource.bundle.ResourceBundleLoader
static WikiNode
getWikiNode
(javax.servlet.ServletRequest servletRequest) static WikiPage
getWikiPage
(javax.servlet.ServletRequest servletRequest) boolean
void
renderEditPage
(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, WikiNode node, WikiPage page) boolean
Returnstrue
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 Details
-
BaseWikiEngine
public BaseWikiEngine()
-
-
Method Details
-
getBaseWikiEngine
-
getWikiNode
-
getWikiPage
-
convert
public String convert(WikiPage page, javax.portlet.PortletURL viewPageURL, javax.portlet.PortletURL editPageURL, 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 interfaceWikiEngine
- Parameters:
page
- the wiki pageviewPageURL
- the URL to view the pageeditPageURL
- the URL to edit the pageattachmentURLPrefix
- the URL prefix to use for attachments to the page- Returns:
- the content of the given page converted to HTML
-
getEditorName
-
getFormatLabel
- Specified by:
getFormatLabel
in interfaceWikiEngine
-
getHelpPageHTML
public String getHelpPageHTML(javax.servlet.jsp.PageContext pageContext) throws IOException, javax.servlet.ServletException - Throws:
IOException
javax.servlet.ServletException
-
getHelpPageTitle
-
getHelpURL
-
getOutgoingLinks
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 interfaceWikiEngine
- Parameters:
page
- the page- Returns:
- a map of links included in the given page
- Throws:
PageContentException
-
getToolbarSet
- Specified by:
getToolbarSet
in interfaceWikiEngine
-
isHelpPageDefined
public boolean isHelpPageDefined() -
renderEditPage
public void renderEditPage(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, WikiNode node, WikiPage page) throws IOException, javax.servlet.ServletException - Specified by:
renderEditPage
in interfaceWikiEngine
- Throws:
IOException
javax.servlet.ServletException
-
validate
Description copied from interface:WikiEngine
Returnstrue
if the content of a wiki page for this engine is valid.- Specified by:
validate
in interfaceWikiEngine
- Parameters:
nodeId
- the ID of the wiki page nodenewContent
- the page content- Returns:
true
if the content of a wiki page for this engine is valid;false
otherwise
-
getEditPageJSP
-
getEditPageServletContext
protected abstract javax.servlet.ServletContext getEditPageServletContext() -
getHelpPageJSP
-
getHelpPageServletContext
protected abstract javax.servlet.ServletContext getHelpPageServletContext() -
getResourceBundleLoader
protected com.liferay.portal.kernel.resource.bundle.ResourceBundleLoader getResourceBundleLoader()
-