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

Interface IUiSelectionManager

public interface IUiSelectionManager

Represents the cell selection manager

Method Summary

Modifier and Type	Method and Description
void	activateWorksheetById(int worksheetId) Selects sheet with given ID
int	getActiveWorksheetId()
IRangeAddress	getSelection() Gets the current cell or range selection
IUiSelectionInfo	getSelectionInfo() Gets the IUiSelectionInfo with complex selection info
boolean	setSelection(int worksheetId, IRangeAddress target) Changes the current selection to the target cell(s) in specified worksheet
boolean	setSelection(IRangeAddress target) Changes the current selection to the target cell(s) in the active worksheet

Method Detail

setSelection

boolean setSelection(int worksheetId,
                     IRangeAddress target)

Changes the current selection to the target cell(s) in specified worksheet

Parameters:

worksheetId - is the worksheet ID

target - the range or single cell address

Returns:

true, if the call was successful, otherwise false

setSelection

boolean setSelection(IRangeAddress target)

Changes the current selection to the target cell(s) in the active worksheet

Parameters:

target - the range or single cell address

Returns:

true if the call was successful, otherwise false

getSelection

IRangeAddress getSelection()

Gets the current cell or range selection

Returns:

CompletableFuture

getSelectionInfo

IUiSelectionInfo getSelectionInfo()

Gets the IUiSelectionInfo with complex selection info

Returns:

the CompletableFuture of current IUiSelectionInfo

getActiveWorksheetId

int getActiveWorksheetId()

Returns:

the id of the active worksheet

activateWorksheetById

void activateWorksheetById(int worksheetId)

Selects sheet with given ID

Parameters:

worksheetId - needed worksheet id