com.intechcore.scomponents.scell.api.spreadsheet

Interface IScellCoreApiFactory

public interface IScellCoreApiFactory

The Core SCell Public API entry point provider

Returns the API entry point IWorkbook

Creates a new SCell document or loads existing

Can be obtained from IScellApiResolver:

 ScellApiEntryPoint.getApiResolverAsync().thenAccept(apiResolver -> {
     IScellCoreApiFactory coreApiProvider = apiResolver.resolve(IScellCoreApiFactory.class);
     // ...
 });
 

Method Summary

Modifier and Type	Method and Description
IWorkbook	createNew() Creates a new document
IWorkbook	createNew(String firstWorksheetName) Creates a new document
IProductInfo	getProductInfo()
IWorkbook	load(File file) Loads an existing spreadsheet file
IWorkbook	load(File file, Supplier<String> passwordSupplier) Loads an existing spreadsheet file
IWorkbook	load(InputStream inputStream, Supplier<String> passwordSupplier, String title) Loads document as stream

Method Detail

createNew

IWorkbook createNew()

Creates a new document

Returns:

created IWorkbook

createNew

IWorkbook createNew(String firstWorksheetName)

Creates a new document

Parameters:

firstWorksheetName - sets name of first worksheet

Returns:

created IWorkbook

load

IWorkbook load(File file)

Loads an existing spreadsheet file

Parameters:

file - File existing xlsx file

Returns:

loaded IWorkbook

load

IWorkbook load(File file,
               Supplier<String> passwordSupplier)

Loads an existing spreadsheet file

Parameters:

file - File existing xlsx file

passwordSupplier - lambda to provide the password if the file is protected

Returns:

loaded IWorkbook

load

IWorkbook load(InputStream inputStream,
               Supplier<String> passwordSupplier,
               String title)

Loads document as stream

Parameters:

inputStream - InputStream of xlsx-content to open

passwordSupplier - lambda to provide the password if the stream is protected

title - document title

Returns:

loaded IWorkbook

getProductInfo

IProductInfo getProductInfo()

Returns:

IProductInfo service to get some SCell Component information