com.haulmont.cuba.gui.xml.layout

Interface ComponentsFactory

All Known Implementing Classes:

DesktopComponentsFactory, WebComponentsFactory

public interface ComponentsFactory

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
<T extends Component> T	createComponent(java.lang.Class<T> type) Create a component instance by its type.
Component	createComponent(ComponentGenerationContext context) Creates a component according to the given ComponentGenerationContext.
Component	createComponent(java.lang.String name) Create a component instance by its name.
Timer	createTimer() Create a timer instance.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

createComponent

Component createComponent(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 for the current client type (web or desktop)

createComponent

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

Create a component instance by its type.

Parameters:

type - component type

Returns:

component instance for the current client type (web or desktop)

createComponent

Component createComponent(ComponentGenerationContext context)

Creates a component according to the given ComponentGenerationContext.

Trying to find ComponentGenerationStrategy implementations. If at least one strategy exists, then:

1. Iterates over strategies according to the Ordered interface.
2. Returns the first created not null component.

Parameters:

context - the ComponentGenerationContext instance

Returns:

a component instance for the current client type (web or desktop)

Throws:

java.lang.IllegalArgumentException - if no component can be created for a given context

createTimer

Timer createTimer()

Create a timer instance.

Returns:

client-specific implementation of the timer