SBook (Keikai Spreadsheet Build 5.0.0 API)

All Known Implementing Classes:

AbstractBookAdv, BookImpl
```
public interface SBook
```
The root of Spreadsheet's data model which contains sheets.

Since:

3.5.0

Author:

dennis

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`addDefaultCellStyle(SCellStyle cellStyle)` Add one more default cell style and return its index.
`void`	`addEventListener(ModelEventListener listener)` add event listener to this book
`void`	`addExtraStyle(SExtraStyle extraStyle)` Add one more extra cell style.
`void`	`addNamedCellstyle(SNamedStyle namedStyle)` Add one more named cell style.
`SPictureData`	`addPictureData(SPicture.Format format, byte[] data)` Add `SPictureData` into this book
`void`	`addTableStyle(STableStyle tableStyle)` Add table style into this book.
`void`	`clearTableStyles()` Clear custom table styles of this book.
`SCellStyle`	`createCellStyle(boolean inStyleTable)` Create a cell style
`SCellStyle`	`createCellStyle(SCellStyle src, boolean inStyleTable)` Create a cell style and copy the style from the src style.
`SColor`	`createColor(byte r, byte g, byte b)`
`SColor`	`createColor(String htmlColor)`
`SFont`	`createFont(boolean inFontTable)`
`SFont`	`createFont(SFont src, boolean inFontTable)`
`SName`	`createName(String name)`
`SName`	`createName(String name, String applyToSheetName)` Create a defined name on specified sheet
`SSheet`	`createSheet(String name)` Create a sheet
`SSheet`	`createSheet(String name, SSheet src)` Create a sheet and copy the content from the specified src sheet; note the owner book of the specified src sheet can be different from this book.
`void`	`deleteName(SName name)` Delete a defined name
`void`	`deleteSheet(SSheet sheet)` Delete the sheet
`Object`	`getAttribute(String name)` Get the runtime custom attribute that stored in this book
`Map<String,Object>`	`getAttributes()` Get the unmodifiable runtime attributes map
`String`	`getBookName()` Get the book name, a book name is unique for book in `SBookSeries`
`SBookSeries`	`getBookSeries()` Get the book series, it contains a group of book that might refer to other by book name
`SCellStyle`	`getDefaultCellStyle()` Get the default style of this book
`SCellStyle`	`getDefaultCellStyle(int index)` Get the nth default style of this book
`Collection<SCellStyle>`	`getDefaultCellStyles()` Get all default cell styles.
`SFont`	`getDefaultFont()`
`String`	`getDefaultPivotStyleName()` Get default pivot style name.
`String`	`getDefaultTableStyleName()` Get default table style name
`SExtraStyle`	`getExtraStyleAt(int idx)` Get the extra style of this book
`List<SExtraStyle>`	`getExtraStyles()` Get all extra styles.
`int`	`getMaxColumnIndex()` Get the max column index of this book, it is `getMaxColumnIndex()`-1
`int`	`getMaxColumnSize()` Get the max column size of this book
`int`	`getMaxRowIndex()` Get the max row index of this book, it is `getMaxRowSize()`-1
`int`	`getMaxRowSize()` Get the max row size of this book
`SName`	`getName(int idx)`
`SName`	`getNameByName(String namename)`
`SName`	`getNameByName(String namename, String sheetName)`
`SNamedStyle`	`getNamedStyle(String name)` Get the named style of this book
`Collection<SNamedStyle>`	`getNamedStyles()` Get all name styles.
`List<SName>`	`getNames()`
`int`	`getNumOfName()`
`int`	`getNumOfSheet()` Get the number of sheet
`SCellStyle`	`getOrCreateDefaultHyperlinkStyle()` Deprecated.
`SCellStyle`	`getOrCreateDefaultHyperlinkStyle(SCell cell)` Returns existing or create SCellStyle for hyperlink on the specified cell
`SPictureData`	`getPictureData(int index)` Get `SPictureData` of the specified index from this book; null if not exist
`Collection<SPictureData>`	`getPicturesDatas()` Returns all `SPictureData` fo this book.
`String`	`getShareScope()`
`SSheet`	`getSheet(int idx)` Get sheet at the index
`SSheet`	`getSheetById(String id)` Get the sheet by id
`SSheet`	`getSheetByName(String name)` Get the sheet by name
`int`	`getSheetIndex(SSheet sheet)` Get the index of sheet
`int`	`getSheetIndex(String sheetName)` Get the index of sheet
`List<SSheet>`	`getSheets()` Get all sheets
`STableStyle`	`getTableStyle(String name)` Get table style of the specified name.
`List<STableStyle>`	`getTableStyles()` Returns table styles of this book.
`boolean`	`isDirty()` Get if book is changed
`void`	`moveSheetTo(SSheet sheet, int index)` Move the sheet to new position
`void`	`optimizeCellStyle()` Optimize CellStyle, usually called when export book or after many style operation
`void`	`removeEventListener(ModelEventListener listener)` remove event listener from this book
`SCellStyle`	`searchCellStyle(CellStyleMatcher matcher)` Search the style table and return the first matched style.
`SExtraStyle`	`searchExtraStyle(CellStyleMatcher matcher)` Search the style table and return the first matched style.
`SFont`	`searchFont(FontMatcher matcher)`
`Object`	`setAttribute(String name, Object value)` Set the runtime custom attribute to stored in this book, the attribute is only use for developer to stored runtime data in the book, values will not stored to excel when exporting.
`void`	`setDefaultCellStyle(SCellStyle cellStyle)` Set the default style of this book
`void`	`setDefaultPivotStyleName(String name)` Set default pivot style name.
`void`	`setDefaultTableStyleName(String name)` Set default table style name
`void`	`setDirty(boolean dirty)` Set dirty flag
`void`	`setNameName(SName name, String newname)`
`void`	`setNameName(SName name, String newname, String applyToSheetName)`
`void`	`setShareScope(String scope)`
`void`	`setSheetName(SSheet sheet, String newname)` Set the sheet to a new name

