com.intechcore.scomponents.scell.api.fx

Interface IScellUiApi<TControl>

Type Parameters:

TControl - the type of the UI node which will be created by the getControl(). Default - Java FX

public interface IScellUiApi<TControl>

Represents a SCell UI control manager

Method Summary

Modifier and Type	Method and Description
void	beginBunchOfOperations() Disables redraw content of the component after each API call to get changes faster
IDiffController<TControl>	createComparator()
IDiffController<TControl>	createComparator(IWorkbook leftWorkbook, IWorkbook rightWorkbook)
IDiffController<TControl>	createComparator(IWorkbook leftWorkbook, IWorkbook rightWorkbook, Consumer<IComparatorConfig> config)
void	endBunchOfOperations() Enables redraw content (see beginBunchOfOperations()) and redraws the content of the control
IUiContentManager	getContentManager()
TControl	getControl()
IUiGridManager	getGridManager()
IUiGridMetrics	getGridMetrics()
IUiSelectionManager	getSelectionManager()
IUiControlSettings	getSettingsService()
void	setContextMenuItems(ContextMenuOwner target, List<PredefinedContextMenuCommand> commands) Allows to customize the corresponding context menu

Method Detail

getControl

TControl getControl()

Returns:

the created UI control

getSettingsService

IUiControlSettings getSettingsService()

Returns:

the service of the SCell UI control settings

getContentManager

IUiContentManager getContentManager()

Returns:

the SCell UI control content manager which is used to replace the existing document by loading another or creating a new one

getSelectionManager

IUiSelectionManager getSelectionManager()

Returns:

the manager which is used to change the selection

getGridMetrics

IUiGridMetrics getGridMetrics()

Returns:

the IUiGridMetrics service to convert grid canvas coordinates to cells addresses

setContextMenuItems

void setContextMenuItems(ContextMenuOwner target,
                         List<PredefinedContextMenuCommand> commands)

Allows to customize the corresponding context menu

Parameters:

target - the context menu to be customized

commands - the list of the PredefinedContextMenuCommand used to form the corresponding context menu

getGridManager

IUiGridManager getGridManager()

Returns:

the IUiGridManager service to get/set top row index and left column index

beginBunchOfOperations

void beginBunchOfOperations()

Disables redraw content of the component after each API call to get changes faster

endBunchOfOperations

void endBunchOfOperations()

Enables redraw content (see beginBunchOfOperations()) and redraws the content of the control

createComparator

IDiffController<TControl> createComparator()

createComparator

IDiffController<TControl> createComparator(IWorkbook leftWorkbook,
                                           IWorkbook rightWorkbook)

createComparator

IDiffController<TControl> createComparator(IWorkbook leftWorkbook,
                                           IWorkbook rightWorkbook,
                                           Consumer<IComparatorConfig> config)