com.haulmont.cuba.gui

Class ScreenBuilders

java.lang.Object

com.haulmont.cuba.gui.ScreenBuilders

@Component(value="cuba_ScreenBuilders")
public class ScreenBuilders
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected EditorBuilderProcessor	editorBuilderProcessor
protected LookupBuilderProcessor	lookupBuilderProcessor
protected ScreenBuilderProcessor	screenBuilderProcessor

Constructor Summary

Constructors

Constructor and Description
ScreenBuilders()

Method Summary

Modifier and Type	Method and Description
<E extends Entity> EditorBuilder<E>	editor(java.lang.Class<E> entityClass, FrameOwner origin) Creates a screen builder.
<E extends Entity> EditorBuilder<E>	editor(ListComponent<E> listComponent) Creates a screen builder using list component.
<E extends Entity> EditorBuilder<E>	editor(PickerField<E> field) Creates a screen builder using PickerField component.
<E extends Entity> LookupBuilder<E>	lookup(java.lang.Class<E> entityClass, FrameOwner origin) Creates a screen builder.
<E extends Entity> LookupBuilder<E>	lookup(ListComponent<E> listComponent) Creates a screen builder using list component.
<E extends Entity> LookupBuilder<E>	lookup(PickerField<E> field) Creates a screen builder using PickerField component.
ScreenBuilder	screen(FrameOwner origin) Creates a screen builder.

Methods inherited from class java.lang.Object

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

Field Detail

editorBuilderProcessor

@Inject
protected EditorBuilderProcessor editorBuilderProcessor

lookupBuilderProcessor

@Inject
protected LookupBuilderProcessor lookupBuilderProcessor

screenBuilderProcessor

@Inject
protected ScreenBuilderProcessor screenBuilderProcessor

Constructor Detail

ScreenBuilders

public ScreenBuilders()

Method Detail

editor

public <E extends Entity> EditorBuilder<E> editor(java.lang.Class<E> entityClass,
                                                  FrameOwner origin)

Creates a screen builder.

Example of building a screen for editing an entity:

 SomeCustomerEditor screen = screenBuilders.editor(Customer.class, this)
         .withScreen(SomeCustomerEditor.class)
         .withListComponent(customersTable)
         .editEntity(customersTable.getSingleSelected())
         .build();
 

Example of building a screen for creating a new entity instance:

 SomeCustomerEditor screen = screenBuilders.editor(Customer.class, this)
         .withScreen(SomeCustomerEditor.class)
         .withListComponent(customersTable)
         .newEntity()
         .build();
 

Parameters:

entityClass - edited entity class

origin - invoking screen

See Also:

editor(ListComponent)

editor

public <E extends Entity> EditorBuilder<E> editor(ListComponent<E> listComponent)

Creates a screen builder using list component.

Example of building a screen for editing a currently selected entity:

 SomeCustomerEditor screen = screenBuilders.editor(customersTable)
          .withScreen(SomeCustomerEditor.class)
          .build();
 

Example of building a screen for creating a new entity instance:

 SomeCustomerEditor screen = screenBuilders.editor(customersTable)
          .withScreen(SomeCustomerEditor.class)
          .newEntity()
          .build();
 

Parameters:

listComponent - Table, DataGrid or another component containing the list of entities

See Also:

editor(Class, FrameOwner)

editor

public <E extends Entity> EditorBuilder<E> editor(PickerField<E> field)

Creates a screen builder using PickerField component.

Example of building a screen for editing a currently set value:

 SomeCustomerEditor screen = screenBuilders.editor(customerPickerField)
          .withScreen(SomeCustomerEditor.class)
          .build();
 

Example of building a screen for creating a new entity instance:

 SomeCustomerEditor screen = screenBuilders.editor(customerPickerField)
          .withScreen(SomeCustomerEditor.class)
          .newEntity()
          .build();
 

Parameters:

field - PickerField, LookupPickerField or another picker component

See Also:

editor(Class, FrameOwner)

lookup

public <E extends Entity> LookupBuilder<E> lookup(java.lang.Class<E> entityClass,
                                                  FrameOwner origin)

Creates a screen builder.

Example of building a lookup screen for adding instance to data container:

 SomeCustomerListScreen screen = screenBuilders.lookup(Customer.class, this)
         .withScreen(SomeCustomerListScreen.class)
         .withOpenMode(OpenMode.DIALOG)
         .withContainer(customersDc)
         .build();
 

Example of building a lookup screen with custom select handler:

 SomeCustomerListScreen screen = screenBuilders.lookup(Customer.class, this)
         .withScreen(SomeCustomerListScreen.class)
         .withOpenMode(OpenMode.DIALOG)
         .withSelectHandler(customers -> {
             // customers contains selected values
         })
         .build();
 

Type Parameters:

E - type of entity

Parameters:

entityClass - entity class

origin - invoking screen

lookup

public <E extends Entity> LookupBuilder<E> lookup(ListComponent<E> listComponent)

Creates a screen builder using list component.

Example of building a lookup screen for adding row to table / tree component:

 SomeCustomerListScreen screen = screenBuilders.lookup(customersTable)
         .withScreen(SomeCustomerListScreen.class)
         .build();
 

Type Parameters:

E - type of entity

Parameters:

listComponent - Table, DataGrid or another component containing the list of entities

See Also:

lookup(Class, FrameOwner)

lookup

public <E extends Entity> LookupBuilder<E> lookup(PickerField<E> field)

Creates a screen builder using PickerField component.

Example of building a lookup screen for setting value to PickerField:

 SomeCustomerListScreen screen = screenBuilders.lookup(customerPickerField)
         .withScreen(SomeCustomerListScreen.class)
         .build();
 

Type Parameters:

E - type of entity

Parameters:

field - PickerField, LookupPickerField or another picker component

See Also:

lookup(Class, FrameOwner)

screen

public ScreenBuilder screen(FrameOwner origin)

Creates a screen builder.

Example of building a screen:

 SomeScreen screen = screenBuilders.screen(this)
         .withScreen(SomeScreen.class)
         .build();
 

Parameters:

origin - invoking screen