Package io.keikai.api.model

Interface Book

  • All Known Implementing Classes:
    BookImpl
    public interface Book
    This interface provides entry to access Spreadsheet's data model.
    Since:
    3.0.0
    Author:
    dennis

    • Method Detail

      • getInternalBook

        SBook getInternalBook()
        get the internal model object to do advanced operation
        Note : operate on internal object will not automatically update Spreadsheet
        Returns:

      • getLock

        ReadWriteLock getLock()
        Get the read-write lock of this book
        Returns:
        Since:
        3.5.0

      • getBookName

        String getBookName()
        Gets the book name
        Returns:
        tge book name

      • getType

        Book.BookType getType()
        Gets the book type
        Returns:
        the book type

      • getSheetIndex

        int getSheetIndex​(Sheet sheet)
        Gets the index of sheet
        Parameters:
        sheet -
        Returns:
        the index of sheet or -1 if not found

      • getNumberOfSheets

        int getNumberOfSheets()
        Gets the number of sheet
        Returns:
        the number of sheet

      • getSheetAt

        Sheet getSheetAt​(int index)
        Gets sheet by index
        Parameters:
        index - index of sheet
        Returns:

      • getSheet

        Sheet getSheet​(String name)
        Gets sheet by sheet name
        Parameters:
        name - name of sheet
        Returns:
        the sheet or null if not found

      • setShareScope

        void setShareScope​(String scope)
        Sets share scope of this book, the possible value is "desktop","session","application"
        Parameters:
        scope -

      • getShareScope

        String getShareScope()
        Gets share scope of this book
        Returns:

      • hasNameRange

        boolean hasNameRange​(String name)
        check if this book has named range
        Parameters:
        name - the name to check
        Returns:
        true if it has a range of the name

      • getMaxRows

        int getMaxRows()
        Returns:
        the maximum number of usable rows in each sheet

      • getMaxColumns

        int getMaxColumns()
        Returns:
        the maximum number of usable column in each sheet

      • cloneBook

        Book cloneBook()
        Clones a new book.
        Returns:
        a new book
        Since:
        6.0.0