org.xwiki.gwt.wysiwyg.client.plugin.importer

Interface ImportService

All Superinterfaces:

com.google.gwt.user.client.rpc.RemoteService

@Role
 @RemoteServiceRelativePath(value="ImportService.gwtrpc")
public interface ImportService
extends com.google.gwt.user.client.rpc.RemoteService

The service interface used on the server.

Version:

$Id: a1641fec5b56164840db77ccc4bd5895f9185505 $

Method Summary

Modifier and Type	Method and Description
String	cleanOfficeHTML(String htmlPaste, String cleanerHint, Map<String,String> cleaningParams) Cleans dirty HTML content produced from an office application like MsWord, MsExcel, OpenOffice Writer etc.
String	officeToXHTML(Attachment attachment, Map<String,String> cleaningParams) Imports the given office attachment into XHTML 1.0.

Method Detail

cleanOfficeHTML

String cleanOfficeHTML(String htmlPaste,
                       String cleanerHint,
                       Map<String,String> cleaningParams)

Cleans dirty HTML content produced from an office application like MsWord, MsExcel, OpenOffice Writer etc. This method is primarily utilized by the office importer WYSIWYG plug-in.

Parameters:

htmlPaste - dirty HTML pasted by the user

cleanerHint - role hint for which cleaner to be used

cleaningParams - additional parameters to be used when cleaning

Returns:

the cleaned HTML content

officeToXHTML

String officeToXHTML(Attachment attachment,
                     Map<String,String> cleaningParams)

Imports the given office attachment into XHTML 1.0. This method returns the resulting XHTML content while if there are non-textual content in the office attachment, they will be attached to the owner wiki page. Note that this operation does not alter the content of the wiki page.

Parameters:

attachment - office attachment to be imported into XHTML 1.0.

cleaningParams - additional parameters for the import operation.

Returns:

the XHTML result from the office importer.