- Method Detail
  - getBookName
```
String getBookName()
```
    Get the book name, a book name is unique for book in SBookSeries
    
    Returns:
    
    book name;
  - getBookSeries
```
SBookSeries getBookSeries()
```
    Get the book series, it contains a group of book that might refer to other by book name
    
    Returns:
    
    book series
  - getSheet
```
SSheet getSheet(int idx)
```
    Get sheet at the index
    
    Parameters:
    
    idx - the sheet index
    
    Returns:
    
    the sheet at the index
  - getSheetIndex
```
int getSheetIndex(SSheet sheet)
```
    Get the index of sheet
    
    Parameters:
    
    sheet - the sheet
    
    Returns:
    
    the index
  - getSheetIndex
```
int getSheetIndex(String sheetName)
```
    Get the index of sheet
    
    Parameters:
    
    sheet - the sheet
    
    Returns:
    
    the index
    
    Since:
    
    3.6.0
  - getNumOfSheet
```
int getNumOfSheet()
```
    Get the number of sheet
    
    Returns:
    
    the number of sheet
  - getSheetByName
```
SSheet getSheetByName(String name)
```
    Get the sheet by name
    
    Parameters:
    
    name - the name of sheet
    
    Returns:
    
    the sheet, or null if not found
  - getSheetById
```
SSheet getSheetById(String id)
```
    Get the sheet by id
    
    Parameters:
    
    id - the id of sheet
    
    Returns:
    
    the sheet, or null if not found
  - createSheet
```
SSheet createSheet(String name)
```
    Create a sheet
    
    Parameters:
    
    name - the name of sheet
    
    Returns:
    
    the sheet
  - getSheets
```
List<SSheet> getSheets()
```
    Get all sheets
    
    Returns:
    
    an unmodifiable sheet list
  - createSheet
