Skip navigation links
B C D E G H I O P R S T V X 

B

build(InputStream, String, DocumentReference) - Method in interface org.xwiki.officeimporter.builder.PresentationBuilder
Builds a (slide-show) XDOMOfficeDocument corresponding to the given office presentation.
build(InputStream, String, DocumentReference, boolean) - Method in interface org.xwiki.officeimporter.builder.XDOMOfficeDocumentBuilder
Builds a XDOMOfficeDocument corresponding to the given office document.
build(XHTMLOfficeDocument) - Method in interface org.xwiki.officeimporter.builder.XDOMOfficeDocumentBuilder
Builds a XDOMOfficeDocument from the given XHTMLOfficeDocument.
build(InputStream, String, DocumentReference, boolean) - Method in interface org.xwiki.officeimporter.builder.XHTMLOfficeDocumentBuilder
Builds a XHTMLOfficeDocument corresponding to the specified office document.

C

close() - Method in interface org.xwiki.officeimporter.document.OfficeDocument
 
close() - Method in class org.xwiki.officeimporter.document.XDOMOfficeDocument
 
close() - Method in class org.xwiki.officeimporter.document.XHTMLOfficeDocument
 
convertDocument(Map<String, InputStream>, String, String) - Method in interface org.xwiki.officeimporter.converter.OfficeConverter
Attempts to convert the input document identified by inputStreams and inputFileName arguments into the format identified by outputFileName argument.

D

displayServerState() - Method in class org.xwiki.officeimporter.server.script.OfficeServerScriptService
Display the translated state of the server.

E

equals(Object) - Method in class org.xwiki.officeimporter.splitter.TargetDocumentDescriptor
 

G

getAllFiles() - Method in interface org.xwiki.officeimporter.converter.OfficeConverterResult
 
getArtifactsFiles() - Method in interface org.xwiki.officeimporter.document.OfficeDocument
Returns the files corresponding to all the artifacts for this office document, except the conversion of the document itself.
getArtifactsFiles() - Method in class org.xwiki.officeimporter.document.XDOMOfficeDocument
 
getArtifactsFiles() - Method in class org.xwiki.officeimporter.document.XHTMLOfficeDocument
 
getConfig() - Method in class org.xwiki.officeimporter.server.script.OfficeServerScriptService
 
getContentAsString() - Method in interface org.xwiki.officeimporter.document.OfficeDocument
Returns the content of this document as a string.
getContentAsString() - Method in class org.xwiki.officeimporter.document.XDOMOfficeDocument
 
getContentAsString(String) - Method in class org.xwiki.officeimporter.document.XDOMOfficeDocument
Renders the XDOM encapsulated by this document into the given syntax.
getContentAsString() - Method in class org.xwiki.officeimporter.document.XHTMLOfficeDocument
 
getContentDocument() - Method in interface org.xwiki.officeimporter.document.OfficeDocument
Returns the content of this office document.
getContentDocument() - Method in class org.xwiki.officeimporter.document.XDOMOfficeDocument
 
getContentDocument() - Method in class org.xwiki.officeimporter.document.XHTMLOfficeDocument
 
getConverter() - Method in interface org.xwiki.officeimporter.server.OfficeServer
 
getConverterResult() - Method in interface org.xwiki.officeimporter.document.OfficeDocument
 
getConverterResult() - Method in class org.xwiki.officeimporter.document.XDOMOfficeDocument
 
getConverterResult() - Method in class org.xwiki.officeimporter.document.XHTMLOfficeDocument
 
getDocumentFormat(String) - Method in interface org.xwiki.officeimporter.converter.OfficeConverter
Retrieve the office document format based on the given file name.
getDocumentReference() - Method in class org.xwiki.officeimporter.splitter.TargetDocumentDescriptor
 
getDocumentReferenceAsString() - Method in class org.xwiki.officeimporter.splitter.TargetDocumentDescriptor
 
getErrorMessage() - Method in class org.xwiki.officeimporter.script.OfficeImporterScriptService
 
getExtension() - Method in interface org.xwiki.officeimporter.converter.OfficeDocumentFormat
 
getExtensions() - Method in interface org.xwiki.officeimporter.converter.OfficeDocumentFormat
 
