info.magnolia.ui

Interface UIComponent

All Superinterfaces:

Destructible, Serializable, View

All Known Subinterfaces:

Chooser<T>, ContentView, EditorView<T>, MediaEditorView

All Known Implementing Classes:

AboutMainSubApp, AbstractDetailSubApp, ActionbarView, BaseSubApp, BirdAttributeChooser, Browser, BrowserSubApp, ChooseBrowser, ConfigInfoSubApp, ContentBrowserSubApp, ContentBrowserSubApp.RootView, ContentDetailSubApp, ContentDetailSubApp.SubAppView, ContentViews, DetailSubApp, EmbeddedPageSubApp, FailedSubAppStub, FormView, FullTextSearchView, GridView, JcrBrowserContentViews, JcrBrowserSubApp, JcrBrowserWorkbench, LicensesInfoSubApp, ListView, MediaEditorViewImpl, MessagesMainSubApp, MultiFormView, NotificationBrowserSubApp, NotificationContentViews, NotificationDetailSubApp, NotificationFormView, NotificationListView, NotificationWorkbench, SampleEditorSubApp, SampleMainSubApp, SingleItemWorkbenchChooser, StaticFieldView, StatusBar, SwitchableFormView, SystemPropertiesToggleView, TaskDetailSubApp, TaskFormView, TasksContentViews, TasksListView, TasksSubApp, TasksWorkbench, ThumbnailView, ToolsSubApp, TreeView, UploadView, Workbench, WorkbenchChooser, WorkspaceSelectorView

public interface UIComponent
extends View, Destructible

View interface enhanced with some IoC-like capabilities based on the idea that each view is bound the BeanStore and is able to store objects inside of it, access the parent stores etc.

Method Summary

Modifier and Type	Method and Description
default BeanStore	accessViewBeanStore()
default com.vaadin.ui.Component	asVaadinComponent() Convenience method implementation.
default <T extends UiComponentContext> T	bindContext(Class<? extends T> contextClass) Create and bind an instance of the ui component context.
default <T> void	bindInstance(Class<T> type, T instance) Put an instance into the view's bean storage, making it injectable with UiComponentProvider.
default <T> T	create(Class type, Object... args) Convenience wrapper around ComponentProvider capabilities.
default <V extends UIComponent> V	create(String name, Class<V> type, Object... args)
default <V extends UIComponent> V	create(String name, WithImplementation<V> definition, Object... args)
default <T> T	create(WithImplementation<T> definition, Object... args) Convenience wrapper around ComponentProvider capabilities.
default void	destroy() Cleans up the related bean store, detaches the from the parent Vaadin component, recursively destroys the child views.
default UiComponentProvider	getComponentProvider()
default UiContextReference	getCurrentViewReference()

Method Detail

asVaadinComponent

default com.vaadin.ui.Component asVaadinComponent()

Convenience method implementation.

Specified by:

asVaadinComponent in interface View

destroy

default void destroy()

Cleans up the related bean store, detaches the from the parent Vaadin component, recursively destroys the child views.

Specified by:

destroy in interface Destructible

bindInstance

default <T> void bindInstance(Class<T> type,
                              T instance)

Put an instance into the view's bean storage, making it injectable with UiComponentProvider.

Type Parameters:

T - type of the shared instance

bindContext

default <T extends UiComponentContext> T bindContext(Class<? extends T> contextClass)

Create and bind an instance of the ui component context. The provided argument is typically an interface, whose implementation is auto-generated on the fly. The instance of the ui component context is the stored in the view's bean storage and share in similar fashion link bindInstance(Class, Object) does.

Type Parameters:

T - type of the ui component context

create

default <V extends UIComponent> V create(String name,
                                         WithImplementation<V> definition,
                                         Object... args)

create

default <T> T create(WithImplementation<T> definition,
                     Object... args)

Convenience wrapper around ComponentProvider capabilities. Creates and instance of a type specified by a passed WithImplementation instance.

Type Parameters:

T - type of an instance to be created

create

default <V extends UIComponent> V create(String name,
                                         Class<V> type,
                                         Object... args)

create

default <T> T create(Class type,
                     Object... args)

Convenience wrapper around ComponentProvider capabilities.

Type Parameters:

T - type of an instance to be created

getComponentProvider

default UiComponentProvider getComponentProvider()

getCurrentViewReference

default UiContextReference getCurrentViewReference()

accessViewBeanStore

default BeanStore accessViewBeanStore()