- AbstractFilterChain - Class in org.jodconverter.filter
-
Base class of a FilterChain.
- AbstractFilterChain() - Constructor for class org.jodconverter.filter.AbstractFilterChain
-
Creates a FilterChain.
- AbstractFilterChain(Filter...) - Constructor for class org.jodconverter.filter.AbstractFilterChain
-
Creates a FilterChain that will contains the specified filters.
- AbstractFilterChain(boolean, Filter...) - Constructor for class org.jodconverter.filter.AbstractFilterChain
-
Creates a FilterChain that will contains the specified filters.
- AbstractLocalOfficeTask - Class in org.jodconverter.task
-
Base class for all local office tasks implementation.
- AbstractLocalOfficeTask(SourceDocumentSpecs) - Constructor for class org.jodconverter.task.AbstractLocalOfficeTask
-
Creates a new task with the specified source document.
- AbstractLocalOfficeTask(SourceDocumentSpecs, Map<String, Object>) - Constructor for class org.jodconverter.task.AbstractLocalOfficeTask
-
Creates a new task with the specified source document.
- AbstractProcessManager - Class in org.jodconverter.process
-
Base class for all process manager implementations included in the standard JODConverter
distribution.
- AbstractProcessManager() - Constructor for class org.jodconverter.process.AbstractProcessManager
-
Initializes a new instance of the class.
- AbstractTextContentInserterFilter - Class in org.jodconverter.filter.text
-
Base class for all filter used to insert a TextContent into a document.
- AbstractTextContentInserterFilter(Dimension, int, int) - Constructor for class org.jodconverter.filter.text.AbstractTextContentInserterFilter
-
Creates a new filter that will insert a text content (shape) of the specified size at the
specified location while converting a document.
- AbstractTextContentInserterFilter(Dimension, Map<String, Object>) - Constructor for class org.jodconverter.filter.text.AbstractTextContentInserterFilter
-
Creates a new filter that will insert a text content (shape) of the specified size using the
specified shape properties while converting a document.
- addFilter(Filter) - Method in class org.jodconverter.filter.AbstractFilterChain
-
Adds a filter to the chain.
- addFilter(Filter) - Method in interface org.jodconverter.filter.FilterChain
-
Adds a filter to the chain.
- addPropertiesToMap(Map<String, Object>, Map<String, Object>) - Static method in class org.jodconverter.task.AbstractLocalOfficeTask
-
- applyAnchorPageNoFix(XTextDocument, XTextCursor) - Method in class org.jodconverter.filter.text.AbstractTextContentInserterFilter
-
Jumps to the page specified by the "AnchorPageNo" if present in the shape properties if this
filter.
- attempt() - Method in class org.jodconverter.office.ConnectRetryable
-
- attempt() - Method in class org.jodconverter.office.ExitCodeRetryable
-
- getArgument() - Method in class org.jodconverter.process.ProcessQuery
-
Gets the arguments of the process to query.
- getCommand() - Method in class org.jodconverter.process.ProcessQuery
-
Gets the command of the process to query.
- getComponentContext() - Method in interface org.jodconverter.office.LocalOfficeContext
-
Gets the office component context for this context.
- getComponentLoader() - Method in interface org.jodconverter.office.LocalOfficeContext
-
Gets the office component loader for this context.
- getConnection() - Method in class org.jodconverter.office.OfficeUrl
-
Returns the name of the connection of this Uno Url.
- getConnectionAndParametersAsString() - Method in class org.jodconverter.office.OfficeUrl
-
Returns the raw specification of the connection name and parameters.
- getConnectionParameters() - Method in class org.jodconverter.office.OfficeUrl
-
Returns the connection parameters as a map with key/value pairs.
- getConnectionParametersAsString() - Method in class org.jodconverter.office.OfficeUrl
-
Returns the raw specification of the connection parameters.
- getConnectString() - Method in exception org.jodconverter.office.OfficeConnectionException
-
Gets the connection strong of the connection.
- getDefault() - Static method in class org.jodconverter.process.MacProcessManager
-
Gets the default instance of MacProcessManager
.
- getDefault() - Static method in class org.jodconverter.process.PureJavaProcessManager
-
Gets the default instance of PureJavaProcessManager
.
- getDefault() - Static method in class org.jodconverter.process.UnixProcessManager
-
Gets the default instance of UnixProcessManager
.
- getDefault() - Static method in class org.jodconverter.process.WindowsProcessManager
-
Gets the default instance of WindowsProcessManager
.
- getDefaultOfficeHome() - Static method in class org.jodconverter.office.LocalOfficeUtils
-
Gets the default office home directory, which is auto-detected.
- getDesktop() - Method in interface org.jodconverter.office.LocalOfficeContext
-
Gets the office desktop for this context.
- getExitCode() - Method in class org.jodconverter.office.ExitCodeRetryable
-
The exit code of the process.
- getFormatRegistry() - Method in class org.jodconverter.OfficeDocumentConverter
-
Gets all the DocumentFormat
supported by the converter.
- getLoadProperties() - Method in class org.jodconverter.task.AbstractLocalOfficeTask
-
- getOfficeExecutable(File) - Static method in class org.jodconverter.office.LocalOfficeUtils
-
Gets the office executable within an office installation.
- getPageCount() - Method in class org.jodconverter.filter.text.PageCounterFilter
-
Gets the number of pages within the document when the filter has been invoked.
- getProtocol() - Method in class org.jodconverter.office.OfficeUrl
-
Returns the name of the protocol of this Uno Url.
- getProtocolAndParametersAsString() - Method in class org.jodconverter.office.OfficeUrl
-
Returns the raw specification of the protocol name and parameters.
- getProtocolParameters() - Method in class org.jodconverter.office.OfficeUrl
-
Returns the protocol parameters as a map with key/value pairs.
- getProtocolParametersAsString() - Method in class org.jodconverter.office.OfficeUrl
-
Returns the raw specification of the protocol parameters.
- getRectSize() - Method in class org.jodconverter.filter.text.AbstractTextContentInserterFilter
-
Gets the rectangle's size of the shape that will be inserted.
- getRootOid() - Method in class org.jodconverter.office.OfficeUrl
-
Return the object name.
- getRunningProcessesCommand(String) - Method in class org.jodconverter.process.AbstractProcessManager
-
Gets the command to be executed to get a snapshot of all the running processes identified by
the specified argument (process).
- getRunningProcessesCommand(String) - Method in class org.jodconverter.process.MacProcessManager
-
- getRunningProcessesCommand(String) - Method in class org.jodconverter.process.UnixProcessManager
-
- getRunningProcessesCommand(String) - Method in class org.jodconverter.process.WindowsProcessManager
-
- getRunningProcessLinePattern() - Method in class org.jodconverter.process.AbstractProcessManager
-
Gets the pattern to be used to match an output line containing the information about a running
process.
- getRunningProcessLinePattern() - Method in class org.jodconverter.process.UnixProcessManager
-
- getRunningProcessLinePattern() - Method in class org.jodconverter.process.WindowsProcessManager
-
- getShapeProperties() - Method in class org.jodconverter.filter.text.AbstractTextContentInserterFilter
-
Gets the shape's properties to apply when inserting the shape to the document.
- GraphicInserterFilter - Class in org.jodconverter.filter.text
-
This filter is used to insert a graphics into a document.
- GraphicInserterFilter(String, int, int) - Constructor for class org.jodconverter.filter.text.GraphicInserterFilter
-
Creates a new filter that will insert the specified image at the specified location while
converting a document.
- GraphicInserterFilter(String, int, int, int, int) - Constructor for class org.jodconverter.filter.text.GraphicInserterFilter
-
Creates a new filter that will insert the specified image at the specified location while
converting a document.
- GraphicInserterFilter(String, int, int, Map<String, Object>) - Constructor for class org.jodconverter.filter.text.GraphicInserterFilter
-
Creates a new filter that will insert the specified image using the specified properties while
converting a document.
- GraphicInserterFilter(String, Map<String, Object>) - Constructor for class org.jodconverter.filter.text.GraphicInserterFilter
-
Creates a new filter that will insert the specified image using the specified properties while
converting a document.
- OfficeConnectionException - Exception in org.jodconverter.office
-
Exceptions thrown when a connection to an office process failed.
- OfficeConnectionException(String, String) - Constructor for exception org.jodconverter.office.OfficeConnectionException
-
Constructs a new connect exception with the specified detail message.
- OfficeConnectionException(String, String, Throwable) - Constructor for exception org.jodconverter.office.OfficeConnectionException
-
Constructs a new connect exception with the specified detail message and cause.
- OfficeConnectionProtocol - Enum in org.jodconverter.office
-
Represents protocols that can be used to communicate with a running office instance.
- OfficeDocumentConverter - Class in org.jodconverter
-
A OfficeDocumentConverter is responsible to execute the conversion of documents using an office
manager.
- OfficeDocumentConverter(OfficeManager) - Constructor for class org.jodconverter.OfficeDocumentConverter
-
Constructs a new instance of the class with the specified manager.
- OfficeDocumentConverter(OfficeManager, DocumentFormatRegistry) - Constructor for class org.jodconverter.OfficeDocumentConverter
-
Constructs a new instance of the class with the specified manager and registry.
- officeHome(File) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
-
Specifies the office home directory (office installation).
- officeHome(String) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
-
Specifies the office home directory (office installation).
- OfficeUrl - Class in org.jodconverter.office
-
Wrapper class around an UnoUrl so we are not importing the com.sun.star.lib.uno.helper.UnoUrl
package everywhere.
- OfficeUrl(String) - Constructor for class org.jodconverter.office.OfficeUrl
-
Creates an OfficeUrl for the specified pipe.
- OfficeUrl(int) - Constructor for class org.jodconverter.office.OfficeUrl
-
Creates an OfficeUrl for the specified port.
- org.jodconverter - package org.jodconverter
-
This package contains the interfaces/classes related to the tasks an office process can execute.
- org.jodconverter.filter - package org.jodconverter.filter
-
This package contains classes related to the modification of a document after it has been loaded
by JODConverter.
- org.jodconverter.filter.text - package org.jodconverter.filter.text
-
This package provides various
Filter
implementations that can be
used while converting a document from the TEXT document family.
- org.jodconverter.office - package org.jodconverter.office
-
- org.jodconverter.process - package org.jodconverter.process
-
This package provides various
ProcessManager
implementations for
dealing with office processes (kill processes, retrieve process ids, etc.).
- org.jodconverter.task - package org.jodconverter.task
-
- PageCounterFilter - Class in org.jodconverter.filter.text
-
This filter is used to count the number of pages of a document.
- PageCounterFilter() - Constructor for class org.jodconverter.filter.text.PageCounterFilter
-
- PageSelectorFilter - Class in org.jodconverter.filter.text
-
This filter is used to select a specific page from a document in order to convert only the
selected page.
- PageSelectorFilter(int) - Constructor for class org.jodconverter.filter.text.PageSelectorFilter
-
Creates a new filter that will select the specified page while converting a document (only the
given page will be converted).
- PID_NOT_FOUND - Static variable in interface org.jodconverter.process.ProcessManager
-
- PID_UNKNOWN - Static variable in interface org.jodconverter.process.ProcessManager
-
- pipeNames(String...) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
-
Specifies the pipe names that will be use to communicate with office.
- portNumbers(int...) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
-
Specifies the port numbers that will be use to communicate with office.
- pos - Variable in class org.jodconverter.filter.AbstractFilterChain
-
- processManager(ProcessManager) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
-
Provides a specific
ProcessManager
implementation to be used when dealing with an
office process (retrieve PID, kill process).
- processManager(String) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
-
Provides a custom
ProcessManager
implementation, which may not be included in the
standard JODConverter distribution.
- ProcessManager - Interface in org.jodconverter.process
-
Provides services required to manage a running process.
- ProcessQuery - Class in org.jodconverter.process
-
Contains the required information used to query for a running process.
- ProcessQuery(String, String) - Constructor for class org.jodconverter.process.ProcessQuery
-
Constructs a new instance with the given command and argument.
- processRetryInterval(long) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
-
Specifies the delay, in milliseconds, between each try when trying to execute an office
process call (start/terminate).
- processTimeout(long) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
-
Specifies the timeout, in milliseconds, when trying to execute an office process call
(start/terminate).
- property(String, Object) - Static method in class org.jodconverter.office.LocalOfficeUtils
-
Creates a PropertyValue
with the specified name and value.
- PureJavaProcessManager - Class in org.jodconverter.process
-
- PureJavaProcessManager() - Constructor for class org.jodconverter.process.PureJavaProcessManager
-
- setConnectionProtocol(OfficeConnectionProtocol) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Sets the connection protocol.
- setConnectionProtocol(OfficeConnectionProtocol) - Method in class org.jodconverter.office.ExternalOfficeManagerBuilder
-
Sets the connection protocol.
- setConnectOnStart(boolean) - Method in class org.jodconverter.office.ExternalOfficeManagerBuilder
-
Sets whether a connection is attempted on start.
- setConnectTimeout(long) - Method in class org.jodconverter.office.ExternalOfficeManagerBuilder
-
Sets the timeout after which a connection attempt will fail.
- setDefaultLoadProperties(Map<String, Object>) - Method in class org.jodconverter.OfficeDocumentConverter
-
Sets the default properties to use when we load (open) a document before a conversion,
regardless the input type of the document.
- setKillExistingProcess(boolean) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Specifies if an existing office process is killed when starting a new office process for the
same connection string.
- setMaxTasksPerProcess(int) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Specifies the maximum number of tasks an office process can execute before restarting.
- setOfficeHome(File) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Specifies the office home directory (office installation).
- setOfficeHome(String) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Specifies the office home directory (office installation).
- setPipeName(String) - Method in class org.jodconverter.office.ExternalOfficeManagerBuilder
-
Sets the pipe name that will be use to communicate with office.
- setPipeNames(String...) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Specifies the pipe names that will be use to communicate with office.
- setPortNumber(int) - Method in class org.jodconverter.office.ExternalOfficeManagerBuilder
-
Sets the port number that will be use to communicate with office.
- setPortNumbers(int...) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Specifies the port numbers that will be use to communicate with office.
- setProcessManager(ProcessManager) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Provides a specific
ProcessManager
implementation to be used when dealing with an
office process (retrieve PID, kill process).
- setProcessManager(String) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Provides a custom
ProcessManager
implementation, which may not be included in the
standard JODConverter distribution.
- setRetryInterval(long) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
- setRetryTimeout(long) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
- setRunAsArgs(String...) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Specifies the sudo arguments that will be used with unix commands.
- setRunAsArgs(String[]) - Method in class org.jodconverter.process.UnixProcessManager
-
Sets The sudo command arguments.
- setTaskExecutionTimeout(long) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Specifies the maximum time allowed to process a task.
- setTaskQueueTimeout(long) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Specifies the maximum living time of a task in the conversion queue.
- setTemplateProfileDir(File) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Specifies the directory to copy to the temporary office profile directories to be created.
- setTemplateProfileDir(String) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Specifies the directory to copy to the temporary office profile directories to be created.
- setWorkingDir(File) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Specifies the directory where temporary office profile directories will be created.
- setWorkingDir(String) - Method in class org.jodconverter.office.DefaultOfficeManagerBuilder
-
Deprecated.
Specifies the directory where temporary office profile directories will be created.
- stopQuietly(OfficeManager) - Static method in class org.jodconverter.office.LocalOfficeUtils
-
Stops an OfficeManager
unconditionally.
- storeProperties(Map<String, Object>) - Method in class org.jodconverter.LocalConverter.Builder
-
Specifies the properties that will be applied when a document is stored during the conversion
task.
- TableOfContentUpdaterFilter - Class in org.jodconverter.filter.text
-
This filter update all indexes in a document.
- TableOfContentUpdaterFilter() - Constructor for class org.jodconverter.filter.text.TableOfContentUpdaterFilter
-
Creates a new filter that will update the table of content.
- TableOfContentUpdaterFilter(int) - Constructor for class org.jodconverter.filter.text.TableOfContentUpdaterFilter
-
Creates a new filter that will change the number of levels of the table of content and will
update it.
- templateProfileDir(File) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
-
Specifies the directory to copy to the temporary office profile directories to be created.
- templateProfileDir(String) - Method in class org.jodconverter.office.LocalOfficeManager.Builder
-
Specifies the directory to copy to the temporary office profile directories to be created.
- TextInserterFilter - Class in org.jodconverter.filter.text
-
This filter is used to insert text into a document.
- TextInserterFilter(String, int, int, int, int) - Constructor for class org.jodconverter.filter.text.TextInserterFilter
-
Creates a new filter that will insert the specified text at the specified location while
converting a document.
- TextInserterFilter(String, int, int, Map<String, Object>) - Constructor for class org.jodconverter.filter.text.TextInserterFilter
-
Creates a new filter that will insert the specified text at the specified location while
converting a document.
- TextReplacerFilter - Class in org.jodconverter.filter.text
-
This filter is used to replace text in a document.
- TextReplacerFilter(String[], String[]) - Constructor for class org.jodconverter.filter.text.TextReplacerFilter
-
Creates a new filter with the specified strings to replace.
- toOfficeSize(Dimension) - Static method in class org.jodconverter.filter.text.AbstractTextContentInserterFilter
-
Converts the specified size where units are millimeters to an office size where unit are 1/100
millimeters.
- toUnoProperties(Map<String, Object>) - Static method in class org.jodconverter.office.LocalOfficeUtils
-
Converts a regular java map to an array of PropertyValue
, usable as arguments with UNO
interface types.
- toUrl(File) - Static method in class org.jodconverter.office.LocalOfficeUtils
-
Constructs an URL from the specified file as expected by office.