com.intechcore.scomponents.scell.api.spreadsheet.service

Interface IFileWriter

public interface IFileWriter

Represents a tool used to save or convert the xlsx documents

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IFileWriter.FileType Enum used to choose from the strongly typed parameters of file types

Method Summary

Modifier and Type	Method and Description
IFileWriter	fileName(String value) Sets the file name
IFileWriter	fileName(String value, boolean tryToSetExtension) Sets the filename and parse the value to try to set the extension
IFileWriter	fileType(IFileWriter.FileType value) Sets the type in which the file will be saved
default String	getDefaultFileName()
File	getLastSavedXlsxFile()
boolean	save() Saves the current document to the current file or finds the file with the name set in fileName and saves it
boolean	save(OutputStream stream) Saves the current document to the given stream and saves it

Method Detail

save

boolean save()

Saves the current document to the current file or finds the file with the name set in fileName and saves it

ATTENTION! Unsupported data may be lost

Returns:

true if the file was saved

save

boolean save(OutputStream stream)

Saves the current document to the given stream and saves it

ATTENTION! Unsupported data may be lost

Parameters:

stream - the given stream

Returns:

true if the file was saved

fileName

IFileWriter fileName(String value)

Sets the file name

Parameters:

value - target file name

Returns:

the IFileWriter for further actions

fileName

IFileWriter fileName(String value,
                     boolean tryToSetExtension)

Sets the filename and parse the value to try to set the extension

Parameters:

value - target file name

tryToSetExtension - if true then parses the value to find and set the extension. Otherwise will save the file with default extension or set by user call of fileType(FileType)

Returns:

the IFileWriter for further actions

See Also:

IFileWriter.FileType

fileType

IFileWriter fileType(IFileWriter.FileType value)

Sets the type in which the file will be saved

Parameters:

value - the type of the file

Returns:

the IFileWriter for further actions

See Also:

IFileWriter.FileType

getDefaultFileName

default String getDefaultFileName()

Returns:

the default file name to save the current newly created document

getLastSavedXlsxFile

File getLastSavedXlsxFile()

Returns:

the last saved XLSX-file