Package io.keikai.axyra.sheets

Enum Class SheetType

java.lang.Object
java.lang.Enum<SheetType>
io.keikai.axyra.sheets.SheetType
All Implemented Interfaces:
Serializable, Comparable<SheetType>, Constable
public enum SheetType extends Enum<SheetType>
What kind of tab a Sheet is.

A workbook's sheet list is homogeneous in the file format (ECMA-376 Part 1 §18.2.20); the tab's real kind is carried by the relationship type of the part it points at — .../relationships/chartsheet (§12.3.2), .../relationships/dialogsheet (§12.3.7), and the Microsoft xlMacrosheet / xlIntlMacrosheet extensions for Excel 4.0 macro sheets.

The engine models worksheet content only, so a chart, dialog or macro tab reads back with an empty grid. A chart tab survives a save as a chart sheet: an imported one is written back unchanged, and one added with Workbook.addChartSheet(java.lang.String, io.keikai.axyra.sheets.content.Chart) is generated from its chart. A dialog or macro tab is written back as an ordinary worksheet.

  • Enum Constant Details

    • WORKSHEET

      public static final SheetType WORKSHEET
      An ordinary worksheet.

    • CHART

      public static final SheetType CHART
      A full-page chart tab.

    • DIALOG

      public static final SheetType DIALOG
      A legacy Excel 5.0 dialog sheet; saved back as an ordinary worksheet.

    • MACRO_SHEET

      public static final SheetType MACRO_SHEET
      An Excel 4.0 macro sheet; saved back as an ordinary worksheet.

    • INTERNATIONAL_MACRO_SHEET

      public static final SheetType INTERNATIONAL_MACRO_SHEET
      An international Excel 4.0 macro sheet; saved back as an ordinary worksheet.

  • Method Details

    • values

      public static SheetType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SheetType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null