com.f1j.ss
Interface Constants

All Known Subinterfaces:
Book, BookModel, Sheet
All Known Implementing Classes:
ReadResults, SheetImpl, BookImpl, com.f1j.swing.ui.ss.Dialog, com.f1j.swing.ui.ss.TabDialog

public interface Constants
extends Constants

this class contains numerous constant values of use in the API.


Field Summary
static short eClearAll
          Clears data, formats, and objects.
static short eClearContents
          Clears cell data but leaves formatting intact.
static short eClearDlg
          Displays the Clear dialog box.
static short eClearFormats
          Clears formats only.
static short eClearValues
          Deprecated. Replaced by #eClearContents
static short eColWidthUnitsNormal
          Column width in characters.
static short eColWidthUnitsTwips
          Column width in twips.
static short eCopyAll
          Copies formats, values, and formulas.
static short eCopyFormats
          Copies formats.
static short eCopyFormulas
          Copies formulas and data.
static short eCopyValues
          Copies the values only; the result is a value without the formula that produced it.
static short eEncryptionAuto
          Deprecated. Replaced by DocumentEncryption.AUTO
static short eEncryptionExcel97
          Deprecated. Replaced by DocumentEncryption.EXCEL97
static short eEncryptionWeak
          Deprecated. Replaced by DocumentEncryption.WEAK
static short eFileActuate9
          Deprecated. Replaced by DocumentType.ACTUATE_9_WORKBOOK
static short eFileCurrentFormat
          Deprecated. Replaced by DocumentType.CURRENT_FORMAT
static short eFileESpreadsheet11
          Deprecated. Replaced by DocumentType.ESPREADSHEET_11_WORKBOOK
static short eFileExcel5
          Deprecated. Replaced by DocumentType.EXCEL_5_WORKBOOK
static short eFileExcel97
          Deprecated. Replaced by DocumentType.EXCEL_97_WORKBOOK
static short eFileExcel97And5
          Excel 97-2003 and 5.x/95 format.
static short eFileFormulaOne3
          Deprecated. Replaced by DocumentType.FORMULA_ONE_3_WORKBOOK
static short eFileFormulaOne6
          Deprecated. Replaced by DocumentType.FORMULA_ONE_6_WORKBOOK
static short eFileFormulaOne7
          Deprecated. Replaced by DocumentType.FORMULA_ONE_7_WORKBOOK
static short eFileTabbedText
          Deprecated. Replaced by DocumentType.TABBED_TEXT
static short eFileTabbedTextValuesOnly
          Deprecated. Replaced by DocumentType.TABBED_TEXT_VALUES_ONLY
static short eFileUnicodeText
          Deprecated. Replaced by DocumentType.UNICODE_TEXT
static short eFileUnicodeTextValuesOnly
          Deprecated. Replaced by DocumentType.UNICODE_TEXT_VALUES_ONLY
static short eFixupAppend
          Append cells to a range during an insert.
static short eFixupIgnoreAdjacentRanges
          Ignore Adjacent Ranges
static short eFixupPrepend
          Prepend cells to a range during an insert.
static short eOutlineCollapsed
          Collapsed rows/columns in an outline.
static short eOutlineExpanded
          Expanded rows/columns in an outline.
static short eOutlineTerminal
          Terminals or leaf node rows/columns in an outline.
static short eParamCurrency
          Parameter Type - Currency
static short eParamDate
          Parameter Type - Date
static short eParamDouble
          Parameter Type - double
static short eParametersFileActuate5
          Deprecated. e.Spreadsheet 12 and up no longer write ROP files.
static short eParametersFileActuate6
          Deprecated. e.Spreadsheet 12 and up no longer write ROP files.
static short eParametersFileActuate7
          Deprecated. e.Spreadsheet 12 and up no longer write ROP files.
static short eParametersFileActuate8
          Deprecated. e.Spreadsheet 12 and up no longer write ROP files.
static short eParamFormula
          Parameter Type - Formula
static short eParamInteger
          Parameter Type - Integer
static short eParamString
          Parameter Type - String
static short eQueryParamCurrency
          Parameter Type - Currency
static short eQueryParamDate
          Parameter Type - Date
static short eQueryParamDouble
          Parameter Type - double
static short eQueryParamFormula
          Parameter Type - Formula
static short eQueryParamInteger
          Parameter Type - Integer
static short eQueryParamString
          Parameter Type - String
static short eSheetHidden
          Indicates the sheet is hidden.
static short eSheetShown
          Indicates the sheet is not hidden.
static short eSheetTypeChart
          Chartsheet sheet type.
static short eSheetTypeSheet
          Worksheet sheet type.
static short eSheetVeryHidden
          Indicates the sheet is hidden and the user is not allowed to unhide it via the Workbook Designer.
static short eShiftColumns
          Columns in which the range resides are deleted.
static short eShiftHorizontal
          Cells to the right of the range are shifted left to fill the vacated space.
static short eShiftRows
          Rows in which the range resides are deleted.
static short eShiftVertical
          Cells below the range are shifted up to fill the vacated space.
static short eShowAutomatic
          Selections or scroll bars are displayed if book or control is active.
static short eShowOff
          Selections or scrollbars are hidden.
static short eShowOn
          Selections or scrollbars are displayed.
static short eTabsBottom
          Tabs appear at the bottom of worksheets.
static short eTabsOff
          Tabs do not appear on worksheets.
static short eTabsTop
          Tabs appear at the top of worksheets.
static short eTypeEmpty
          Indicates an empty cell.
static short eTypeError
          Indicates the cell contains an error.
static short eTypeLogical
          Indicates a logical cell.
static short eTypeNumber
          Indicates a number cell.
static short eTypeText
          Indicates a text cell.
static int kAllowDefault
          Sheet protection allows default standard operations.
static int kAllowDeleteColumns
          Sheet protection allows Delete columns.
static int kAllowDeleteRows
          Sheet protection allows Delete rows.
static int kAllowEditObjects
          Sheet protection allows Edit objects.
static int kAllowFormatCells
          Sheet protection allows Format cells.
static int kAllowFormatColumns
          Sheet protection allows Format columns.
static int kAllowFormatRows
          Sheet protection allows Format rows.
static int kAllowInsertColumns
          Sheet protection allows Insert columns.
static int kAllowInsertHyperlinks
          Sheet protection allows Insert hyperlinks.
static int kAllowInsertRows
          Sheet protection allows Insert rows.
static int kAllowNone
          Sheet protection allows nothing.
static int kAllowSelectLocked
          Sheet protection allows Select locked cells.
static int kAllowSelectUnlocked
          Sheet protection allows Select unlocked cells.
static int kAllowSort
          Sheet protection allows Sort.
static int kAllowUseAutoFilter
          Sheet protection allows Use AutoFilter.
static int kAllowUsePivotRanges
          Sheet protection allows Use PivotRange reports.
static int kCodePageDefaultANSI
          default ANSI (language-specific) code page.
static int kCodePageUnicodeBE
          Unicode Big Endian (UTF-16) code page.
static int kCodePageUnicodeLE
          Unicode Little Endian (UTF-16) code page.
static int kCodePageUTF8
          UTF-8 code page.
static int kContentsChanged
          Cell contents were changed in an entry method.
static int kFontChanged
          Font was changed in an entry method.
static int kFormatChanged
          Format was changed in an entry method.
static int kMaxCellText
          The maximum length of text in a cell.
static int kMaxCol
          The maximum column number.
static int kMaxCols
          The maximum number of columns.
static int kMaxPaletteEntry
          The maximum number of palatte entries.
static int kMaxRow
          The maximum row number.
static int kMaxRows
          The maximum number of rows.
static int kMaxSheet
          The maximum sheet number.
static int kMaxSheets
          The maximum number of sheets.
static int kProtectStructure
          Workbook structure is protected.
 