```
SSheet createSheet(String name,
                   SSheet src)
```
    Create a sheet and copy the content from the specified src sheet; note the owner book of the specified src sheet can be different from this book.
    
    Parameters:
    
    name - the name of the new created sheet; null would try to use the sheet name of the specified src sheet; if the same sheet name already used in this book then use default "SheetX" name where X is the next sheet number of this book.
    
    src - the source sheet to copy
    
    Returns:
    
    the sheet
  - setSheetName
```
void setSheetName(SSheet sheet,
                  String newname)
```
    Set the sheet to a new name
    
    Parameters:
    
    sheet - the sheet
    
    newname - the new name
  - deleteSheet
```
void deleteSheet(SSheet sheet)
```
    Delete the sheet
    
    Parameters:
    
    sheet - the sheet
  - moveSheetTo
```
void moveSheetTo(SSheet sheet,
                 int index)
```
    Move the sheet to new position
    
    Parameters:
    
    sheet - the sheet
    
    index - the new position
  - getDefaultCellStyle
```
SCellStyle getDefaultCellStyle()
```
    Get the default style of this book
    
    Returns:
  - setDefaultCellStyle
```
void setDefaultCellStyle(SCellStyle cellStyle)
```
    Set the default style of this book
    
    Since:
    
    3.6.0
  - createCellStyle
```
SCellStyle createCellStyle(boolean inStyleTable)
```
    Create a cell style
    
    Parameters:
    
    inStyleTable - if true, the new created style will be stored inside this book, then you can use searchCellStyle(CellStyleMatcher) to search and reuse this style.
    
    Returns:
  - createCellStyle
```
SCellStyle createCellStyle(SCellStyle src,
                           boolean inStyleTable)
```
    Create a cell style and copy the style from the src style.
    
    Parameters:
    
    src - the source style to copy from.
    
    inStyleTable - if true, the new created style will be stored inside this book, then you can use searchCellStyle(CellStyleMatcher) to search and reuse this style.
    
    Returns:
  - searchCellStyle
```
SCellStyle searchCellStyle(CellStyleMatcher matcher)
```
    Search the style table and return the first matched style.
    
    Parameters:
    
    matcher - the style matcher
    
    Returns:
    
    the matched style.
  - searchExtraStyle
```
SExtraStyle searchExtraStyle(CellStyleMatcher matcher)
```
    Search the style table and return the first matched style.
    
    Parameters:
    
    matcher - the style matcher
    
    Returns:
    
    the matched style.
    
    Since:
    
    3.9.0
  - getDefaultFont
```
SFont getDefaultFont()
```
  - createFont
```
SFont createFont(boolean inFontTable)
```
  - createFont
```
SFont createFont(SFont src,
                 boolean inFontTable)
```
  - searchFont
```
SFont searchFont(FontMatcher matcher)
```
  - createColor
```
SColor createColor(byte r,
                   byte g,
                   byte b)
```
  - createColor
```
SColor createColor(String htmlColor)
```
  - getMaxRowSize
```
int getMaxRowSize()
```
    Get the max row size of this book
  - getMaxColumnSize
```
int getMaxColumnSize()
```
    Get the max column size of this book
  - getMaxRowIndex
```
int getMaxRowIndex()
```
    Get the max row index of this book, it is getMaxRowSize()-1
  - getMaxColumnIndex
```
int getMaxColumnIndex()
```
    Get the max column index of this book, it is getMaxColumnIndex()-1
  - addEventListener
```
void addEventListener(ModelEventListener listener)
```
    add event listener to this book
    
    Parameters:
    
    listener - the listener
  - removeEventListener
```
void removeEventListener(ModelEventListener listener)
```
    remove event listener from this book
    
    Parameters:
    
    listener - the listener
  - getAttribute
```
Object getAttribute(String name)
```
    Get the runtime custom attribute that stored in this book
    
    Parameters:
    
    name - the attribute name
    
    Returns:
    
    the value, or null if not found
  - setAttribute
