org.zkoss.zss.model.impl

Class BookImpl

java.lang.Object

org.zkoss.zss.model.impl.AbstractBookAdv

org.zkoss.zss.model.impl.BookImpl

All Implemented Interfaces:

java.io.Serializable, SBook, EvaluationContributorContainer

public class BookImpl
extends AbstractBookAdv

Since:

3.5.0

Author:

dennis

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BookImpl(java.lang.String bookName)

Method Summary

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	addNamedCellstyle(SNamedStyle namedStyle) Add one more named cell style.
SPictureData	addPictureData(SPicture.Format format, byte[] data) Add SPictureData into this book
void	addTable(STable table)
protected void	checkOwnership(SName name)
protected void	checkOwnership(SSheet sheet)
void	clearDefaultCellStyles()
void	clearNamedStyles()
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(java.lang.String htmlColor)
SFont	createFont(boolean inFontTable)
SFont	createFont(SFont src, boolean inFontTable)
SName	createName(java.lang.String namename)
SName	createName(java.lang.String namename, java.lang.String sheetName) Create a defined name on specified sheet
SSheet	createSheet(java.lang.String name) Create a sheet
SSheet	createSheet(java.lang.String name, SSheet src) Create a sheet and copy the contain form the sheet sheet
SName	createTableName(STable table)
void	deleteName(SName name) Delete a defined name
void	deleteSheet(SSheet sheet) Delete the sheet
void	dump(java.lang.StringBuilder builder)
java.lang.Object	getAttribute(java.lang.String name) Get the runtime custom attribute that stored in this book
java.util.Map<java.lang.String,java.lang.Object>	getAttributes() Get the unmodifiable runtime attributes map
java.lang.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
java.util.List<SCellStyle>	getCellStyleTable()
SCellStyle	getDefaultCellStyle() Get the default style of this book
SCellStyle	getDefaultCellStyle(int index) Get the nth default style of this book
java.util.Collection<SCellStyle>	getDefaultCellStyles() Get all default cell styles.
SFont	getDefaultFont()
EvaluationContributor	getEvaluationContributor()
java.util.List<SFont>	getFontTable()
java.lang.String	getId()
int	getMaxColumnIndex() Get the max column index of this book, it is SBook.getMaxColumnIndex()-1
int	getMaxColumnSize() Get the max column size of this book
int	getMaxRowIndex() Get the max row index of this book, it is SBook.getMaxRowSize()-1
int	getMaxRowSize() Get the max row size of this book
SName	getName(int idx)
SName	getNameByName(java.lang.String namename)
SName	getNameByName(java.lang.String namename, java.lang.String sheetName)
SNamedStyle	getNamedStyle(java.lang.String name) Get the named style of this book
java.util.Collection<SNamedStyle>	getNamedStyles() Get all name styles.
java.util.List<SName>	getNames()
int	getNumOfName()
int	getNumOfSheet() Get the number of sheet
SCellStyle	getOrCreateDefaultHyperlinkStyle() Returns existing or create SCellStyle for hyperlink.
SPictureData	getPictureData(int index) Get SPictureData of the specified index from this book; null if not exist
java.util.Collection<SPictureData>	getPicturesDatas() Returns all SPictureData fo this book.
protected Ref	getRef()
java.lang.String	getShareScope()
SSheet	getSheet(int i) Get sheet at the index
SSheet	getSheetById(java.lang.String id) Get the sheet by id
SSheet	getSheetByName(java.lang.String name) Get the sheet by name
int	getSheetIndex(SSheet sheet) Get the index of sheet
int	getSheetIndex(java.lang.String sheetName) Get the index of sheet
java.util.List<SSheet>	getSheets() Get all sheets
STable	getTable(java.lang.String name)
void	initDefaultCellStyles()
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
STable	removeTable(java.lang.String name)
SCellStyle	searchCellStyle(CellStyleMatcher matcher) Search the style table and return the first matched style.
SFont	searchFont(FontMatcher matcher)
void	sendModelEvent(ModelEvent event)
java.lang.Object	setAttribute(java.lang.String name, java.lang.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	setDirty(boolean dirty) Set dirty flag
void	setEvaluationContributor(EvaluationContributor contributor)
void	setNameName(SName name, java.lang.String newname)
void	setNameName(SName name, java.lang.String newname, java.lang.String sheetName)
void	setShareScope(java.lang.String scope)
void	setSheetName(SSheet sheet, java.lang.String newname) Set the sheet to a new name
java.lang.String	setTableColumnName(STable table, java.lang.String oldName, java.lang.String newName)

Methods inherited from class java.lang.Object

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

Constructor Detail

BookImpl

public BookImpl(java.lang.String bookName)

Method Detail

initDefaultCellStyles

public void initDefaultCellStyles()

Specified by:

initDefaultCellStyles in class AbstractBookAdv

getBookSeries

public SBookSeries getBookSeries()

Description copied from interface: SBook

Get the book series, it contains a group of book that might refer to other by book name

Returns:

book series

getBookName

public java.lang.String getBookName()

Description copied from interface: SBook

Get the book name, a book name is unique for book in SBookSeries

Returns:

book name;

getSheet

public SSheet getSheet(int i)

Description copied from interface: SBook

Get sheet at the index

Parameters:

i - the sheet index

Returns:

the sheet at the index

getNumOfSheet

public int getNumOfSheet()

Description copied from interface: SBook

Get the number of sheet

Returns:

the number of sheet

getSheetByName

public SSheet getSheetByName(java.lang.String name)

Description copied from interface: SBook

Get the sheet by name

Parameters:

name - the name of sheet

Returns:

the sheet, or null if not found

getSheetById

public SSheet getSheetById(java.lang.String id)

Description copied from interface: SBook

Get the sheet by id

Parameters:

id - the id of sheet

Returns:

the sheet, or null if not found

checkOwnership

protected void checkOwnership(SSheet sheet)

checkOwnership

protected void checkOwnership(SName name)

sendModelEvent

public void sendModelEvent(ModelEvent event)

Specified by:

sendModelEvent in class AbstractBookAdv

createSheet

public SSheet createSheet(java.lang.String name)

Description copied from interface: SBook

Create a sheet

Parameters:

name - the name of sheet

Returns:

the sheet

createSheet

public SSheet createSheet(java.lang.String name,
                          SSheet src)

Description copied from interface: SBook

Create a sheet and copy the contain form the sheet sheet

Parameters:

name - the name of sheet

src - the source sheet to copy

Returns:

the sheet

getRef

protected Ref getRef()

setSheetName

public void setSheetName(SSheet sheet,
                         java.lang.String newname)

Description copied from interface: SBook

Set the sheet to a new name

Parameters:

sheet - the sheet

newname - the new name

deleteSheet

public void deleteSheet(SSheet sheet)

Description copied from interface: SBook

Delete the sheet

Parameters:

sheet - the sheet

moveSheetTo

public void moveSheetTo(SSheet sheet,
                        int index)

Description copied from interface: SBook

Move the sheet to new position

Parameters:

sheet - the sheet

index - the new position

dump

public void dump(java.lang.StringBuilder builder)

getDefaultCellStyle

public SCellStyle getDefaultCellStyle()

Description copied from interface: SBook

Get the default style of this book

Returns:

getDefaultCellStyle

public SCellStyle getDefaultCellStyle(int index)

Description copied from interface: SBook

Get the nth default style of this book

Returns:

setDefaultCellStyle

public void setDefaultCellStyle(SCellStyle cellStyle)

Description copied from interface: SBook

Set the default style of this book

createCellStyle

public SCellStyle createCellStyle(boolean inStyleTable)

Description copied from interface: SBook

Create a cell style

Parameters:

inStyleTable - if true, the new created style will be stored inside this book, then you can use SBook.searchCellStyle(CellStyleMatcher) to search and reuse this style.

Returns:

createCellStyle

public SCellStyle createCellStyle(SCellStyle src,
                                  boolean inStyleTable)

Description copied from interface: SBook

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 SBook.searchCellStyle(CellStyleMatcher) to search and reuse this style.

Returns:

searchCellStyle

public SCellStyle searchCellStyle(CellStyleMatcher matcher)

Description copied from interface: SBook

Search the style table and return the first matched style.

Parameters:

matcher - the style matcher

Returns:

the matched style.

getDefaultFont

public SFont getDefaultFont()

createFont

public SFont createFont(boolean inFontTable)

createFont

public SFont createFont(SFont src,
                        boolean inFontTable)

searchFont

public SFont searchFont(FontMatcher matcher)

getMaxRowSize

public int getMaxRowSize()

Description copied from interface: SBook

Get the max row size of this book

getMaxColumnSize

public int getMaxColumnSize()

Description copied from interface: SBook

Get the max column size of this book

optimizeCellStyle

public void optimizeCellStyle()

Description copied from interface: SBook

Optimize CellStyle, usually called when export book or after many style operation

getCellStyleTable

public java.util.List<SCellStyle> getCellStyleTable()

getFontTable

public java.util.List<SFont> getFontTable()

addEventListener

public void addEventListener(ModelEventListener listener)

Description copied from interface: SBook

add event listener to this book

Parameters:

listener - the listener

removeEventListener

public void removeEventListener(ModelEventListener listener)

Description copied from interface: SBook

remove event listener from this book

Parameters:

listener - the listener

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Description copied from interface: SBook

Get the runtime custom attribute that stored in this book

Parameters:

name - the attribute name

Returns:

the value, or null if not found

setAttribute

public java.lang.Object setAttribute(java.lang.String name,
                                     java.lang.Object value)

Description copied from interface: SBook

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

public java.util.Map<java.lang.String,java.lang.Object> getAttributes()

Description copied from interface: SBook

Get the unmodifiable runtime attributes map

Returns:

createColor

public SColor createColor(byte r,
                          byte g,
                          byte b)

createColor

public SColor createColor(java.lang.String htmlColor)

getSheets

public java.util.List<SSheet> getSheets()

Description copied from interface: SBook

Get all sheets

Returns:

an unmodifiable sheet list

createName

public SName createName(java.lang.String namename)

createName

public SName createName(java.lang.String namename,
                        java.lang.String sheetName)

Description copied from interface: SBook

Create a defined name on specified sheet

Returns:

created defined name

setNameName

public void setNameName(SName name,
                        java.lang.String newname)

setNameName

public void setNameName(SName name,
                        java.lang.String newname,
                        java.lang.String sheetName)

deleteName

public void deleteName(SName name)

Description copied from interface: SBook

Delete a defined name

getNumOfName

public int getNumOfName()

getName

public SName getName(int idx)

getNameByName

public SName getNameByName(java.lang.String namename)

getNameByName

public SName getNameByName(java.lang.String namename,
                           java.lang.String sheetName)

getNames

public java.util.List<SName> getNames()

getSheetIndex

public int getSheetIndex(SSheet sheet)

Description copied from interface: SBook

Get the index of sheet

Parameters:

sheet - the sheet

Returns:

the index

getSheetIndex

public int getSheetIndex(java.lang.String sheetName)

Description copied from interface: SBook

Get the index of sheet

Returns:

the index

setShareScope

public void setShareScope(java.lang.String scope)

getShareScope

public java.lang.String getShareScope()

getEvaluationContributor

public EvaluationContributor getEvaluationContributor()

setEvaluationContributor

public void setEvaluationContributor(EvaluationContributor contributor)

getMaxRowIndex

public int getMaxRowIndex()

Description copied from interface: SBook

Get the max row index of this book, it is SBook.getMaxRowSize()-1

getMaxColumnIndex

public int getMaxColumnIndex()

Description copied from interface: SBook

Get the max column index of this book, it is SBook.getMaxColumnIndex()-1

getId

public java.lang.String getId()

Specified by:

getId in class AbstractBookAdv

addPictureData

public SPictureData addPictureData(SPicture.Format format,
                                   byte[] data)

Description copied from interface: SBook

Add SPictureData into this book

Parameters:

format - picture format

data - picture raw data

Returns:

the created SPictureData

getPictureData

public SPictureData getPictureData(int index)

Description copied from interface: SBook

Get SPictureData of the specified index from this book; null if not exist

Returns:

SPictureData of the specified index from this book; null if not exist

getPicturesDatas

public java.util.Collection<SPictureData> getPicturesDatas()

Description copied from interface: SBook

Returns all SPictureData fo this book.

getNamedStyle

public SNamedStyle getNamedStyle(java.lang.String name)

Description copied from interface: SBook

Get the named style of this book

Returns:

addDefaultCellStyle

public int addDefaultCellStyle(SCellStyle cellStyle)

Description copied from interface: SBook

Add one more default cell style and return its index.

getDefaultCellStyles

public java.util.Collection<SCellStyle> getDefaultCellStyles()

Description copied from interface: SBook

Get all default cell styles.

Returns:

addNamedCellstyle

public void addNamedCellstyle(SNamedStyle namedStyle)

Description copied from interface: SBook

Add one more named cell style.

getNamedStyles

public java.util.Collection<SNamedStyle> getNamedStyles()

Description copied from interface: SBook

Get all name styles.

Returns:

clearDefaultCellStyles

public void clearDefaultCellStyles()

Specified by:

clearDefaultCellStyles in class AbstractBookAdv

clearNamedStyles

public void clearNamedStyles()

Specified by:

clearNamedStyles in class AbstractBookAdv

isDirty

public boolean isDirty()

Description copied from interface: SBook

Get if book is changed

Returns:

See Also:

#resetDirty()

setDirty

public void setDirty(boolean dirty)

Description copied from interface: SBook

Set dirty flag

See Also:

SBook.isDirty()

createTableName

public SName createTableName(STable table)

Specified by:

createTableName in class AbstractBookAdv

addTable

public void addTable(STable table)

Specified by:

addTable in class AbstractBookAdv

getTable

public STable getTable(java.lang.String name)

Specified by:

getTable in class AbstractBookAdv

removeTable

public STable removeTable(java.lang.String name)

Specified by:

removeTable in class AbstractBookAdv

setTableColumnName

public java.lang.String setTableColumnName(STable table,
                                           java.lang.String oldName,
                                           java.lang.String newName)

Specified by:

setTableColumnName in class AbstractBookAdv

getOrCreateDefaultHyperlinkStyle

public SCellStyle getOrCreateDefaultHyperlinkStyle()

Description copied from interface: SBook

Returns existing or create SCellStyle for hyperlink.

Returns: