com.xpn.xwiki.export.html
Class HtmlPackager

java.lang.Object
  extended by com.xpn.xwiki.export.html.HtmlPackager

public class HtmlPackager
extends Object

Create a ZIP package containing a range of HTML pages with skin and attachment dependencies.

Since:
XWiki Platform 1.3M1
Version:
$Id: c1ae0a0dd9361916d1b76668d52ba529d3e249e7 $

Constructor Summary
HtmlPackager()
           
 
Method Summary
 void addPage(String page)
          Add a page to export.
 void addPages(Collection<String> pages)
          Add a range of pages to export.
 void export(XWikiContext context)
          Apply export and create the ZIP package.
 String getDescription()
           
 String getName()
           
 void setDescription(String description)
          Modify the description of the package.
 void setName(String name)
          Modify the name of the package for which packager append ".zip".
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

HtmlPackager

public HtmlPackager()
Method Detail

setName

public void setName(String name)
Modify the name of the package for which packager append ".zip".

Parameters:
name - the name of the page.

getName

public String getName()
Returns:
the name of the package for which packager append ".zip".

setDescription

public void setDescription(String description)
Modify the description of the package.

Parameters:
description - the description of the package.

getDescription

public String getDescription()
Returns:
the description of the package.

addPage

public void addPage(String page)
Add a page to export.

Parameters:
page - the name of the page to export.

addPages

public void addPages(Collection<String> pages)
Add a range of pages to export.

Parameters:
pages - a range of pages to export.

export

public void export(XWikiContext context)
            throws IOException,
                   XWikiException
Apply export and create the ZIP package.

Parameters:
context - the XWiki context used to render pages.
Throws:
IOException - error when creating the package.
XWikiException - error when render the pages.


Copyright © 2004–2014 XWiki. All rights reserved.