Package io.keikai.model.impl

Class AbstractBookAdv

java.lang.Object

io.keikai.model.impl.AbstractBookAdv

All Implemented Interfaces:

SBook, EvaluationContributorContainer, Serializable

Direct Known Subclasses:

BookImpl

public abstract class AbstractBookAdv
extends Object
implements SBook, EvaluationContributorContainer, Serializable

Since:

3.5.0

Author:

dennis

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractBookAdv()

Method Summary

Modifier and Type	Method	Description
abstract void	addTable(STable table)
abstract void	clearDefaultCellStyles()
abstract void	clearExtraStyles()
abstract void	clearNamedStyles()
abstract SName	createTableName(STable table)
abstract int	getCharWidth()
abstract List<SColor>	getDefaultChartSeriesColors()
abstract String	getId()
abstract SFont	getOrAddFont(SFont font)	Get the font which stored in this book, or add it into the book if not found, then you can use SBook.searchFont(FontMatcher) to search and reuse this style.
abstract STable	getTable(String name)
abstract boolean	hasSubtotalExpression()
abstract void	initDefaultCellStyles()
abstract void	initDefaultFont()
abstract boolean	isPostProcessing()
abstract STable	removeTable(String name)
abstract void	resetSubtotalExpressionCache()
abstract void	sendModelEvent(ModelEvent event)
abstract void	setDefaultChartSeriesColors(List<SColor> colors)
abstract void	setPostProcessing(boolean b)
abstract String	setTableColumnName(STable table, String oldName, String newName)
abstract void	startBatchNotificationMode()	Starts a batch mode for event notification in a workbook.
abstract void	stopBatchNotificationMode()	Stops the batch mode for event notification when triggers all of the events in a queue.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.keikai.model.sys.formula.EvaluationContributorContainer

getEvaluationContributor, setEvaluationContributor

Methods inherited from interface io.keikai.model.SBook

addCellStyle, addCellStyle, addDefaultCellStyle, addEventListener, addExtraStyle, addFont, addFont, addNamedCellstyle, addPictureData, addTableStyle, clearTableStyles, cloneBook, createCellStyle, createCellStyle, createCellStyle, createCellStyle, createColor, createColor, createFont, createFont, createFont, createFont, createName, createName, createSheet, createSheet, createSheet, deleteName, deleteSheet, getAttribute, getAttributes, getBookName, getBookSeries, getDefaultCellStyle, getDefaultCellStyle, getDefaultCellStyles, getDefaultFont, getDefaultPivotStyleName, getDefaultTableStyleName, getDependencyTracer, getExtraStyles, getFormulaMaxChange, getFormulaMaxIterations, getMaxColumnIndex, getMaxColumnSize, getMaxRowIndex, getMaxRowSize, getName, getNameByName, getNameByName, getNamedStyle, getNamedStyles, getNames, getNumOfName, getNumOfSheet, getOrAddCellStyle, getOrAddDefaultHyperlinkStyle, getOrAddExtraStyle, getOrCreateDefaultHyperlinkStyle, getPictureData, getPicturesDatas, getShareScope, getSheet, getSheetById, getSheetByName, getSheetIndex, getSheetIndex, getSheets, getTableStyle, getTableStyles, getWorkbookProtection, isDirty, moveSheetTo, optimizeCellStyle, removeEventListener, searchCellStyle, searchExtraStyle, searchFont, setAttribute, setDefaultCellStyle, setDefaultPivotStyleName, setDefaultTableStyleName, setDirty, setFormulaMaxChange, setFormulaMaxIterations, setNameName, setNameName, setShareScope, setSheetName

Constructor Detail

AbstractBookAdv

public AbstractBookAdv()

Method Detail

sendModelEvent

public abstract void sendModelEvent(ModelEvent event)

getId

public abstract String getId()

clearDefaultCellStyles

public abstract void clearDefaultCellStyles()

clearNamedStyles

public abstract void clearNamedStyles()

initDefaultCellStyles

public abstract void initDefaultCellStyles()

setDefaultChartSeriesColors

public abstract void setDefaultChartSeriesColors(List<SColor> colors)

getDefaultChartSeriesColors

public abstract List<SColor> getDefaultChartSeriesColors()

createTableName

public abstract SName createTableName(STable table)

addTable

public abstract void addTable(STable table)

getTable

public abstract STable getTable(String name)

removeTable

public abstract STable removeTable(String name)

setTableColumnName

public abstract String setTableColumnName(STable table,
                                          String oldName,
                                          String newName)

initDefaultFont

public abstract void initDefaultFont()

getCharWidth

public abstract int getCharWidth()

clearExtraStyles

public abstract void clearExtraStyles()

getOrAddFont

public abstract SFont getOrAddFont(SFont font)

Get the font which stored in this book, or add it into the book if not found, then you can use SBook.searchFont(FontMatcher) to search and reuse this style.

Since:

5.3.0

isPostProcessing

public abstract boolean isPostProcessing()

setPostProcessing

public abstract void setPostProcessing(boolean b)

hasSubtotalExpression

public abstract boolean hasSubtotalExpression()

resetSubtotalExpressionCache

public abstract void resetSubtotalExpressionCache()

startBatchNotificationMode

public abstract void startBatchNotificationMode()

Starts a batch mode for event notification in a workbook. Note: all the subsequence event will put in a queue or be ignored it if that event has a duplicated one already inside the queue, and then all the events are triggered until stopBatchNotificationMode() is invoked.

Usage:

 try {
    book.startBatchNotificationMode();
    // do something here to send events.
  } finally {
    book.stopBatchNotificationMode(); // ensure this will be invoked finally
  }
  

Since:

5.1.0

See Also:

stopBatchNotificationMode()

stopBatchNotificationMode

public abstract void stopBatchNotificationMode()

Stops the batch mode for event notification when triggers all of the events in a queue.

Since:

5.1.0