com.intechcore.scomponents.scell.api.fx.control

Interface IUiContentManager

public interface IUiContentManager

Represents a controller of the SCell content used to load the existing or create new spreadsheets into the existing SCell controls

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all existing content of the SCell control.
CompletableFuture<Void>	copy() Copies current selection to the clipboard
CompletableFuture<Void>	cut() Cuts current selection to the clipboard
IWorksheet	getActiveWorksheet()
IWorkbook	getCoreApi() Deprecated.
IWorkbook	getWorkbook()
CompletableFuture<Void>	load(File file) Loads the existing spreadsheet file
CompletableFuture<Void>	load(File file, IPasswordInput setting) Loads the existing spreadsheet file
CompletableFuture<Void>	load(InputStream source, boolean tryOpenAsCsv, String title) Loads the document as a stream with trying to open it as a CSV
CompletableFuture<Void>	load(InputStream source, boolean tryOpenAsCsv, String title, IPasswordInput passwordHandler) Loads the document as a stream with trying to open it as a CSV
CompletableFuture<Void>	load(InputStream source, String title) Loads the spreadsheet document as a stream
CompletableFuture<Void>	load(InputStream source, String title, IPasswordInput passwordHandler) Loads the spreadsheet document as a stream
CompletableFuture<Void>	paste() Inserts content from the clipboard into the current selection
boolean	redoLastAction() Redoes the last action performed after the undoLastAction()
void	setPasswordInput(IPasswordInput value) Sets the users custom password supplier to input the password when protected documents are being loaded
boolean	undoLastAction() Undoes the last action initiated by the user or the API

Method Detail

load

CompletableFuture<Void> load(File file)

Loads the existing spreadsheet file

Parameters:

file - the xlsx File to be loaded

Returns:

the CompletableFuture

load

CompletableFuture<Void> load(File file,
                             IPasswordInput setting)

Loads the existing spreadsheet file

Parameters:

file - the xlsx File to be loaded

setting - the workbook protection settings (IPasswordInput)

Returns:

the CompletableFuture

load

CompletableFuture<Void> load(InputStream source,
                             String title)

Loads the spreadsheet document as a stream

Parameters:

source - the InputStream of the xlsx-content to be opened

title - the document title

Returns:

the CompletableFuture that loads the document

load

CompletableFuture<Void> load(InputStream source,
                             boolean tryOpenAsCsv,
                             String title)

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

Parameters:

source - the InputStream of the xlsx-content to be opened

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

title - the document title

Returns:

the CompletableFuture that loads the document

load

CompletableFuture<Void> load(InputStream source,
                             String title,
                             IPasswordInput passwordHandler)

Loads the spreadsheet document as a stream

Parameters:

source - the InputStream of the xlsx-content to be opened

title - the document title

passwordHandler - the workbook protection password input handler (IPasswordInput)

Returns:

the CompletableFuture that loads the document

load

CompletableFuture<Void> load(InputStream source,
                             boolean tryOpenAsCsv,
                             String title,
                             IPasswordInput passwordHandler)

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

Parameters:

source - the InputStream of the xlsx-content to be opened

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

title - the document title

passwordHandler - the workbook protection password input handler (IPasswordInput)

Returns:

the CompletableFuture that loads the document

setPasswordInput

void setPasswordInput(IPasswordInput value)

Sets the users custom password supplier to input the password when protected documents are being loaded

Parameters:

value - the workbook protection password input handler (IPasswordInput)

clear

void clear()

Clears all existing content of the SCell control. Thus, this process is similar to the creation of a new spreadsheet

getActiveWorksheet

IWorksheet getActiveWorksheet()

Returns:

the currently displayed worksheet

See Also:

IWorksheet

getCoreApi

@Deprecated
IWorkbook getCoreApi()

Deprecated.

Returns:

the core API entry point to change the content of the SCell control

getWorkbook

IWorkbook getWorkbook()

Returns:

the core API entry point to change the content of the SCell control

undoLastAction

boolean undoLastAction()

Undoes the last action initiated by the user or the API

Returns:

the true value if the undo command was successful

redoLastAction

boolean redoLastAction()

Redoes the last action performed after the undoLastAction()

Returns:

the true value if the redo command was successful

copy

CompletableFuture<Void> copy()

Copies current selection to the clipboard

Returns:

the CompletableFuture

paste

CompletableFuture<Void> paste()

Inserts content from the clipboard into the current selection

Returns:

the CompletableFuture

cut

CompletableFuture<Void> cut()

Cuts current selection to the clipboard

Returns:

the CompletableFuture