com.intechcore.scomponents.scell.api.spreadsheet.model

Interface IWorkbook

public interface IWorkbook

Represents a SCell Workbook model and starts the API entry point

Method Summary

Modifier and Type	Method and Description
IWorksheet	add() Creates and adds a worksheet to the workbook
IWorksheet	addCopy(int originId) Copies the existing worksheet and adds it to the workbook
Stream<IWorksheet>	all()
IWorkbook	createCopy() Creates a new IWorkbook with copy all the data from current this
Optional<IWorksheet>	find(int id) Searches the worksheet by the ID
Optional<IWorksheet>	find(String name) Searches the worksheet by the name
com.intechcore.scomponents.common.core.event.manager.IEventManager	getEventManager()
IWorksheet	getFirst()
IFormulasService	getFormulasService()
IScellApiResolver	getResolver()
ISearchService	getSearchService()
IFileWriter	getWriter()
Boolean	remove(int id) Removes the worksheet
IWorksheet	removeAll() Removes all worksheets and adds a new one (since the workbook must contain at least one worksheet)
void	setProtection(IPasswordInput passwordHandler) Protects or (when the param is null) does not protect the current document.

Method Detail

getWriter

IFileWriter getWriter()

Returns:

IFileWriter to save or convert the xlsx

add

IWorksheet add()

Creates and adds a worksheet to the workbook

Returns:

the created IWorksheet

addCopy

IWorksheet addCopy(int originId)

Copies the existing worksheet and adds it to the workbook

Parameters:

originId - the worksheet id to be copied

Returns:

the created IWorksheet

createCopy

IWorkbook createCopy()

Creates a new IWorkbook with copy all the data from current this

Returns:

the new IWorkbook

remove

Boolean remove(int id)

Removes the worksheet

Parameters:

id - the id of the worksheet to be removed

Returns:

true if worksheet existed and was deleted, otherwise false

removeAll

IWorksheet removeAll()

Removes all worksheets and adds a new one (since the workbook must contain at least one worksheet)

Returns:

the newly created IWorksheet

getSearchService

ISearchService getSearchService()

Returns:

ISearchService to find any content in the Workbook

getFirst

IWorksheet getFirst()

Returns:

the first IWorksheet of the workbook

find

Optional<IWorksheet> find(int id)

Searches the worksheet by the ID

Parameters:

id - the ID of the required worksheet (integer)

Returns:

the found IWorksheet or Optional.empty()

find

Optional<IWorksheet> find(String name)

Searches the worksheet by the name

Parameters:

name - the name of the required worksheet

Returns:

the found IWorksheet or Optional.empty()

all

Stream<IWorksheet> all()

Returns:

all worksheets of the workbook

See Also:

IWorksheet

getEventManager

com.intechcore.scomponents.common.core.event.manager.IEventManager getEventManager()

Returns:

the current IEventManager to manage the internal events

getResolver

IScellApiResolver getResolver()

Returns:

IScellApiResolver for convenience

setProtection

void setProtection(IPasswordInput passwordHandler)

Protects or (when the param is null) does not protect the current document. In addition to this the file will be encrypted (or will not) with the provided password

Parameters:

passwordHandler - the password supplier. To remove the existing protection set the param to null

getFormulasService

IFormulasService getFormulasService()

Returns:

the formula service for managing formulas calculation