|
Docmosis API 4.5.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.docmosis.document.converter.ConversionFormat
This class specifies the available target formats for document production. A ConversionInstruction instance will specify the format(s) it would like the final document(s) rendered in. The available formats are public constants.
ConversionInstruction
,
Serialized FormField Summary | |
static ConversionFormat |
FORMAT_CSV
|
static ConversionFormat |
FORMAT_DOCX
Specify DOCX as the format |
static ConversionFormat |
FORMAT_FODT
Specify FODT (Flat Open Document Text) as the format |
static ConversionFormat |
FORMAT_HTML
Specify HTML as the format. |
static ConversionFormat |
FORMAT_JPG
|
static ConversionFormat |
FORMAT_ODG
|
static ConversionFormat |
FORMAT_ODP
|
static ConversionFormat |
FORMAT_ODS
|
static ConversionFormat |
FORMAT_ODT
Specify ODT (Open Document Text) as the format |
static ConversionFormat |
FORMAT_PDF
Specify PDF as the format |
static ConversionFormat |
FORMAT_PNG
|
static ConversionFormat |
FORMAT_PPT
|
static ConversionFormat |
FORMAT_RTF
Specify RTF (Rich Text Format) as the format |
static ConversionFormat |
FORMAT_TEXT
Specify TEXT as the format |
static ConversionFormat |
FORMAT_WORD
Specify Word as the format |
static ConversionFormat |
FORMAT_WORD_XML
Specify Word XML as the format |
static ConversionFormat |
FORMAT_XHTML
Specify XHTML as the format |
static ConversionFormat |
FORMAT_XLS
|
static ConversionFormat |
FORMAT_XLSX
|
Method Summary | |
boolean |
equals(Object other)
|
static boolean |
fileNameMatchesFormat(String fileName,
ConversionFormat format)
Determine if the given file name matches the given format. |
String |
getAlternateExtension()
Get the alternate file extension of this format if any. |
String |
getExtension()
Get the typical file extension of this format. |
static ConversionFormat |
getFormat(String extn)
Get the format matching the given extension (eg "pdf") in a case-insensitive manner. |
static ConversionFormat[] |
getFormatArray(String extns)
Get the formats matching the given comma separated list of extensions (eg "pdf,doc") in a case-insensitive manner. |
static ConversionFormat |
getFormatForFileName(String fileName)
Get the format matching the given file name (by using the extension in a case-insensitive manner). |
String |
getFormatName()
Get the name of this format. |
static boolean |
hasCorrectExtension(String name,
ConversionFormat format)
Determine if the given file name has the correct extension for the given format. |
int |
hashCode()
|
String |
toString()
|
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final ConversionFormat FORMAT_PDF
public static final ConversionFormat FORMAT_WORD
public static final ConversionFormat FORMAT_WORD_XML
public static final ConversionFormat FORMAT_DOCX
public static final ConversionFormat FORMAT_ODT
public static final ConversionFormat FORMAT_FODT
public static final ConversionFormat FORMAT_RTF
public static final ConversionFormat FORMAT_HTML
ConversionInstruction.setCompressingSingleDocument(boolean)
)
public static final ConversionFormat FORMAT_XHTML
public static final ConversionFormat FORMAT_TEXT
public static final ConversionFormat FORMAT_XLS
public static final ConversionFormat FORMAT_XLSX
public static final ConversionFormat FORMAT_PPT
public static final ConversionFormat FORMAT_ODG
public static final ConversionFormat FORMAT_ODS
public static final ConversionFormat FORMAT_ODP
public static final ConversionFormat FORMAT_PNG
public static final ConversionFormat FORMAT_JPG
public static final ConversionFormat FORMAT_CSV
Method Detail |
public String getFormatName()
public static ConversionFormat getFormatForFileName(String fileName)
"odf" - FORMAT_ODT "htm" - FORMAT_HTML "text" - FORMAT_TEXT
fileName
- the name of the file upon which the format will be based
public static ConversionFormat getFormat(String extn)
"odf" - FORMAT_ODT "htm" - FORMAT_HTML "text" - FORMAT_TEXT
extn
- the extension to lookup (usually a file-name suffix).
public static ConversionFormat[] getFormatArray(String extns)
extns
- the comma separated list of extensions
public static boolean hasCorrectExtension(String name, ConversionFormat format)
name
- the file name to testformat
- the format to test
public String getExtension()
public String getAlternateExtension()
public static boolean fileNameMatchesFormat(String fileName, ConversionFormat format)
fileName
- the file name to testformat
- the format to compare with
public int hashCode()
public boolean equals(Object other)
public String toString()
|
Docmosis API 4.5.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |