org.jowidgets.api.toolkit

Interface IToolkit

public interface IToolkit

Method Summary

Methods

Modifier and Type	Method and Description
IFrame	createRootFrame(IFrameDescriptor descriptor) Creates a root frame for the given descriptor
IFrame	createRootFrame(IFrameDescriptor descriptor, IApplicationLifecycle lifecycle) Creates an root frame for the given descriptor and application lifecycle.
ITextMaskBuilder	createTextMaskBuilder() Gets the text mask builder
ITransferableBuilder	createTransferableBuilder() Creates a transferable builder
IActionBuilderFactory	getActionBuilderFactory() Gets the action builder factory
IWindow	getActiveWindow() Gets the active window
java.util.List<IWindow>	getAllWindows() Gets a list of all windows
IAnimationRunnerBuilder	getAnimationRunnerBuilder() Creates an animation runner builder
IApplicationRunner	getApplicationRunner() Gets the toolkits application runner
IBluePrintFactory	getBluePrintFactory() Gets the blue print factory
IBluePrintProxyFactory	getBluePrintProxyFactory() Gets the blue print proxy factory
IClipboard	getClipboard() Gets the system clipboard
IConverterProvider	getConverterProvider() Gets the toolkits converter provider
IDefaultActionFactory	getDefaultActionFactory() Gets the default action factory
IDelayedEventRunnerBuilder	getDelayedEventRunnerBuilder() Gets the delayed event runner builder
IImageFactory	getImageFactory() Gets the image factory
IImageRegistry	getImageRegistry() Gets the image registry that can be used to register icons and images
IInputContentCreatorFactory	getInputContentCreatorFactory() Gets the input content creator factory
ILayoutConstraintsToolkit	getLayoutConstraintsToolkit() Gets the layout constraints toolkit
ILayoutFactoryProvider	getLayoutFactoryProvider() Gets the factory for layouts
ILoginPane	getLoginPane() Gets the login pane that can be used for user login
IMessagePane	getMessagePane() Gets the message pane that can be used to show user messages
IModelFactoryProvider	getModelFactoryProvider() Gets the model factory provider
IQuestionPane	getQuestionPane() Gets the question pane that can be used to ask user questions
ISliderConverterFactory	getSliderConverterFactory() Gets the slider converter factory
ISupportedWidgets	getSupportedWidgets() Gets the supported widgets information
IUiThreadAccess	getUiThreadAccess() Gets the ui thread access.
<VALUE_TYPE> VALUE_TYPE	getValue(ITypedKey<VALUE_TYPE> key) Gets a value for a typed key
IWaitAnimationProcessor	getWaitAnimationProcessor() Gets the wait animation processor
IGenericWidgetFactory	getWidgetFactory() Gets the generic widget factory
IWidgetUtils	getWidgetUtils() Gets the widget utils
IWidgetWrapperFactory	getWidgetWrapperFactory() Gets the widget wrapper factory that can be used to create wrappers for native widgets
boolean	hasSpiMigLayoutSupport() Checks if the underlying spi implementation has mig layout support
<VALUE_TYPE> void	setValue(ITypedKey<VALUE_TYPE> key, VALUE_TYPE value) Sets a value for a typed key for the toolkit
Position	toLocal(Position screenPosition, IComponent component) Transforms a screen position to a local component position
Position	toScreen(Position localPosition, IComponent component) Transforms a local component position to a screen position

Method Detail

getApplicationRunner

IApplicationRunner getApplicationRunner()

Gets the toolkits application runner

Returns:

The toolkits application runner

getUiThreadAccess

IUiThreadAccess getUiThreadAccess()

Gets the ui thread access. Remark: This method must be invoked in the ui thread

Returns:

The ui thread access

Throws:

java.lang.IllegalStateException - if the method was not accessed in the ui thread

getBluePrintFactory

IBluePrintFactory getBluePrintFactory()

Gets the blue print factory

Returns:

The blue print factory

getBluePrintProxyFactory

IBluePrintProxyFactory getBluePrintProxyFactory()

Gets the blue print proxy factory

Returns:

The blue print proxy factory, never null

getConverterProvider

IConverterProvider getConverterProvider()

Gets the toolkits converter provider

Returns:

The toolkits converter provider

getSliderConverterFactory

ISliderConverterFactory getSliderConverterFactory()

Gets the slider converter factory

Returns:

The slider converter factory

createRootFrame

IFrame createRootFrame(IFrameDescriptor descriptor)

Creates a root frame for the given descriptor

Parameters:

descriptor - The descriptor to create the frame for

Returns:

The created frame

createRootFrame

IFrame createRootFrame(IFrameDescriptor descriptor,
                     IApplicationLifecycle lifecycle)

Creates an root frame for the given descriptor and application lifecycle. When the rootFrame will be closed, the lifecycle will be finished.

Parameters:

descriptor - The descriptor to create the frame for

lifecycle - The lifecycle to bind on the frame

Returns:

the created frame

getWidgetFactory

IGenericWidgetFactory getWidgetFactory()

Gets the generic widget factory

Returns:

The generic widget factory

getWidgetWrapperFactory

IWidgetWrapperFactory getWidgetWrapperFactory()

Gets the widget wrapper factory that can be used to create wrappers for native widgets

Returns:

The widget wrapper factory

getImageFactory

IImageFactory getImageFactory()

Gets the image factory

Returns:

The image factory

getImageRegistry

IImageRegistry getImageRegistry()

Gets the image registry that can be used to register icons and images

Returns:

The image registry

getMessagePane

IMessagePane getMessagePane()

Gets the message pane that can be used to show user messages

Returns:

The message pane

getQuestionPane

IQuestionPane getQuestionPane()

Gets the question pane that can be used to ask user questions

Returns:

The question pane

getLoginPane

ILoginPane getLoginPane()

Gets the login pane that can be used for user login

Returns:

The login pane

getLayoutFactoryProvider

ILayoutFactoryProvider getLayoutFactoryProvider()

Gets the factory for layouts

Returns:

The layout factory provider

getLayoutConstraintsToolkit

ILayoutConstraintsToolkit getLayoutConstraintsToolkit()

Gets the layout constraints toolkit

Returns:

The layout constraints toolkit

getActionBuilderFactory

IActionBuilderFactory getActionBuilderFactory()

Gets the action builder factory

Returns:

The action builder factory

getDefaultActionFactory

IDefaultActionFactory getDefaultActionFactory()

Gets the default action factory

Returns:

The default action factory

getModelFactoryProvider

IModelFactoryProvider getModelFactoryProvider()

Gets the model factory provider

Returns:

The model factory provider

createTextMaskBuilder

ITextMaskBuilder createTextMaskBuilder()

Gets the text mask builder

Returns:

The text mask builder

getInputContentCreatorFactory

IInputContentCreatorFactory getInputContentCreatorFactory()

Gets the input content creator factory

Returns:

the input content creator factory

getWaitAnimationProcessor

IWaitAnimationProcessor getWaitAnimationProcessor()

Gets the wait animation processor

Returns:

the wait animation processor

getAnimationRunnerBuilder

IAnimationRunnerBuilder getAnimationRunnerBuilder()

Creates an animation runner builder

Returns:

An animation runner builder

getDelayedEventRunnerBuilder

IDelayedEventRunnerBuilder getDelayedEventRunnerBuilder()

Gets the delayed event runner builder

Returns:

The delayed event runner builder

getClipboard

IClipboard getClipboard()

Gets the system clipboard

Returns:

The system clipboard

createTransferableBuilder

ITransferableBuilder createTransferableBuilder()

Creates a transferable builder

Returns:

a transferable builder

getWidgetUtils

IWidgetUtils getWidgetUtils()

Gets the widget utils

Returns:

The widget utils

getActiveWindow

IWindow getActiveWindow()

Gets the active window

Returns:

The active window or null, if no active window exists

getAllWindows

java.util.List<IWindow> getAllWindows()

Gets a list of all windows

Returns:

A list of all windows

setValue

<VALUE_TYPE> void setValue(ITypedKey<VALUE_TYPE> key,
                         VALUE_TYPE value)

Sets a value for a typed key for the toolkit

Type Parameters:

VALUE_TYPE - The type of the value

Parameters:

key - The key

value - The value to set, may be null

getValue

<VALUE_TYPE> VALUE_TYPE getValue(ITypedKey<VALUE_TYPE> key)

Gets a value for a typed key

Type Parameters:

VALUE_TYPE - The type of the resulting value

Parameters:

key - The key to get the value for

Returns:

The value for the key, may be null

toScreen

Position toScreen(Position localPosition,
                IComponent component)

Transforms a local component position to a screen position

Parameters:

localPosition - Local position relative to the component

component - The component

Returns:

screen position

toLocal

Position toLocal(Position screenPosition,
               IComponent component)

Transforms a screen position to a local component position

Parameters:

screenPosition - Screen position

component - The component

Returns:

local position relative to the component

getSupportedWidgets

ISupportedWidgets getSupportedWidgets()

Gets the supported widgets information

Returns:

The supported widgets information

hasSpiMigLayoutSupport

boolean hasSpiMigLayoutSupport()

Checks if the underlying spi implementation has mig layout support

Returns:

True if native mig layout is supported, false otherwise