getHomePath() - Method in interface org.xwiki.officeimporter.server.OfficeServerConfiguration
 
getLastErrorMessage() - Method in class org.xwiki.officeimporter.server.script.OfficeServerScriptService
 
getMaxTasksPerProcess() - Method in interface org.xwiki.officeimporter.server.OfficeServerConfiguration
 
getMediaType() - Method in interface org.xwiki.officeimporter.converter.OfficeDocumentFormat
 
getName() - Method in interface org.xwiki.officeimporter.converter.OfficeDocumentFormat
 
getOutputDirectory() - Method in interface org.xwiki.officeimporter.converter.OfficeConverterResult
 
getOutputFile() - Method in interface org.xwiki.officeimporter.converter.OfficeConverterResult
 
getParentReference() - Method in class org.xwiki.officeimporter.splitter.TargetDocumentDescriptor
 
getParentReferenceAsString() - Method in class org.xwiki.officeimporter.splitter.TargetDocumentDescriptor
 
getProfilePath() - Method in interface org.xwiki.officeimporter.server.OfficeServerConfiguration
 
getServerPort() - Method in interface org.xwiki.officeimporter.server.OfficeServerConfiguration
Deprecated.
getServerPorts() - Method in interface org.xwiki.officeimporter.server.OfficeServerConfiguration
 
getServerState() - Method in class org.xwiki.officeimporter.server.script.OfficeServerScriptService
Deprecated.
Since 12.3 this method shouldn't be used anymore: if the goal is to know if the server is connected or not, then OfficeServerScriptService.isConnected() should be used instead. If the goal is to display the state of the server then OfficeServerScriptService.displayServerState() should be used.
getServerType() - Method in interface org.xwiki.officeimporter.server.OfficeServerConfiguration
Returns the type of the office server instance consumed by office importer module: 0 - Internally managed server instance 1 - Externally managed (local) server instance .
getState() - Method in interface org.xwiki.officeimporter.server.OfficeServer
 
getTaskExecutionTimeout() - Method in interface org.xwiki.officeimporter.server.OfficeServerConfiguration
 
getTitle() - Method in class org.xwiki.officeimporter.document.XDOMOfficeDocument
Tries to extract a title suitable for this document.

H

hashCode() - Method in class org.xwiki.officeimporter.splitter.TargetDocumentDescriptor
 

I

isAutoStart() - Method in interface org.xwiki.officeimporter.server.OfficeServerConfiguration
 
isConnected() - Method in class org.xwiki.officeimporter.server.script.OfficeServerScriptService
Determine if the server is connected.
isConversionSupported(String, String) - Method in interface org.xwiki.officeimporter.converter.OfficeConverter
Use this method to check if the unidirectional conversion from a document format (input media type) to another document format (output media type) is supported by this converter.
isMediaTypeSupported(String) - Method in interface org.xwiki.officeimporter.converter.OfficeConverter
Checks if the office documents with the specified media type can be converted by this converter.
isPresentation(String) - Method in interface org.xwiki.officeimporter.converter.OfficeConverter
 

O

OFFICE_IMPORTER_ERROR - Static variable in class org.xwiki.officeimporter.script.OfficeImporterScriptService
The key used to place any error messages while importing office documents.
OFFICE_MANAGER_ERROR - Static variable in class org.xwiki.officeimporter.server.script.OfficeServerScriptService
The key used to place any error messages while trying to control the office server instance.
OfficeConverter - Interface in org.xwiki.officeimporter.converter
Interface used to convert documents between various office formats.
OfficeConverterException - Exception in org.xwiki.officeimporter.converter
Represents an exception that can be thrown during office document conversion operations.
OfficeConverterException(String) - Constructor for exception org.xwiki.officeimporter.converter.OfficeConverterException
Constructs a new instance.
OfficeConverterException(String, Throwable) - Constructor for exception org.xwiki.officeimporter.converter.OfficeConverterException
Constructs a new instance.
OfficeConverterResult - Interface in org.xwiki.officeimporter.converter
Provide the result of an office file conversion.
OfficeDocument - Interface in org.xwiki.officeimporter.document
Represents an office document being imported.
OfficeDocumentFormat - Interface in org.xwiki.officeimporter.converter
Representation of an OfficeDocumentFormat.
OfficeImporterException - Exception in org.xwiki.officeimporter
The class used to indicate exceptions specific to the Office Importer plugin.
OfficeImporterException(String) - Constructor for exception org.xwiki.officeimporter.OfficeImporterException
Constructs a new exception with the specified message.
OfficeImporterException(Throwable) - Constructor for exception org.xwiki.officeimporter.OfficeImporterException
Constructs a new exception with the specified cause.
OfficeImporterException(String, Throwable) - Constructor for exception org.xwiki.officeimporter.OfficeImporterException
Constructs a new exception with the specified message and cause.
OfficeImporterScriptService - Class in org.xwiki.officeimporter.script
Exposes the office importer APIs to server-side scripts.
OfficeImporterScriptService() - Constructor for class org.xwiki.officeimporter.script.OfficeImporterScriptService
 