Fields inherited from class com.f1j.mvc.Constants
kPaper10x14, kPaper11x17, kPaperA3, kPaperA4, kPaperA4Small, kPaperA5, kPaperB4, kPaperB5, kPaperCSheet, kPaperDSheet, kPaperEnv10, kPaperEnv11, kPaperEnv12, kPaperEnv14, kPaperEnv9, kPaperEnvB4, kPaperEnvB5, kPaperEnvB6, kPaperEnvC3, kPaperEnvC4, kPaperEnvC5, kPaperEnvC6, kPaperEnvC65, kPaperEnvDL, kPaperEnvItaly, kPaperEnvMonarch, kPaperEnvPersonal, kPaperESheet, kPaperExecutive, kPaperFanfoldLglGerman, kPaperFanfoldStdGerman, kPaperFanfoldUS, kPaperFolio, kPaperLedger, kPaperLegal, kPaperLetter, kPaperLetterSmall, kPaperNote, kPaperQuarto, kPaperStatement, kPaperTabloid
 

Field Detail

eFileExcel5

public static final short eFileExcel5
Deprecated. Replaced by DocumentType.EXCEL_5_WORKBOOK
Excel 5.x/95 format.

eFileExcel97

public static final short eFileExcel97
Deprecated. Replaced by DocumentType.EXCEL_97_WORKBOOK
Excel 97-2003 format.

eFileExcel97And5

public static final short eFileExcel97And5
Excel 97-2003 and 5.x/95 format.

eFileFormulaOne3

public static final short eFileFormulaOne3
Deprecated. Replaced by DocumentType.FORMULA_ONE_3_WORKBOOK
Previous (Formula One versions 3-5) e.Spreadsheet format.

eFileFormulaOne6

public static final short eFileFormulaOne6
Deprecated. Replaced by DocumentType.FORMULA_ONE_6_WORKBOOK
Previous (Formula One version 6) e.Spreadsheet format.

eFileFormulaOne7

public static final short eFileFormulaOne7
Deprecated. Replaced by DocumentType.FORMULA_ONE_7_WORKBOOK
Previous (Formula One version 7) e.Spreadsheet format.

eFileESpreadsheet11

public static final short eFileESpreadsheet11
Deprecated. Replaced by DocumentType.ESPREADSHEET_11_WORKBOOK
e.Spreadsheet 11 format.

eFileActuate9

public static final short eFileActuate9
Deprecated. Replaced by DocumentType.ACTUATE_9_WORKBOOK
Actuate 9 format.

eFileTabbedText

public static final short eFileTabbedText
Deprecated. Replaced by DocumentType.TABBED_TEXT
Tab-delimited text.

eFileTabbedTextValuesOnly

public static final short eFileTabbedTextValuesOnly
Deprecated. Replaced by DocumentType.TABBED_TEXT_VALUES_ONLY
Tab-delimited text, values only.

eFileUnicodeText

public static final short eFileUnicodeText
Deprecated. Replaced by DocumentType.UNICODE_TEXT
Tab-delimited Unicode text.

eFileUnicodeTextValuesOnly

public static final short eFileUnicodeTextValuesOnly
Deprecated. Replaced by DocumentType.UNICODE_TEXT_VALUES_ONLY
Tab-delimited Unicode text, values only.

eFixupPrepend

public static final short eFixupPrepend
Prepend cells to a range during an insert.

eFixupAppend

public static final short eFixupAppend
Append cells to a range during an insert.

eFixupIgnoreAdjacentRanges

public static final short eFixupIgnoreAdjacentRanges
Ignore Adjacent Ranges

eFileCurrentFormat

public static final short eFileCurrentFormat
Deprecated. Replaced by DocumentType.CURRENT_FORMAT
Current e.Spreadsheet file format.

eParametersFileActuate5

public static final short eParametersFileActuate5
Deprecated. e.Spreadsheet 12 and up no longer write ROP files.
Actuate 5 ROP file format.

eParametersFileActuate6

public static final short eParametersFileActuate6
Deprecated. e.Spreadsheet 12 and up no longer write ROP files.
Actuate 6 ROP file format.

eParametersFileActuate7

public static final short eParametersFileActuate7
Deprecated. e.Spreadsheet 12 and up no longer write ROP files.
Actuate 7 ROP file format.

