com.liferay.portlet.wiki.engines
Class HtmlEngine

java.lang.Object
  com.liferay.portlet.wiki.engines.HtmlEngine

All Implemented Interfaces:

WikiEngine

public class HtmlEngine
extends Object
implements WikiEngine

Constructor Summary

HtmlEngine()

Method Summary

String	convert(WikiPage page, PortletURL viewPageURL, PortletURL editPageURL, String attachmentURLPrefix) Returns the content of the given page converted to HTML using the view and edit URLs to build links.
Map<String,Boolean>	getOutgoingLinks(WikiPage page) Returns a map of the links included in the given page.
void	setInterWikiConfiguration(String interWikiConfiguration) Set the configuration to support quick links to other wikis.
void	setMainConfiguration(String mainConfiguration) Sets the main wiki configuration as a String.
boolean	validate(long nodeId, 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

Constructor Detail

HtmlEngine

public HtmlEngine()

Method Detail

convert

public String convert(WikiPage page,
                      PortletURL viewPageURL,
                      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 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

getOutgoingLinks

public Map<String,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 - if a page content exception occurred

setInterWikiConfiguration

public void setInterWikiConfiguration(String interWikiConfiguration)

Description copied from interface: WikiEngine

Set the configuration to support quick links to other wikis. The format of the configuration is specific to the wiki engine.

Specified by:

setInterWikiConfiguration in interface WikiEngine

Parameters:

interWikiConfiguration - the configuration to support quick links to other wikis

setMainConfiguration

public void setMainConfiguration(String mainConfiguration)

Description copied from interface: WikiEngine

Sets the main wiki configuration as a String. The format of the configuration is specific to the wiki engine.

Specified by:

setMainConfiguration in interface WikiEngine

Parameters:

mainConfiguration - the main configuration of the wiki engine

validate

public boolean validate(long nodeId,
                        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