com.liferay.wiki.engine

Interface WikiEngine

All Known Implementing Classes:

BaseWikiEngine

public interface WikiEngine

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.
java.lang.String	getFormat()
java.lang.String	getFormatLabel(java.util.Locale locale)
java.util.Map<java.lang.String,java.lang.Boolean>	getOutgoingLinks(WikiPage page) Returns a map of the links included in the given page.
java.lang.String	getToolbarSet()
void	renderEditPage(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, WikiNode node, WikiPage page)
boolean	validate(long nodeId, java.lang.String content) Returns true if the content of a wiki page for this engine is valid.

Method Detail

convert

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

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

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

Throws:

PageContentException

getFormat

java.lang.String getFormat()

getFormatLabel

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

getOutgoingLinks

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

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.

Parameters:

page - the page

Returns:

a map of links included in the given page

Throws:

PageContentException

getToolbarSet

java.lang.String getToolbarSet()

renderEditPage

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

Throws:

java.io.IOException

javax.servlet.ServletException

validate

boolean validate(long nodeId,
                 java.lang.String content)

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

Parameters:

nodeId - the ID of the wiki page node

content - the page content

Returns:

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