eParametersFileActuate8

public static final short eParametersFileActuate8
Deprecated. e.Spreadsheet 12 and up no longer write ROP files.
Actuate 8 ROP file format.

eClearDlg

public static final short eClearDlg
Displays the Clear dialog box.

eClearFormats

public static final short eClearFormats
Clears formats only.

eClearContents

public static final short eClearContents
Clears cell data but leaves formatting intact.
Since:
11.0.1

eClearValues

public static final short eClearValues
Deprecated. Replaced by #eClearContents
Clears values only.

eClearAll

public static final short eClearAll
Clears data, formats, and objects.

eColWidthUnitsNormal

public static final short eColWidthUnitsNormal
Column width in characters.

eColWidthUnitsTwips

public static final short eColWidthUnitsTwips
Column width in twips.

eCopyAll

public static final short eCopyAll
Copies formats, values, and formulas.

eCopyFormats

public static final short eCopyFormats
Copies formats.

eCopyFormulas

public static final short eCopyFormulas
Copies formulas and data.

eCopyValues

public static final short eCopyValues
Copies the values only; the result is a value without the formula that produced it.

eShiftHorizontal

public static final short eShiftHorizontal
Cells to the right of the range are shifted left to fill the vacated space.

eShiftVertical

public static final short eShiftVertical
Cells below the range are shifted up to fill the vacated space.

eShiftRows

public static final short eShiftRows
Rows in which the range resides are deleted. Lower rows are shifted up to fill the vacated space.

eShiftColumns

public static final short eShiftColumns
Columns in which the range resides are deleted. The rightmost columns are shifted left to fill the vacated space.

eShowAutomatic

public static final short eShowAutomatic
Selections or scroll bars are displayed if book or control is active.

eShowOff

public static final short eShowOff
Selections or scrollbars are hidden.

eShowOn

public static final short eShowOn
Selections or scrollbars are displayed.

eTabsBottom

public static final short eTabsBottom
Tabs appear at the bottom of worksheets.

eTabsOff

public static final short eTabsOff
Tabs do not appear on worksheets.

eTabsTop

public static final short eTabsTop
Tabs appear at the top of worksheets.

eTypeEmpty

public static final short eTypeEmpty
Indicates an empty cell.

eTypeError

public static final short eTypeError
Indicates the cell contains an error.

eTypeLogical

public static final short eTypeLogical
Indicates a logical cell.

eTypeNumber

public static final short eTypeNumber
Indicates a number cell.

eTypeText

public static final short eTypeText
Indicates a text cell.

kMaxCols

public static final int kMaxCols
The maximum number of columns.

kMaxCol

public static final int kMaxCol
The maximum column number.

kMaxPaletteEntry

public static final int kMaxPaletteEntry
The maximum number of palatte entries.

kMaxRows

public static final int kMaxRows
The maximum number of rows.

kMaxRow

public static final int kMaxRow
The maximum row number.

kMaxSheets

public static final int kMaxSheets
The maximum number of sheets.

kMaxSheet

public static final int kMaxSheet
The maximum sheet number.

kMaxCellText

public static final int kMaxCellText
The maximum length of text in a cell.

eSheetShown

public static final short eSheetShown
Indicates the sheet is not hidden.

eSheetHidden

public static final short eSheetHidden
Indicates the sheet is hidden.

eSheetVeryHidden

public static final short eSheetVeryHidden
Indicates the sheet is hidden and the user is not allowed to unhide it via the Workbook Designer.

eSheetTypeSheet

public static final short eSheetTypeSheet
Worksheet sheet type. Indicates the sheet is a "normal sheet."

eSheetTypeChart

public static final short eSheetTypeChart
Chartsheet sheet type. Indicates the sheet is a "chart sheet."

eOutlineTerminal

public static final short eOutlineTerminal
Terminals or leaf node rows/columns in an outline.

eOutlineExpanded

public static final short eOutlineExpanded
Expanded rows/columns in an outline.

eOutlineCollapsed

