net.sf.mmm.client.ui.api

Interface UiContext

All Known Implementing Classes:

AbstractUiContext, AbstractUiContextImpl, UiContextGwt, UiContextImpl, UiContextTestImpl

public interface UiContext

This is the interface for the context of the UI. In various places you can use CDI (Context and Dependency Injection) to get access to arbitrary components. Even though this is still a recommended pattern also for clients there are some limitations (lack of features on platforms like web). Further, clients have smaller components created with new for simplicity. Injecting Providers for this would make the programming much more complex. In such cases you need to pass required components manually. This context is a container to make this easy and maintainable.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
UiConfiguration	getConfiguration() This method gets the UiConfiguration for this factory.
ComponentContainer	getContainer()
UiDispatcher	getDispatcher()
UiDisplay	getDisplay() This method gets the UiDisplay e.g.
UiPopupHelper	getPopupHelper()
RoleFactory	getRoleFactory()
UiWidgetFactory	getWidgetFactory() This method gets the UiWidgetFactory that is used to create UiWidgets.

Method Detail

getDisplay

UiDisplay getDisplay()

This method gets the UiDisplay e.g. to read the current screen resolution.

Returns:

the UiDisplay.

getDispatcher

UiDispatcher getDispatcher()

Returns:

the UiDispatcher.

getContainer

ComponentContainer getContainer()

Returns:

the instance of ComponentContainer.

getWidgetFactory

UiWidgetFactory getWidgetFactory()

This method gets the UiWidgetFactory that is used to create UiWidgets.

Returns:

the UiWidgetFactory.

getPopupHelper

UiPopupHelper getPopupHelper()

Returns:

the instance of UiPopupHelper.

getConfiguration

UiConfiguration getConfiguration()

This method gets the UiConfiguration for this factory. It is intended to be read by UiWidget implementations to configure their look and feel.

Returns:

the UiConfiguration.

getRoleFactory

RoleFactory getRoleFactory()

Returns:

the instance of RoleFactory.