org.jowidgets.api.toolkit

Class Toolkit

java.lang.Object

org.jowidgets.api.toolkit.Toolkit

public final class Toolkit
extends java.lang.Object

Method Summary

Methods

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

initialize

public static void initialize(IToolkitProvider toolkitProvider)

Initializes the toolkit

Parameters:

toolkitProvider - The toolkit provider to use for initialization

initializeForTests

public static void initializeForTests(IToolkitProvider toolkitProvider)

Sets the toolkit provider for test purpose, e.g. in the setUp() method of an JUnit test. Remark: Do only use this method in test code

Parameters:

toolkitProvider - The toolkit provider to use for initialization

resetAfterTests

public static void resetAfterTests()

Resets the toolkit to its initial state, e.g. in the tearDown() method of an JUnit test. Remark: Do only use this method in test code

isInitialized

public static boolean isInitialized()

getInstance

public static IToolkit getInstance()

Gets the instance of the toolkit.

Returns:

The toolkit instance, never null

Throws:

java.lang.IllegalStateException - If no toolkit implementation was registered or more than one toolkit is registered by Java Service Loader

getApplicationRunner

public static IApplicationRunner getApplicationRunner()

Gets the toolkits application runner

Returns:

The toolkits application runner

getUiThreadAccess

public static 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

public static IBluePrintFactory getBluePrintFactory()

Gets the blue print factory

Returns:

The blue print factory

getBluePrintProxyFactory

public static IBluePrintProxyFactory getBluePrintProxyFactory()

Gets the blue print proxy factory

Returns:

The blue print proxy factory, never null

getConverterProvider

public static IConverterProvider getConverterProvider()

Gets the toolkits converter provider

Returns:

The toolkits converter provider

getSliderConverterFactory

public static ISliderConverterFactory getSliderConverterFactory()

Gets the slider converter factory

Returns:

The slider converter factory

createRootFrame

public static 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

public static 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

public static IGenericWidgetFactory getWidgetFactory()

Gets the generic widget factory

Returns:

The generic widget factory

getWidgetWrapperFactory

public static IWidgetWrapperFactory getWidgetWrapperFactory()

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

Returns:

The widget wrapper factory

getImageFactory

public static IImageFactory getImageFactory()

Gets the image factory

Returns:

The image factory

getImageRegistry

public static IImageRegistry getImageRegistry()

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

Returns:

The image registry

getMessagePane

public static IMessagePane getMessagePane()

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

Returns:

The message pane

getQuestionPane

public static IQuestionPane getQuestionPane()

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

Returns:

The question pane

getLoginPane

public static ILoginPane getLoginPane()

Gets the login pane that can be used for user login

Returns:

The login pane

getLayoutFactoryProvider

public static ILayoutFactoryProvider getLayoutFactoryProvider()

Gets the factory for layouts

Returns:

The layout factory provider

getLayoutConstraintsToolkit

public static ILayoutConstraintsToolkit getLayoutConstraintsToolkit()

Gets the layout constraints toolkit

Returns:

The layout constraints toolkit

getActionBuilderFactory

public static IActionBuilderFactory getActionBuilderFactory()

Gets the action builder factory

Returns:

The action builder factory

getDefaultActionFactory

public static IDefaultActionFactory getDefaultActionFactory()

Gets the default action factory

Returns:

The default action factory

getModelFactoryProvider

public static IModelFactoryProvider getModelFactoryProvider()

Gets the model factory provider

Returns:

The model factory provider

createTextMaskBuilder

public static ITextMaskBuilder createTextMaskBuilder()

Gets the text mask builder

Returns:

The text mask builder

getInputContentCreatorFactory

public static IInputContentCreatorFactory getInputContentCreatorFactory()

Gets the input content creator factory

Returns:

the input content creator factory

getWaitAnimationProcessor

public static IWaitAnimationProcessor getWaitAnimationProcessor()

Gets the wait animation processor

Returns:

the wait animation processor

getAnimationRunnerBuilder

public static IAnimationRunnerBuilder getAnimationRunnerBuilder()

Creates an animation runner builder

Returns:

An animation runner builder

getDelayedEventRunnerBuilder

public static IDelayedEventRunnerBuilder getDelayedEventRunnerBuilder()

Gets the delayed event runner builder

Returns:

The delayed event runner builder

getClipboard

public static IClipboard getClipboard()

Gets the system clipboard

Returns:

The system clipboard

createTransferableBuilder

public static ITransferableBuilder createTransferableBuilder()

Creates a transferable builder

Returns:

a transferable builder

getWidgetUtils

public static IWidgetUtils getWidgetUtils()

Gets the widget utils

Returns:

The widget utils

getActiveWindow

public static IWindow getActiveWindow()

Gets the active window

Returns:

The active window or null, if no active window exists

getAllWindows

public static java.util.List<IWindow> getAllWindows()

Gets a list of all windows

Returns:

A list of all windows

setValue

public static <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

public static <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

public static 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

public static 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

public static ISupportedWidgets getSupportedWidgets()

Gets the supported widgets information

Returns:

The supported widgets information

hasSpiMigLayoutSupport

public static boolean hasSpiMigLayoutSupport()

Checks if the underlying spi implementation has mig layout support

Returns:

True if native mig layout is supported, false otherwise