com.intechcore.scomponents.scell.api.spreadsheet

Interface IScellCoreApiFactory

public interface IScellCoreApiFactory

The provider of the entry point for the Core SCell Public API

Returns the API entry point IWorkbook

Creates a new SCell document or loads the existing one

Can be obtained from the IScellApiResolver:

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

Method Summary

Modifier and Type	Method and Description
Set<IFontProperties>	addFontsFromFs(ILocationsProvider provider)
Set<IFontProperties>	addFontsFromFsFolder(String folderPath)
Set<IFontProperties>	addFontsFromResources(String folderPath)
IWorkbook	createNew() Creates a new document
IWorkbook	createNew(String firstWorksheetName) Creates a new document
Set<IFontProperties>	getAllAvailableFonts()
IProductInfo	getProductInfo()
IWorkbook	load(File file) Loads the existing spreadsheet file
IWorkbook	load(File file, Supplier<String> passwordSupplier) Loads the existing spreadsheet file
IWorkbook	load(InputStream inputStream, boolean tryOpenAsCsv, Supplier<String> passwordSupplier, String title) Loads the document as a stream with trying to open it as a CSV
IWorkbook	load(InputStream inputStream, Supplier<String> passwordSupplier, String title) Loads the document as a stream
static IScellCoreApiFactory	resolve(IScellApiResolver resolver) Resolves a new instance of IScellCoreApiFactory with given resolver

Method Detail

resolve

static IScellCoreApiFactory resolve(IScellApiResolver resolver)

Resolves a new instance of IScellCoreApiFactory with given resolver

Parameters:

resolver - current resolver

Returns:

a new instance of IScellCoreApiFactory

createNew

IWorkbook createNew()

Creates a new document

Returns:

the created IWorkbook

createNew

IWorkbook createNew(String firstWorksheetName)

Creates a new document

Parameters:

firstWorksheetName - sets the name of the first worksheet

Returns:

the created IWorkbook

load

IWorkbook load(File file)

Loads the existing spreadsheet file

Parameters:

file - File the existing xlsx file

Returns:

the loaded IWorkbook

load

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

Loads the existing spreadsheet file

Parameters:

file - File the existing xlsx file

passwordSupplier - provides the password if the file is protected

Returns:

loaded IWorkbook

load

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

Loads the document as a stream

Parameters:

inputStream - the InputStream of the xlsx-file to be opened

passwordSupplier - provides the password if the stream is protected

title - the title of the document

Returns:

the loaded IWorkbook

load

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

Loads the document as a stream with trying to open it as a CSV

Parameters:

inputStream - the InputStream of the xlsx-file to be opened

tryOpenAsCsv - if true, it will try to open incoming stream as a CSV

passwordSupplier - provides the password if the stream is protected

title - the title of the document

Returns:

the loaded IWorkbook

getProductInfo

IProductInfo getProductInfo()

Returns:

the IProductInfo service which is used to get the SCell Component information

addFontsFromFsFolder

Set<IFontProperties> addFontsFromFsFolder(String folderPath)

addFontsFromResources

Set<IFontProperties> addFontsFromResources(String folderPath)

addFontsFromFs

Set<IFontProperties> addFontsFromFs(ILocationsProvider provider)

getAllAvailableFonts

Set<IFontProperties> getAllAvailableFonts()