public class SplitOptions extends PageOptions implements ISplitOptions
Provides options for the document page splitting.
Constructor and Description |
---|
SplitOptions(int[] pageNumbers,
int splitMode)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(int splitMode,
int startNumber,
int endNumber)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(int splitMode,
int startNumber,
int endNumber,
int mode)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(SplitStreamFactory splitStreamFactory)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(SplitStreamFactory splitStreamFactory,
int[] pageNumbers)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(SplitStreamFactory splitStreamFactory,
int[] pageNumbers,
int splitMode)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(SplitStreamFactory splitStreamFactory,
int startNumber,
int endNumber)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(SplitStreamFactory splitStreamFactory,
int splitMode,
int startNumber,
int endNumber)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(SplitStreamFactory splitStreamFactory,
int startNumber,
int endNumber,
Integer mode)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(SplitStreamFactory splitStreamFactory,
int splitMode,
int startNumber,
int endNumber,
int mode)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(String filePathFormat,
int[] pageNumbers)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(String filePathFormat,
int[] pageNumbers,
int splitMode)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(String filePathFormat,
int startNumber,
int endNumber)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(String filePathFormat,
int splitMode,
int startNumber,
int endNumber)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(String filePathFormat,
int startNumber,
int endNumber,
Integer mode)
Initializes a new instance of the
SplitOptions class. |
SplitOptions(String filePathFormat,
int splitMode,
int startNumber,
int endNumber,
int mode)
Initializes a new instance of the
SplitOptions class. |
Modifier and Type | Method and Description |
---|---|
com.groupdocs.merger.domain.result.filepath.SplitFilePathInfo |
getFilePathInfo()
The output file path info.
|
int |
getMode()
Gets the mode for page splitting.
|
String |
getPathByIndex(int index,
String extension)
Gets the full file path of splitted document by index with pre-defined extension.
|
SplitStreamFactory |
getSplitStreamFactory()
SplitStreamFactory for create or release output page preview stream.
|
void |
validate(FileType fileType)
Validates the split options.
|
getPages, pages
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getPages
public SplitOptions(int[] pageNumbers, int splitMode)
Initializes a new instance of the SplitOptions
class.
pageNumbers
- Page numbers.splitMode
- The splitting mode of Mode
(getMode()
/setMode(int)
).public SplitOptions(int splitMode, int startNumber, int endNumber) throws Exception
Initializes a new instance of the SplitOptions
class.
splitMode
- The splitting mode of Mode
(getMode()
/setMode(int)
).startNumber
- The start page number.endNumber
- The end page number.Exception
public SplitOptions(int splitMode, int startNumber, int endNumber, int mode) throws Exception
Initializes a new instance of the SplitOptions
class.
splitMode
- The splitting mode of Mode
(getMode()
/setMode(int)
).startNumber
- The start page number.endNumber
- The end page number.mode
- The range mode.Exception
public SplitOptions(SplitStreamFactory splitStreamFactory)
Initializes a new instance of the SplitOptions
class.
splitStreamFactory
- The method that instantiates stream used to write output split data.public SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers)
Initializes a new instance of the SplitOptions
class.
splitStreamFactory
- The method that instantiates stream used to write output split data.pageNumbers
- Page numbers.public SplitOptions(SplitStreamFactory splitStreamFactory, int[] pageNumbers, int splitMode)
Initializes a new instance of the SplitOptions
class.
splitStreamFactory
- The method that instantiates stream used to write output split data.pageNumbers
- Page numbers.splitMode
- The splitting mode of Mode
(getMode()
/setMode(int)
).public SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber) throws Exception
Initializes a new instance of the SplitOptions
class.
splitStreamFactory
- The method that instantiates stream used to write output split data.startNumber
- The start page number.endNumber
- The end page number.Exception
public SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber) throws Exception
Initializes a new instance of the SplitOptions
class.
splitStreamFactory
- The method that instantiates stream used to write output split data.splitMode
- The splitting mode of Mode
(getMode()
/setMode(int)
).startNumber
- The start page number.endNumber
- The end page number.Exception
public SplitOptions(SplitStreamFactory splitStreamFactory, int startNumber, int endNumber, Integer mode) throws Exception
Initializes a new instance of the SplitOptions
class.
splitStreamFactory
- The method that instantiates stream used to write output split data.startNumber
- The start page number.endNumber
- The end page number.mode
- The range mode.Exception
public SplitOptions(SplitStreamFactory splitStreamFactory, int splitMode, int startNumber, int endNumber, int mode) throws Exception
Initializes a new instance of the SplitOptions
class.
splitStreamFactory
- The method that instantiates stream used to write output split data.splitMode
- The splitting mode of Mode
(getMode()
/setMode(int)
).startNumber
- The start page number.endNumber
- The end page number.mode
- The range mode.Exception
public SplitOptions(String filePathFormat, int[] pageNumbers)
Initializes a new instance of the SplitOptions
class.
filePathFormat
- The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension.pageNumbers
- Page numbers.public SplitOptions(String filePathFormat, int[] pageNumbers, int splitMode)
Initializes a new instance of the SplitOptions
class.
filePathFormat
- The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension.pageNumbers
- Page numbers.splitMode
- The splitting mode of Mode
(getMode()
/setMode(int)
).public SplitOptions(String filePathFormat, int startNumber, int endNumber) throws Exception
Initializes a new instance of the SplitOptions
class.
filePathFormat
- The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension.startNumber
- The start page number.endNumber
- The end page number.Exception
public SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber) throws Exception
Initializes a new instance of the SplitOptions
class.
filePathFormat
- The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension.splitMode
- The splitting mode of Mode
(getMode()
/setMode(int)
).startNumber
- The start page number.endNumber
- The end page number.Exception
public SplitOptions(String filePathFormat, int startNumber, int endNumber, Integer mode) throws Exception
Initializes a new instance of the SplitOptions
class.
filePathFormat
- The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension.startNumber
- The start page number.endNumber
- The end page number.mode
- The range mode.Exception
public SplitOptions(String filePathFormat, int splitMode, int startNumber, int endNumber, int mode) throws Exception
Initializes a new instance of the SplitOptions
class.
filePathFormat
- The file path format e.g. 'c:/split{0}.doc' or 'c:/split{0}.{1}' with already pre-defined extension.splitMode
- The splitting mode of Mode
(getMode()
/setMode(int)
).startNumber
- The start page number.endNumber
- The end page number.mode
- The range mode.Exception
public final com.groupdocs.merger.domain.result.filepath.SplitFilePathInfo getFilePathInfo()
The output file path info.
public final int getMode()
Gets the mode for page splitting.
getMode
in interface ISplitOptions
public final String getPathByIndex(int index, String extension)
Gets the full file path of splitted document by index with pre-defined extension.
getPathByIndex
in interface ISplitOptions
index
- Index of splitted document.extension
- Extension of file.public SplitStreamFactory getSplitStreamFactory()
SplitStreamFactory for create or release output page preview stream.
getSplitStreamFactory
in interface ISplitOptions