Package io.keikai.axyra.sheets.content

Enum Class FormControlType

java.lang.Object
java.lang.Enum<FormControlType>
io.keikai.axyra.sheets.content.FormControlType
All Implemented Interfaces:
Serializable, Comparable<FormControlType>, Constable
public enum FormControlType extends Enum<FormControlType>
The kind of a worksheet form control (the classic Form Controls group on Excel's Developer tab), matching the OOXML ctrlProp objectType families (ECMA-376 Part 1 §18.3.1.13 plus the <formControlPr> part).

  • Enum Constant Details

    • CHECK_BOX

      public static final FormControlType CHECK_BOX
      A check box with an on/off state.

    • OPTION_BUTTON

      public static final FormControlType OPTION_BUTTON
      An option (radio) button; buttons in one group box exclude each other.

    • BUTTON

      public static final FormControlType BUTTON
      A push button.

    • COMBO_BOX

      public static final FormControlType COMBO_BOX
      A drop-down list fed by a list-fill range.

    • LIST_BOX

      public static final FormControlType LIST_BOX
      A list of items fed by a list-fill range.

    • SCROLL_BAR

      public static final FormControlType SCROLL_BAR
      A scroll bar with a value between a minimum and a maximum.

    • SPIN_BUTTON

      public static final FormControlType SPIN_BUTTON
      Up/down arrows that step a value between a minimum and a maximum.

    • EDIT_BOX

      public static final FormControlType EDIT_BOX
      A text edit box (a dialog-sheet control).

    • LABEL

      public static final FormControlType LABEL
      Static caption text.

    • GROUP_BOX

      public static final FormControlType GROUP_BOX
      A frame that groups option buttons.

    • UNKNOWN

      public static final FormControlType UNKNOWN
      A control the engine could not classify, read from a file. It cannot be written: adding or updating a control of this type throws AxyraException.

  • Method Details

    • values

      public static FormControlType[] 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 FormControlType 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

    • code

      public String code()
      The wire token used across the native boundary.

    • fromCode

      public static FormControlType fromCode(String code)
      The type for a wire token; UNKNOWN for unrecognized tokens.