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

Interface IWorkbook

public interface IWorkbook

Represents SCell Workbook model and start API entry point

Method Summary

Modifier and Type	Method and Description
IWorksheet	add() Create and add worksheet to the workbook
IWorksheet	addCopy(int originId) Copy existing worksheet and add to the workbook
Stream<IWorksheet>	all()
Optional<IWorksheet>	find(int id) Searches a worksheet by the ID
Optional<IWorksheet>	find(String name) Searches a worksheet by the name
IEventManager	getEventManager()
IWorksheet	getFirst()
IScellApiResolver	getResolver()
ISearchService	getSearchService()
IFileWriter	getWriter()
Boolean	remove(int id) Remove worksheet
IWorksheet	removeAll() Remove all worksheets and adds a new one (because of workbook must contain at least one worksheet)
void	setProtection(IPasswordInput passwordHandler) Protect or unprotect (when the param is null) current document.

Method Detail

getWriter

IFileWriter getWriter()

Returns:

IFileWriter to save or convert the xlsx

add

IWorksheet add()

Create and add worksheet to the workbook

Returns:

created IWorksheet

addCopy

IWorksheet addCopy(int originId)

Copy existing worksheet and add to the workbook

Parameters:

originId - worksheet id to be copied

Returns:

created IWorksheet

remove

Boolean remove(int id)

Remove worksheet

Parameters:

id - worksheet id to be removed

Returns:

true if worksheet exists and deleted, otherwise false

Throws:

LastVisibleWorksheetDeleteException - if there is no other visible worksheets

removeAll

IWorksheet removeAll()

Remove all worksheets and adds a new one (because of workbook must contain at least one worksheet)

Returns:

just created new IWorksheet

getSearchService

ISearchService getSearchService()

Returns:

ISearchService to find any content on Workbook

getFirst

IWorksheet getFirst()

Returns:

the first IWorksheet from this workbook

find

Optional<IWorksheet> find(int id)

Searches a worksheet by the ID

Parameters:

id - ID of needed worksheet (integer)

Returns:

found IWorksheet or Optional.empty()

find

Optional<IWorksheet> find(String name)

Searches a worksheet by the name

Parameters:

name - name of needed worksheet

Returns:

found IWorksheet or Optional.empty()

all

Stream<IWorksheet> all()

Returns:

all the worksheets of the workbook

See Also:

IWorksheet

getEventManager

IEventManager getEventManager()

Returns:

current IEventManager to manage all internal events

getResolver

IScellApiResolver getResolver()

Returns:

IScellApiResolver for convenience

setProtection

void setProtection(IPasswordInput passwordHandler)

Protect or unprotect (when the param is null) current document. So next save operation will also encrypt (or not) file with provided password

Parameters:

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