org.zkoss.zss.model

Interface SBookSeries

All Known Implementing Classes:

AbstractBookSeriesAdv, BookSeriesImpl, SimpleBookSeriesImpl

public interface SBookSeries

It contains multiple SBook objects so that formulas in them can reference to cells of another book.

Since:

3.5.0

Author:

dennis

Method Summary

Modifier and Type	Method and Description
Object	getAttribute(String name) Get the runtime custom attribute that stored in this book
Map<String,Object>	getAttributes() Get the unmodifiable runtime attributes map
SBook	getBook(String name) Get the book by name;
List<SBook>	getBooks() Gets the books list
ReadWriteLock	getLock() Get the ReadWriteLock for synchronized when read-write model for current accessing.
boolean	isAutoFormulaCacheClean()
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	setAutoFormulaCacheClean(boolean enable)

Method Detail

getBook

SBook getBook(String name)

Get the book by name;

Parameters:

name - the book name

Returns:

the book or null if not found.

getBooks

List<SBook> getBooks()

Gets the books list

Returns:

the readonly books list

getLock

ReadWriteLock getLock()

Get the ReadWriteLock for synchronized when read-write model for current accessing.

Returns:

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:

isAutoFormulaCacheClean

boolean isAutoFormulaCacheClean()

Returns:

return the flag that indicate formula cache will be cleared automatically or not, default is FALSE.

setAutoFormulaCacheClean

void setAutoFormulaCacheClean(boolean enable)

See Also:

isAutoFormulaCacheClean()