io.jmix.ui

Interface UiComponents

All Known Implementing Classes:

UiComponentsImpl

public interface UiComponents

Factory to create UI components in client independent manner.
An instance of the factory can be injected into screen controllers or obtained through ApplicationContext.

Method Summary

Modifier and Type	Method and Description
<T extends Component> T	create(java.lang.Class<T> type) Create a component instance by its type.
<T extends Component> T	create(org.springframework.core.ParameterizedTypeReference<T> type) Create a component instance by its type.
<T extends Component> T	create(java.lang.String name) Create a component instance by its name.
boolean	isComponentRegistered(java.lang.Class<?> type) Checks that a component with given type is registered.
boolean	isComponentRegistered(java.lang.String name) Checks that a component with given name is registered.

Method Detail

create

<T extends Component> T create(java.lang.String name)

Create a component instance by its name.

Parameters:

name - component name. It is usually defined in NAME constant inside the component interface, e.g. Label.NAME. It is also usually equal to component's XML name.

Returns:

component instance

create

<T extends Component> T create(java.lang.Class<T> type)

Create a component instance by its type.

Parameters:

type - component type

Returns:

component instance

create

<T extends Component> T create(org.springframework.core.ParameterizedTypeReference<T> type)

Create a component instance by its type.

Parameters:

type - component type reference

Returns:

component instance

See Also:

Label.TYPE_DEFAULT, TextField.TYPE_DEFAULT

isComponentRegistered

boolean isComponentRegistered(java.lang.String name)

Checks that a component with given name is registered.

Parameters:

name - component name. It is usually defined in NAME constant inside the component interface, e.g. Label.NAME. It is also usually equal to component's XML name.

Returns:

true if the component is registered

isComponentRegistered

boolean isComponentRegistered(java.lang.Class<?> type)

Checks that a component with given type is registered.

Parameters:

type - component type reference

Returns:

true if the component is registered