Class BaseWikiEngine

java.lang.Object
com.liferay.wiki.engine.BaseWikiEngine
All Implemented Interfaces:
WikiEngine

public abstract class BaseWikiEngine extends Object implements WikiEngine
  • Constructor Details

    • BaseWikiEngine

      public BaseWikiEngine()
  • Method Details

    • 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 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 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 String getEditorName()
    • getFormatLabel

      public String getFormatLabel(Locale locale)
      Specified by:
      getFormatLabel in interface WikiEngine
    • getHelpPageHTML

      public String getHelpPageHTML(javax.servlet.jsp.PageContext pageContext) throws IOException, javax.servlet.ServletException
      Throws:
      IOException
      javax.servlet.ServletException
    • getHelpPageTitle

      public String getHelpPageTitle(javax.servlet.http.HttpServletRequest httpServletRequest)
    • getHelpURL

      public abstract String getHelpURL()
    • 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
    • getToolbarSet

      public 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 IOException, javax.servlet.ServletException
      Specified by:
      renderEditPage in interface WikiEngine
      Throws:
      IOException
      javax.servlet.ServletException
    • 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
    • getEditPageJSP

      protected String getEditPageJSP()
    • getEditPageServletContext

      protected abstract javax.servlet.ServletContext getEditPageServletContext()
    • getHelpPageJSP

      protected String getHelpPageJSP()
    • getHelpPageServletContext

      protected abstract javax.servlet.ServletContext getHelpPageServletContext()
    • getResourceBundleLoader

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