```
Object setAttribute(String name,
                    Object value)
```
    Set the runtime custom attribute to stored in this book, the attribute is only use for developer to stored runtime data in the book, values will not stored to excel when exporting.
    
    Parameters:
    
    name - name the attribute name
    
    value - the attribute value
  - getAttributes
```
Map<String,Object> getAttributes()
```
    Get the unmodifiable runtime attributes map
    
    Returns:
  - createName
```
SName createName(String name,
                 String applyToSheetName)
```
    Create a defined name on specified sheet
    
    Returns:
    
    created defined name
  - createName
```
SName createName(String name)
```
  - setNameName
```
void setNameName(SName name,
                 String newname,
                 String applyToSheetName)
```
  - setNameName
```
void setNameName(SName name,
                 String newname)
```
  - deleteName
```
void deleteName(SName name)
```
    Delete a defined name
  - getNumOfName
```
int getNumOfName()
```
  - getName
```
SName getName(int idx)
```
  - getNameByName
```
SName getNameByName(String namename,
                    String sheetName)
```
  - getNameByName
```
SName getNameByName(String namename)
```
  - getNames
```
List<SName> getNames()
```
  - setShareScope
```
void setShareScope(String scope)
```
  - getShareScope
```
String getShareScope()
```
  - optimizeCellStyle
```
void optimizeCellStyle()
```
    Optimize CellStyle, usually called when export book or after many style operation
  - addPictureData
```
SPictureData addPictureData(SPicture.Format format,
                            byte[] data)
```
    Add SPictureData into this book
    
    Parameters:
    
    format - picture format
    
    data - picture raw data
    
    Returns:
    
    the created SPictureData
    
    Since:
    
    3.6.0
  - getPictureData
```
SPictureData getPictureData(int index)
```
    Get SPictureData of the specified index from this book; null if not exist
    
    Parameters:
    
    index -
    
    Returns:
    
    SPictureData of the specified index from this book; null if not exist
    
    Since:
    
    3.6.0
  - getPicturesDatas
```
Collection<SPictureData> getPicturesDatas()
```
    Returns all SPictureData fo this book.
    
    Since:
    
    3.6.0
  - getDefaultCellStyle
```
SCellStyle getDefaultCellStyle(int index)
```
    Get the nth default style of this book
    
    Returns:
    
    Since:
    
    3.7.0
  - addDefaultCellStyle
```
int addDefaultCellStyle(SCellStyle cellStyle)
```
    Add one more default cell style and return its index.
    
    Parameters:
    
    cellStyle -
    
    Since:
    
    3.7.0
  - getNamedStyle
```
SNamedStyle getNamedStyle(String name)
```
    Get the named style of this book
    
    Parameters:
    
    name -
    
    Returns:
    
    Since:
    
    3.7.0
  - addNamedCellstyle
```
void addNamedCellstyle(SNamedStyle namedStyle)
```
    Add one more named cell style.
    
    Parameters:
    
    namedStyle -
    
    Since:
    
    3.7.0
  - getDefaultCellStyles
```
Collection<SCellStyle> getDefaultCellStyles()
```
    Get all default cell styles.
    
    Returns:
    
    Since:
    
    3.7.0
  - getNamedStyles
```
Collection<SNamedStyle> getNamedStyles()
```
    Get all name styles.
    
    Returns:
    
    Since:
    
    3.7.0
  - isDirty
```
boolean isDirty()
```
    Get if book is changed
    
    Returns:
    
    Since:
    
    3.8.0
    
    See Also:
    
    #resetDirty()
  - setDirty
```
void setDirty(boolean dirty)
```
    Set dirty flag
    
    Parameters:
    
    dirty -
    
    Since:
    
    3.8.0
    
    See Also:
    
    isDirty()
  - getOrCreateDefaultHyperlinkStyle
