Package io.keikai.model

Interface SSlicer

All Known Implementing Classes:
SlicerImpl
public interface SSlicer
Represents a slicer control on a sheet, used to filter a pivot table field.
Since:
7.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearSelection()
    Clears all item selections.
    ViewAnchor
    getAnchor()
    Returns the anchor position of this slicer on the sheet.
    String
    getCaption()
    Returns the display caption.
    int
    getColumnCount()
    Returns the number of columns used to display items.
    int
    getFieldIndex()
    Returns the index of the pivot field this slicer controls.
    String
    getName()
    Returns the unique name of this slicer.
    SPivotTable
    getPivotTable()
    Returns the pivot table this slicer is connected to.
    boolean
    isItemSelected(int itemIndex)
    Returns whether the item at the given index is selected.
    void
    selectAll()
    Selects all items.
    void
    setColumnCount(int count)
    Sets the number of columns used to display items.
    void
    setItemSelected(int itemIndex, boolean selected)
    Sets the selection state for the item at the given index.

  • Method Details

    • getName

      String getName()
      Returns the unique name of this slicer.
      Returns:
      the slicer name

    • getCaption

      String getCaption()
      Returns the display caption.
      Returns:
      the caption

    • getPivotTable

      SPivotTable getPivotTable()
      Returns the pivot table this slicer is connected to.
      Returns:
      the associated pivot table

    • getFieldIndex

      int getFieldIndex()
      Returns the index of the pivot field this slicer controls.
      Returns:
      the field index

    • getColumnCount

      int getColumnCount()
      Returns the number of columns used to display items.
      Returns:
      the column count

    • setColumnCount

      void setColumnCount(int count)
      Sets the number of columns used to display items.
      Parameters:
      count - the column count

    • getAnchor

      ViewAnchor getAnchor()
      Returns the anchor position of this slicer on the sheet.
      Returns:
      the view anchor

    • isItemSelected

      boolean isItemSelected(int itemIndex)
      Returns whether the item at the given index is selected.
      Parameters:
      itemIndex - zero-based item index
      Returns:
      true if selected

    • setItemSelected

      void setItemSelected(int itemIndex, boolean selected)
      Sets the selection state for the item at the given index.
      Parameters:
      itemIndex - zero-based item index
      selected - true to select

    • selectAll

      void selectAll()
      Selects all items.

    • clearSelection

      void clearSelection()
      Clears all item selections.