com.intechcore.scomponents.scell.api.fx

Interface IScellUiApiBuilder<TControl>

Type Parameters:

TControl - type of the UI control (by default it is the Node)

All Known Subinterfaces:

IScellUiFxApiBuilder

public interface IScellUiApiBuilder<TControl>

The SCell UI control API entry point provider

See Also:

IScellUiApi

Method Summary

Modifier and Type	Method and Description
IScellUiApi<TControl>	create(IWorkbook coreApi) Creates instance which will manage SCell control
IScellUiApiBuilder<TControl>	customTextInputFactory(IExternalTextInputControlWrapperFactory factory) Sets custom factory to extending base text input control.
IScellUiApiBuilder<TControl>	demoWatermarksVisible(boolean value) Created SCell control will have demo watermarks visible or not
IScellUiApiBuilder<TControl>	disableContextMenu(ContextMenuOwner target) Created SCell control will not have corresponding context menu
IScellUiApiBuilder<TControl>	enableContextMenu(ContextMenuOwner target, boolean value) Created SCell control will have (or not) corresponding context menu
IScellUiApiBuilder<TControl>	enableUndoRedo(boolean value) Created SCell control will have undo/redo
IScellUiApiBuilder<TControl>	gridVisible(IUiControlSettings.GridVisibilityType type) Created SCell control will have cells grid visible or not
IScellUiApiBuilder<TControl>	horizontalScrollbarVisible(boolean value) Created SCell control will have horizontal scrollbar visible or not
IScellUiApiBuilder<TControl>	inputBarVisible(boolean value) Created SCell control will have input bar visible or hidden
IScellUiApiBuilder<TControl>	readOnly(boolean value) Created SCell control will have readonly content
IScellUiApiBuilder<TControl>	setForegroundAccentColor(IColor value) Created SCell control with custom color
IScellUiApiBuilder<TControl>	systemClipboardAdapter(ISystemClipboardAdapter adapter) Created SCell control will have custom clipboard adapter.
IScellUiApiBuilder<TControl>	verticalScrollbarVisible(boolean value) Created SCell control will have vertical scrollbar visible or not

Method Detail

create

IScellUiApi<TControl> create(IWorkbook coreApi)

Creates instance which will manage SCell control

Parameters:

coreApi - workbook to get application

Returns:

SCell UI control manager

readOnly

IScellUiApiBuilder<TControl> readOnly(boolean value)

Created SCell control will have readonly content

Parameters:

value - makes UI readonly if true

Returns:

UI API provider to further setup or build

enableUndoRedo

IScellUiApiBuilder<TControl> enableUndoRedo(boolean value)

Created SCell control will have undo/redo

Parameters:

value - makes it impossible to undo/redo if true

Returns:

UI API provider to further setup or build

setForegroundAccentColor

IScellUiApiBuilder<TControl> setForegroundAccentColor(IColor value)

Created SCell control with custom color

Parameters:

value - is cutom color

Returns:

UI API provider to further setup or build

enableContextMenu

IScellUiApiBuilder<TControl> enableContextMenu(ContextMenuOwner target,
                                               boolean value)

Created SCell control will have (or not) corresponding context menu

Parameters:

target - menu to set enable state

value - makes it impossible to open context menu if false

Returns:

UI API provider to further setup or build

disableContextMenu

IScellUiApiBuilder<TControl> disableContextMenu(ContextMenuOwner target)

Created SCell control will not have corresponding context menu

Parameters:

target - menu to set enable state

Returns:

UI API provider to further setup or build

inputBarVisible

IScellUiApiBuilder<TControl> inputBarVisible(boolean value)

Created SCell control will have input bar visible or hidden

Parameters:

value - makes input bar invisible if false

Returns:

UI API provider to further setup or build

gridVisible

IScellUiApiBuilder<TControl> gridVisible(IUiControlSettings.GridVisibilityType type)

Created SCell control will have cells grid visible or not

Parameters:

type - the IUiControlSettings.GridVisibilityType that sets the grid visibility mode

Returns:

UI API provider to further setup or build

verticalScrollbarVisible

IScellUiApiBuilder<TControl> verticalScrollbarVisible(boolean value)

Created SCell control will have vertical scrollbar visible or not

Parameters:

value - makes vertical scrollbar invisible if false

Returns:

UI API provider to further setup or build

horizontalScrollbarVisible

IScellUiApiBuilder<TControl> horizontalScrollbarVisible(boolean value)

Created SCell control will have horizontal scrollbar visible or not

Parameters:

value - makes horizontal scrollbar invisible if false

Returns:

UI API provider to further setup or build

demoWatermarksVisible

IScellUiApiBuilder<TControl> demoWatermarksVisible(boolean value)

Created SCell control will have demo watermarks visible or not

Parameters:

value - makes demo watermarks visible if true

Returns:

UI API provider to further setup or build

systemClipboardAdapter

IScellUiApiBuilder<TControl> systemClipboardAdapter(ISystemClipboardAdapter adapter)

Created SCell control will have custom clipboard adapter.

Parameters:

adapter - the custom ISystemClipboardAdapter

Returns:

UI API provider to further setup or build

customTextInputFactory

IScellUiApiBuilder<TControl> customTextInputFactory(IExternalTextInputControlWrapperFactory factory)

Sets custom factory to extending base text input control. Added to support JPro TextInput

Parameters:

factory - IExternalTextInputControlWrapperFactory with customized behavior

Returns:

UI API provider to further setup or build