```
@Deprecated
SCellStyle getOrCreateDefaultHyperlinkStyle()
```
    Deprecated.
    
    Returns existing or create SCellStyle for hyperlink.
    
    Returns:
    
    Since:
    
    3.8.0
  - getOrCreateDefaultHyperlinkStyle
```
SCellStyle getOrCreateDefaultHyperlinkStyle(SCell cell)
```
    Returns existing or create SCellStyle for hyperlink on the specified cell
    
    Parameters:
    
    cell -
    
    Returns:
    
    Since:
    
    3.9.1
  - getExtraStyleAt
```
SExtraStyle getExtraStyleAt(int idx)
```
    Get the extra style of this book
    
    Parameters:
    
    name -
    
    Returns:
    
    Since:
    
    3.8.2
  - addExtraStyle
```
void addExtraStyle(SExtraStyle extraStyle)
```
    Add one more extra cell style.
    
    Parameters:
    
    extraStyle -
    
    Since:
    
    3.8.2
  - getExtraStyles
```
List<SExtraStyle> getExtraStyles()
```
    Get all extra styles.
    
    Returns:
    
    Since:
    
    3.8.2
  - getTableStyle
```
STableStyle getTableStyle(String name)
```
    Get table style of the specified name.
    
    Parameters:
    
    name -
    
    Returns:
    
    Since:
    
    3.8.3
  - addTableStyle
```
void addTableStyle(STableStyle tableStyle)
```
    Add table style into this book.
    
    Parameters:
    
    tableStyle -
    
    Since:
    
    3.8.3
  - getTableStyles
```
List<STableStyle> getTableStyles()
```
    Returns table styles of this book.
    
    Returns:
    
    Since:
    
    3.8.3
  - clearTableStyles
```
void clearTableStyles()
```
    Clear custom table styles of this book.
    
    Since:
    
    3.8.3
  - setDefaultPivotStyleName
```
void setDefaultPivotStyleName(String name)
```
    Set default pivot style name.
    
    Parameters:
    
    name -
    
    Since:
    
    3.8.3
  - getDefaultPivotStyleName
```
String getDefaultPivotStyleName()
```
    Get default pivot style name.
    
    Returns:
    
    Since:
    
    3.8.3
  - setDefaultTableStyleName
```
void setDefaultTableStyleName(String name)
```
    Set default table style name
    
    Parameters:
    
    name -
    
    Since:
    
    3.8.3
  - getDefaultTableStyleName
```
String getDefaultTableStyleName()
```
    Get default table style name
    
    Returns:
    
    Since:
    
    3.8.3

Interface SBook

Method Summary

Method Detail

getBookName

getBookSeries

getSheet

getSheetIndex

getSheetIndex

getNumOfSheet

getSheetByName

getSheetById

createSheet

getSheets

createSheet

setSheetName

deleteSheet

moveSheetTo

getDefaultCellStyle

setDefaultCellStyle

createCellStyle

createCellStyle

searchCellStyle

searchExtraStyle

getDefaultFont

createFont

createFont

searchFont

createColor

createColor

getMaxRowSize

getMaxColumnSize

getMaxRowIndex

getMaxColumnIndex

addEventListener

removeEventListener

getAttribute

setAttribute

getAttributes

createName

createName

setNameName

setNameName

deleteName

getNumOfName

getName

getNameByName

getNameByName

getNames

setShareScope

getShareScope

optimizeCellStyle

addPictureData

getPictureData

getPicturesDatas

getDefaultCellStyle

addDefaultCellStyle

getNamedStyle

addNamedCellstyle

getDefaultCellStyles

getNamedStyles

isDirty

setDirty

getOrCreateDefaultHyperlinkStyle

getOrCreateDefaultHyperlinkStyle

getExtraStyleAt

addExtraStyle

getExtraStyles

getTableStyle

addTableStyle

getTableStyles

clearTableStyles

setDefaultPivotStyleName

getDefaultPivotStyleName

setDefaultTableStyleName

getDefaultTableStyleName