OfficeServer - Interface in org.xwiki.officeimporter.server
Component interface for managing the office server connection / process.
OfficeServer.ServerState - Enum in org.xwiki.officeimporter.server
Enumeration used to represent the office server state.
OfficeServerConfiguration - Interface in org.xwiki.officeimporter.server
Configuration properties for the OfficeServer.
OfficeServerException - Exception in org.xwiki.officeimporter.server
Represents an exception that can be thrown communicating with an office server.
OfficeServerException(String) - Constructor for exception org.xwiki.officeimporter.server.OfficeServerException
Constructs a new instance.
OfficeServerException(String, Throwable) - Constructor for exception org.xwiki.officeimporter.server.OfficeServerException
Constructs a new instance.
OfficeServerScriptService - Class in org.xwiki.officeimporter.server.script
Exposes the office manager APIs to server-side scripts.
OfficeServerScriptService() - Constructor for class org.xwiki.officeimporter.server.script.OfficeServerScriptService
 
officeToXDOM(InputStream, String, DocumentReference, boolean) - Method in class org.xwiki.officeimporter.script.OfficeImporterScriptService
Imports the given office document into an XDOMOfficeDocument.
officeToXDOM(InputStream, String, String, boolean) - Method in class org.xwiki.officeimporter.script.OfficeImporterScriptService
officeToXHTML(InputStream, String, DocumentReference, boolean) - Method in class org.xwiki.officeimporter.script.OfficeImporterScriptService
Imports the given office document into an XHTMLOfficeDocument.
officeToXHTML(InputStream, String, String, boolean) - Method in class org.xwiki.officeimporter.script.OfficeImporterScriptService
org.xwiki.officeimporter - package org.xwiki.officeimporter
 
org.xwiki.officeimporter.builder - package org.xwiki.officeimporter.builder
 
org.xwiki.officeimporter.converter - package org.xwiki.officeimporter.converter
 
org.xwiki.officeimporter.document - package org.xwiki.officeimporter.document
 
org.xwiki.officeimporter.script - package org.xwiki.officeimporter.script
 
org.xwiki.officeimporter.server - package org.xwiki.officeimporter.server
 
org.xwiki.officeimporter.server.script - package org.xwiki.officeimporter.server.script
 
org.xwiki.officeimporter.splitter - package org.xwiki.officeimporter.splitter
 

P

PresentationBuilder - Interface in org.xwiki.officeimporter.builder
Component responsible for building XDOMOfficeDocument objects from binary (presentation) office files.

R

refreshState() - Method in interface org.xwiki.officeimporter.server.OfficeServer
Refresh the current state of the process.

S

