com.f1j.ss
Class DocumentType

java.lang.Object
  |
  +--com.f1j.ss.DocumentType
public final class DocumentType
extends java.lang.Object

A type-safe enumeration specifying a file format.

Since:
12.0

Field Summary
static DocumentType ACTUATE_9_REPORT_EXECUTABLE
          The Actuuate 9 report executable format (.sox).
static DocumentType ACTUATE_9_REPORT_INSTANCE
          The Actuate 9 report instance format (.soi).
static DocumentType ACTUATE_9_REPORT_VIEW
          The Actuate 9 report view format (.sov).
static DocumentType ACTUATE_9_WORKBOOK
          The Actuate 9 workbook format (.sod).
static DocumentType CURRENT_FORMAT
          The current Actuate Workbook file format.
static DocumentType ESPREADSHEET_11_WORKBOOK
          The e.Spreadsheet 11 workbook format (.vts).
static DocumentType EXCEL_5_WORKBOOK
          The Excel 5-95 workbook format (.xls).
static DocumentType EXCEL_97_REPORT_VIEW
          An Actuate 9 report view in the Excel 97-2003 workbook format (.xls).
static DocumentType EXCEL_97_WORKBOOK
          The Excel 97-2003 workbook format (.xls).
static DocumentType FORMULA_ONE_3_WORKBOOK
          The Formula One 3-5 workbook format (.vts).
static DocumentType FORMULA_ONE_6_WORKBOOK
          The Formula One 6 workbook format (.vts).
static DocumentType FORMULA_ONE_7_WORKBOOK
          The Formula One 7-10 workbook format (.vts).
static DocumentType HTML
          HTML format.
static DocumentType HTML_DATA_ONLY
          HTML format, showing plain cell data only.
static DocumentType TABBED_TEXT
          Text format, with columns tab-delimited.
static DocumentType TABBED_TEXT_VALUES_ONLY
          Text format, showing plain cell values only, with columns tab-delimited.
static DocumentType UNICODE_TEXT
          Unicode text format, with columns tab-delimited.
static DocumentType UNICODE_TEXT_VALUES_ONLY
          Unicode text format, showing plain cell values only, with columns tab-delimited.
 
Method Summary
 java.io.File appendFileExtension(java.io.File file)
          Appends the filename extension for this file type, to the specified File object.
 DocumentRole getDocumentRole()
          Returns the role of this document type.
 boolean isActuate9OrLater()
          Returns true if this document type represents an Actuate version 9 or later spreadsheet file format
 boolean isExcel97Spreadsheet()
          Returns true if this document type represents an Excel 97 spreadsheet file format.
 boolean isExcelSpreadsheet()
          Returns true if this document type represents an Excel spreadsheet file format.
 boolean isForeignSpreadsheet()
          Returns true if this document type represents a spreadsheet file format that is not the current Actuate format.
 boolean isNative()
          Returns true if this document type represents a native Actuate spreadsheet file format.
 boolean isReadOnly()
          Returns true if this document type represents a file format that is read-only.
 boolean isSpreadsheet()
          Returns true if this document type represents any spreadsheet file format.
 boolean isWriteOnly()
          Returns true if this document type represents a file format that is write-only.
 boolean supportsPasswordProtection()
          Returns true if this document type supports password protection.
 

Field Detail

EXCEL_97_WORKBOOK

public static final DocumentType EXCEL_97_WORKBOOK
The Excel 97-2003 workbook format (.xls).
See Also:
EXCEL_97_REPORT_VIEW

EXCEL_97_REPORT_VIEW

public static final DocumentType EXCEL_97_REPORT_VIEW
An Actuate 9 report view in the Excel 97-2003 workbook format (.xls).

Saving to this file format will cause the report to be run, and all report design information to be removed from the document.

See Also:
EXCEL_97_WORKBOOK
Since:
12.0.2

ACTUATE_9_WORKBOOK

public static final DocumentType ACTUATE_9_WORKBOOK
The Actuate 9 workbook format (.sod).
Since:
12.0

ACTUATE_9_REPORT_EXECUTABLE