public static final short eOutlineCollapsed
Collapsed rows/columns in an outline.

kCodePageDefaultANSI

public static final int kCodePageDefaultANSI
default ANSI (language-specific) code page.

kCodePageUnicodeLE

public static final int kCodePageUnicodeLE
Unicode Little Endian (UTF-16) code page.

kCodePageUnicodeBE

public static final int kCodePageUnicodeBE
Unicode Big Endian (UTF-16) code page.

kCodePageUTF8

public static final int kCodePageUTF8
UTF-8 code page.

eEncryptionAuto

public static final short eEncryptionAuto
Deprecated. Replaced by DocumentEncryption.AUTO
Auto-select encryption.

eEncryptionWeak

public static final short eEncryptionWeak
Deprecated. Replaced by DocumentEncryption.WEAK
Weak encryption (XOR).

eEncryptionExcel97

public static final short eEncryptionExcel97
Deprecated. Replaced by DocumentEncryption.EXCEL97
Excel 97/2000 and e.Spreadsheet (Formula One version 9) encryption.

eParamString

public static final short eParamString
Parameter Type - String

eParamInteger

public static final short eParamInteger
Parameter Type - Integer

eParamDouble

public static final short eParamDouble
Parameter Type - double

eParamDate

public static final short eParamDate
Parameter Type - Date

eParamCurrency

public static final short eParamCurrency
Parameter Type - Currency

eParamFormula

public static final short eParamFormula
Parameter Type - Formula

eQueryParamString

public static final short eQueryParamString
Parameter Type - String

eQueryParamInteger

public static final short eQueryParamInteger
Parameter Type - Integer

eQueryParamDouble

public static final short eQueryParamDouble
Parameter Type - double

eQueryParamDate

public static final short eQueryParamDate
Parameter Type - Date

eQueryParamCurrency

public static final short eQueryParamCurrency
Parameter Type - Currency

eQueryParamFormula

public static final short eQueryParamFormula
Parameter Type - Formula

kFontChanged

public static final int kFontChanged
Font was changed in an entry method.

kFormatChanged

public static final int kFormatChanged
Format was changed in an entry method.

kContentsChanged

public static final int kContentsChanged
Cell contents were changed in an entry method.

kProtectStructure

public static final int kProtectStructure
Workbook structure is protected.

kAllowNone

public static final int kAllowNone
Sheet protection allows nothing.

kAllowEditObjects

public static final int kAllowEditObjects
Sheet protection allows Edit objects.

kAllowFormatCells

public static final int kAllowFormatCells
Sheet protection allows Format cells.

kAllowFormatColumns

public static final int kAllowFormatColumns
Sheet protection allows Format columns.

kAllowFormatRows

public static final int kAllowFormatRows
Sheet protection allows Format rows.

kAllowInsertColumns

public static final int kAllowInsertColumns
Sheet protection allows Insert columns.

kAllowInsertRows

public static final int kAllowInsertRows
Sheet protection allows Insert rows.

kAllowInsertHyperlinks

public static final int kAllowInsertHyperlinks
Sheet protection allows Insert hyperlinks.

kAllowDeleteColumns

public static final int kAllowDeleteColumns
Sheet protection allows Delete columns.

kAllowDeleteRows

public static final int kAllowDeleteRows
Sheet protection allows Delete rows.

kAllowSelectLocked

public static final int kAllowSelectLocked
Sheet protection allows Select locked cells.

kAllowSort

public static final int kAllowSort
Sheet protection allows Sort.

kAllowUseAutoFilter

public static final int kAllowUseAutoFilter
Sheet protection allows Use AutoFilter.

kAllowUsePivotRanges

public static final int kAllowUsePivotRanges
Sheet protection allows Use PivotRange reports.

kAllowSelectUnlocked

public static final int kAllowSelectUnlocked
Sheet protection allows Select unlocked cells.

kAllowDefault

public static final int kAllowDefault
Sheet protection allows default standard operations. This permits the same options that are selected by default in the Designer--at this time, kAllowSelectLocked and kAllowSelectUnlockded
Since:
11.0.1