save(XDOMOfficeDocument, DocumentReference, DocumentReference, String, boolean) - Method in class org.xwiki.officeimporter.script.OfficeImporterScriptService
Attempts to save the given XDOMOfficeDocument into the target wiki page specified by arguments (using the default content syntax, see ExtendedRenderingConfiguration.getDefaultContentSyntax()).
save(XDOMOfficeDocument, DocumentReference, String, DocumentReference, String, boolean) - Method in class org.xwiki.officeimporter.script.OfficeImporterScriptService
Attempts to save the given XDOMOfficeDocument into the target wiki page specified by arguments.
save(XDOMOfficeDocument, String, String, String, String, boolean) - Method in class org.xwiki.officeimporter.script.OfficeImporterScriptService
SERVER_TYPE_EXTERNAL_LOCAL - Static variable in interface org.xwiki.officeimporter.server.OfficeServerConfiguration
Indicates an externally managed locally deployed office server instance.
SERVER_TYPE_EXTERNAL_REMOTE - Static variable in interface org.xwiki.officeimporter.server.OfficeServerConfiguration
Indicates an externally managed remotely deployed office server instance.
SERVER_TYPE_INTERNAL - Static variable in interface org.xwiki.officeimporter.server.OfficeServerConfiguration
Indicates an internally managed office server instance.
setParentReference(DocumentReference) - Method in class org.xwiki.officeimporter.splitter.TargetDocumentDescriptor
Sets the name of the parent document reference.
split(XDOMOfficeDocument, String[], String, DocumentReference) - Method in class org.xwiki.officeimporter.script.OfficeImporterScriptService
Splits the given XDOMOfficeDocument into multiple XDOMOfficeDocument instances according to the specified criterion.
split(XDOMOfficeDocument, String[], String, String) - Method in class org.xwiki.officeimporter.script.OfficeImporterScriptService
split(XDOMOfficeDocument, int[], String, DocumentReference) - Method in interface org.xwiki.officeimporter.splitter.XDOMOfficeDocumentSplitter
Splits an XDOMOfficeDocument into multiple XDOMOfficeDocument instances using the provided heading levels as boundaries.
start() - Method in interface org.xwiki.officeimporter.server.OfficeServer
If an internally managed office server is configured (xwiki.properties), this method will start an office server process and connect to it.
startServer() - Method in class org.xwiki.officeimporter.server.script.OfficeServerScriptService
Tries to start the office server process.
stop() - Method in interface org.xwiki.officeimporter.server.OfficeServer
If an internally managed office server is configured (xwiki.properties), this method will disconnect from the office server and terminate the server process.
stopServer() - Method in class org.xwiki.officeimporter.server.script.OfficeServerScriptService
Tries to stop the office server process.

T

TargetDocumentDescriptor - Class in org.xwiki.officeimporter.splitter
Descriptor for specifying a reference to the document into which an office document is going to be saved.
TargetDocumentDescriptor(DocumentReference, ComponentManager) - Constructor for class org.xwiki.officeimporter.splitter.TargetDocumentDescriptor
Creates a new TargetDocumentDescriptor instance.
toString() - Method in enum org.xwiki.officeimporter.server.OfficeServer.ServerState
 

V

valueOf(String) - Static method in enum org.xwiki.officeimporter.server.OfficeServer.ServerState
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.xwiki.officeimporter.server.OfficeServer.ServerState
Returns an array containing the constants of this enum type, in the order they are declared.

X

XDOMOfficeDocument - Class in org.xwiki.officeimporter.document
An OfficeDocument backed by an XDOM document.
XDOMOfficeDocument(XDOM, Set<File>, ComponentManager, OfficeConverterResult) - Constructor for class org.xwiki.officeimporter.document.XDOMOfficeDocument
Creates a new XDOMOfficeDocument.
XDOMOfficeDocumentBuilder - Interface in org.xwiki.officeimporter.builder
Component responsible for building XDOMOfficeDocument objects from binary office files or XHTMLOfficeDocument objects.
XDOMOfficeDocumentSplitter - Interface in org.xwiki.officeimporter.splitter
Component responsible for splitting office imports.
XHTMLOfficeDocument - Class in org.xwiki.officeimporter.document
A OfficeDocument backed by a w3c Document containing xhtml markup.
XHTMLOfficeDocument(Document, Set<File>, OfficeConverterResult) - Constructor for class org.xwiki.officeimporter.document.XHTMLOfficeDocument
Creates a new XHTMLOfficeDocument.
XHTMLOfficeDocumentBuilder - Interface in org.xwiki.officeimporter.builder
Component responsible for building XHTMLOfficeDocument objects from binary office files.
xhtmlToXDOM(XHTMLOfficeDocument) - Method in class org.xwiki.officeimporter.script.OfficeImporterScriptService
Imports the given XHTMLOfficeDocument into an XDOMOfficeDocument.
B C D E G H I O P R S T V X 
Skip navigation links

Copyright © 2004–2021 XWiki. All rights reserved.