Package io.keikai.model

Interface SFormControl

All Known Implementing Classes:
AbstractFormControlAdv, ButtonControlImpl, CheckBoxControlImpl, ComboBoxControlImpl, GroupBoxControlImpl, LabelControlImpl, ListBoxControlImpl, RadioButtonControlImpl, ScrollBarControlImpl, SpinButtonControlImpl, TextBoxControlImpl
public interface SFormControl
Represents a form control placed on a sheet. Form controls include check boxes, radio buttons, combo boxes, scroll bars, etc.

Reference: ECMA-376 Part 4, Section 3.3 - SpreadsheetML / Form Controls

Since:
7.0.0

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static enum 
    SFormControl.ControlType
    Types of form controls supported by Excel/OOXML.

  • Method Summary

    Modifier and Type
    Method
    Description
    ViewAnchor
    getAnchor()
    Returns the anchor that positions this form control on the sheet.
    String
    getLinkedCell()
    Returns the cell reference string for value binding (e.g., "$A$1").
    String
    getListFillRange()
    Returns the range reference for populating combo box or list box items (e.g., "$B$1:$B$10").
    String
    getName()
    Returns the name of this form control.
    SFormControl.ControlType
    getType()
    Returns the type of this form control.
    boolean
    isEnabled()
    Returns whether this form control is enabled for interaction.
    boolean
    isVisible()
    Returns whether this form control is visible.
    void
    setLinkedCell(String ref)
    Sets the cell reference for value binding.
    void
    setListFillRange(String ref)
    Sets the range reference for populating combo box or list box items.

  • Method Details

    • getType

      SFormControl.ControlType getType()
      Returns the type of this form control.
      Returns:
      the control type

    • getName

      String getName()
      Returns the name of this form control.
      Returns:
      the control name

    • getAnchor

      ViewAnchor getAnchor()
      Returns the anchor that positions this form control on the sheet.
      Returns:
      the view anchor

    • getLinkedCell

      String getLinkedCell()
      Returns the cell reference string for value binding (e.g., "$A$1"). The linked cell receives the control's current value.
      Returns:
      the linked cell reference, or null if not bound

    • setLinkedCell

      void setLinkedCell(String ref)
      Sets the cell reference for value binding.
      Parameters:
      ref - the cell reference string, e.g., "$A$1"

    • getListFillRange

      String getListFillRange()
      Returns the range reference for populating combo box or list box items (e.g., "$B$1:$B$10").
      Returns:
      the list fill range reference, or null if not set

    • setListFillRange

      void setListFillRange(String ref)
      Sets the range reference for populating combo box or list box items.
      Parameters:
      ref - the range reference string

    • isEnabled

      boolean isEnabled()
      Returns whether this form control is enabled for interaction.
      Returns:
      true if enabled

    • isVisible

      boolean isVisible()
      Returns whether this form control is visible.
      Returns:
      true if visible