public static final DocumentType ACTUATE_9_REPORT_EXECUTABLE
The Actuuate 9 report executable format (.sox).
Since:
12.0

ACTUATE_9_REPORT_INSTANCE

public static final DocumentType ACTUATE_9_REPORT_INSTANCE
The Actuate 9 report instance format (.soi).
Since:
12.0

ACTUATE_9_REPORT_VIEW

public static final DocumentType ACTUATE_9_REPORT_VIEW
The Actuate 9 report view format (.sov).

Saving to this file format will cause the report to be run, and all report design information to be removed from the document.

See Also:
ACTUATE_9_WORKBOOK
Since:
12.0.1

CURRENT_FORMAT

public static final DocumentType CURRENT_FORMAT
The current Actuate Workbook file format.

TABBED_TEXT

public static final DocumentType TABBED_TEXT
Text format, with columns tab-delimited.

TABBED_TEXT_VALUES_ONLY

public static final DocumentType TABBED_TEXT_VALUES_ONLY
Text format, showing plain cell values only, with columns tab-delimited.

UNICODE_TEXT

public static final DocumentType UNICODE_TEXT
Unicode text format, with columns tab-delimited.

UNICODE_TEXT_VALUES_ONLY

public static final DocumentType UNICODE_TEXT_VALUES_ONLY
Unicode text format, showing plain cell values only, with columns tab-delimited.

HTML

public static final DocumentType HTML
HTML format. This is a write-only format.

HTML_DATA_ONLY

public static final DocumentType HTML_DATA_ONLY
HTML format, showing plain cell data only. This is a write-only format.

EXCEL_5_WORKBOOK

public static final DocumentType EXCEL_5_WORKBOOK
The Excel 5-95 workbook format (.xls). This is a read-only format.

ESPREADSHEET_11_WORKBOOK

public static final DocumentType ESPREADSHEET_11_WORKBOOK
The e.Spreadsheet 11 workbook format (.vts). This is a read-only format.

FORMULA_ONE_7_WORKBOOK

public static final DocumentType FORMULA_ONE_7_WORKBOOK
The Formula One 7-10 workbook format (.vts). This is a read-only format.

FORMULA_ONE_6_WORKBOOK

public static final DocumentType FORMULA_ONE_6_WORKBOOK
The Formula One 6 workbook format (.vts). This is a read-only format.

FORMULA_ONE_3_WORKBOOK

public static final DocumentType FORMULA_ONE_3_WORKBOOK
The Formula One 3-5 workbook format (.vts). This is a read-only format.
Method Detail

appendFileExtension

public java.io.File appendFileExtension(java.io.File file)
Appends the filename extension for this file type, to the specified File object.
Parameters:
file - A file object to which the filename extension will be appended.
Returns:
A new file object with the appropriate filename extension.

isSpreadsheet

public boolean isSpreadsheet()
Returns true if this document type represents any spreadsheet file format.

isForeignSpreadsheet

public boolean isForeignSpreadsheet()
Returns true if this document type represents a spreadsheet file format that is not the current Actuate format. Note that this method returns true for both non-Actuate formats and old Actuate formats.

isActuate9OrLater

public boolean isActuate9OrLater()
Returns true if this document type represents an Actuate version 9 or later spreadsheet file format

getDocumentRole

public DocumentRole getDocumentRole()
Returns the role of this document type.
See Also:
DocumentRole

supportsPasswordProtection

public boolean supportsPasswordProtection()
Returns true if this document type supports password protection.

isNative

public boolean isNative()
Returns true if this document type represents a native Actuate spreadsheet file format.

isExcelSpreadsheet

public boolean isExcelSpreadsheet()
Returns true if this document type represents an Excel spreadsheet file format.

isExcel97Spreadsheet

public boolean isExcel97Spreadsheet()
Returns true if this document type represents an Excel 97 spreadsheet file format.

isReadOnly

public boolean isReadOnly()
Returns true if this document type represents a file format that is read-only.

isWriteOnly

public boolean isWriteOnly()
Returns true if this document type represents a file format that is write-only.