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

Interface IUiControlSettings

public interface IUiControlSettings

Represents UI service interface to make changes in runtime

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IUiControlSettings.GridVisibilityType Used to set the display type of the grid

Method Summary

Modifier and Type	Method and Description
IUiControlSettings.GridVisibilityType	getGridVisibilityType()
boolean	isContextMenuEnabled(ContextMenuOwner contextMenu) Get corresponding SCell context menu status - disabled or not
boolean	isHorizontalScrollbarVisible()
boolean	isInputBarVisible()
boolean	isReadOnly()
boolean	isVerticalScrollbarVisible()
void	setContextMenuEnabled(ContextMenuOwner contextMenu, boolean value) Set corresponding SCell context menu enabled property
void	setForegroundAccentColor(IColor color) Set SCell accent color
void	setGridVisibilityType(IUiControlSettings.GridVisibilityType type) Set SCell cells grid visible property
void	setHorizontalScrollbarVisibility(boolean value) Set SCell control horizontal scrollbar visible property
void	setInputBarVisibility(boolean value) Set input bar of SCell control visible property
void	setReadOnly(boolean value) Set SCell control content readonly property
void	setVerticalScrollbarVisibility(boolean value) Set SCell control vertical scrollbar visible property

Method Detail

isReadOnly

boolean isReadOnly()

Returns:

true if SCell content is readonly otherwise false

setReadOnly

void setReadOnly(boolean value)

Set SCell control content readonly property

Parameters:

value - set readonly if true

isContextMenuEnabled

boolean isContextMenuEnabled(ContextMenuOwner contextMenu)

Get corresponding SCell context menu status - disabled or not

Parameters:

contextMenu - ContextMenuOwner target context menu

Returns:

true if target context menu is enabled, otherwise false

setContextMenuEnabled

void setContextMenuEnabled(ContextMenuOwner contextMenu,
                           boolean value)

Set corresponding SCell context menu enabled property

Parameters:

contextMenu - ContextMenuOwner target context menu

value - set target context menu enabled if true

setForegroundAccentColor

void setForegroundAccentColor(IColor color)

Set SCell accent color

Parameters:

color - set accent color. null will reset the color to default

isInputBarVisible

boolean isInputBarVisible()

Returns:

true if the input bar of SCell control is visible, otherwise false

setInputBarVisibility

void setInputBarVisibility(boolean value)

Set input bar of SCell control visible property

Parameters:

value - set input bar visible if true

getGridVisibilityType

IUiControlSettings.GridVisibilityType getGridVisibilityType()

Returns:

the type of the visibility mode of the grid

setGridVisibilityType

void setGridVisibilityType(IUiControlSettings.GridVisibilityType type)

Set SCell cells grid visible property

Parameters:

type - the type of the visibility mode of the grid

isVerticalScrollbarVisible

boolean isVerticalScrollbarVisible()

Returns:

true if SCell control vertical scrollbar is visible

setVerticalScrollbarVisibility

void setVerticalScrollbarVisibility(boolean value)

Set SCell control vertical scrollbar visible property

Parameters:

value - set vertical scrollbar visible if true

isHorizontalScrollbarVisible

boolean isHorizontalScrollbarVisible()

Returns:

true if SCell control horizontal scrollbar is visible, otherwise false

setHorizontalScrollbarVisibility

void setHorizontalScrollbarVisibility(boolean value)

Set SCell control horizontal scrollbar visible property

Parameters:

value - set horizontal scrollbar visible if true