org.xwiki.office.viewer.script

Class DefaultOfficeViewerScriptService

java.lang.Object

org.xwiki.office.viewer.script.DefaultOfficeViewerScriptService

All Implemented Interfaces:

OfficeViewerScriptService, org.xwiki.script.service.ScriptService

@Component
 @Named(value="officeviewer")
 @Singleton
public class DefaultOfficeViewerScriptService
extends Object
implements OfficeViewerScriptService

Default implementation of OfficeViewerScriptService.

Since:

2.5M2

Version:

$Id: ae5dcbb74ec180f6bfde2131ab60551b7b6830e4 $

Constructor Summary

Constructors

Constructor and Description
DefaultOfficeViewerScriptService()

Method Summary

Modifier and Type	Method and Description
Exception	getCaughtException()
boolean	isMimeTypeSupported(String mimeType) Checks if a given mime type is supported for viewing.
String	view(org.xwiki.model.reference.AttachmentReference attachmentReference) Builds a XHTML representation of the specified office attachment.
String	view(org.xwiki.model.reference.AttachmentReference attachmentReference, Map<String,String> parameters) Builds a XHTML representation of the specified office attachment.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultOfficeViewerScriptService

public DefaultOfficeViewerScriptService()

Method Detail

getCaughtException

public Exception getCaughtException()

Specified by:

getCaughtException in interface OfficeViewerScriptService

Returns:

the exception caught during the last office attachment view on the current execution, or null if no exception has been thrown

view

public String view(org.xwiki.model.reference.AttachmentReference attachmentReference)

Description copied from interface: OfficeViewerScriptService

Builds a XHTML representation of the specified office attachment.

Specified by:

view in interface OfficeViewerScriptService

Parameters:

attachmentReference - reference to the office attachment to be viewed

Returns:

a XHTML representation of the specified office attachment or null if an error occurs

view

public String view(org.xwiki.model.reference.AttachmentReference attachmentReference,
                   Map<String,String> parameters)

Description copied from interface: OfficeViewerScriptService

Builds a XHTML representation of the specified office attachment.

Specified by:

view in interface OfficeViewerScriptService

Parameters:

attachmentReference - reference to the office attachment to be viewed

parameters - view parameters specific to the underlying OfficeResourceViewer implementation

Returns:

a XHTML representation of the specified office attachment or null if an error occurs

isMimeTypeSupported

public boolean isMimeTypeSupported(String mimeType)

Description copied from interface: OfficeViewerScriptService

Checks if a given mime type is supported for viewing.

Specified by:

isMimeTypeSupported in interface OfficeViewerScriptService

Parameters:

mimeType - a mime type

Returns:

true if the specified mime type can be viewed, false otherwise