Package io.jmix.flowui

Class ViewNavigators

java.lang.Object

io.jmix.flowui.ViewNavigators

@Component("flowui_ViewNavigators")
public class ViewNavigators
extends Object

Provides fluent interface for navigating to views.

Field Summary

Fields

Modifier and Type	Field	Description
protected DetailViewNavigationProcessor	detailViewNavigationProcessor
protected ListViewNavigationProcessor	listViewNavigationProcessor
protected ViewNavigationProcessor	viewNavigationProcessor

Constructor Summary

Constructors

Constructor	Description
ViewNavigators(DetailViewNavigationProcessor detailViewNavigationProcessor, ListViewNavigationProcessor listViewNavigationProcessor, ViewNavigationProcessor viewNavigationProcessor)

Method Summary

Modifier and Type	Method	Description
<E> DetailViewNavigator<E>	detailView(EntityPickerComponent<E> picker)	Creates a detail view navigator to edit an entity selected in the picker component.
<E> DetailViewNavigator<E>	detailView(ListDataComponent<E> listDataComponent)	Creates a detail view navigator to edit an entity selected in the list component.
<E> DetailViewNavigator<E>	detailView(View<?> origin, Class<E> entityClass)	Creates a detail view navigator for an entity class.
<E> DetailViewNavigator<E>	detailView(Class<E> entityClass)	Deprecated, for removal: This API element is subject to removal in a future version. use detailView(View, Class) instead
protected <E> Class<E>	getBeanType(EntityPickerComponent<E> picker)
protected <E> Class<E>	getBeanType(ListDataComponent<E> listDataComponent)
<E> ListViewNavigator<E>	listView(View<?> origin, Class<E> entityClass)	Creates a list view navigator for an entity class.
<E> ListViewNavigator<E>	listView(Class<E> entityClass)	Deprecated, for removal: This API element is subject to removal in a future version. use listView(View, Class) instead
<V extends View<?>> ViewClassNavigator<V>	view(View<?> origin, Class<V> viewClass)	Creates a view navigator.
ViewNavigator	view(View<?> origin, String viewId)	Creates a view navigator.
<V extends View<?>> ViewClassNavigator<V>	view(Class<V> viewClass)	Deprecated, for removal: This API element is subject to removal in a future version. use view(View, Class) instead
ViewNavigator	view(String viewId)	Deprecated, for removal: This API element is subject to removal in a future version. use view(View, String) instead

Methods inherited from class java.lang.Object

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

Field Details

detailViewNavigationProcessor

protected DetailViewNavigationProcessor detailViewNavigationProcessor

listViewNavigationProcessor

protected ListViewNavigationProcessor listViewNavigationProcessor

viewNavigationProcessor

protected ViewNavigationProcessor viewNavigationProcessor

Constructor Details

ViewNavigators

public ViewNavigators(DetailViewNavigationProcessor detailViewNavigationProcessor,
 ListViewNavigationProcessor listViewNavigationProcessor,
 ViewNavigationProcessor viewNavigationProcessor)

Method Details

detailView

@Deprecated(since="2.3",
            forRemoval=true)
public <E> DetailViewNavigator<E> detailView(Class<E> entityClass)

Deprecated, for removal: This API element is subject to removal in a future version.

use detailView(View, Class) instead

Creates a detail view navigator for an entity class.

Example of navigating to a view for editing an entity:

 viewNavigators.detailView(Customer.class)
         .editEntity(customersTable.getSingleSelectedItem())
         .withViewClass(CustomerDetailView.class)
         .navigate();
 

Example of navigating to a view for creating a new entity instance:

 viewNavigators.detailView(Customer.class)
         .newEntity()
         .withViewClass(CustomerDetailView.class)
         .navigate();
 

Parameters:

entityClass - edited entity class

detailView

public <E> DetailViewNavigator<E> detailView(View<?> origin,
 Class<E> entityClass)

Creates a detail view navigator for an entity class.

Example of navigating to a view for editing an entity:

 viewNavigators.detailView(this, Customer.class)
         .editEntity(customersTable.getSingleSelectedItem())
         .withViewClass(CustomerDetailView.class)
         .navigate();
 

Example of navigating to a view for creating a new entity instance:

 viewNavigators.detailView(this, Customer.class)
         .newEntity()
         .withViewClass(CustomerDetailView.class)
         .navigate();
 

Parameters:

origin - calling view

entityClass - edited entity class

detailView

public <E> DetailViewNavigator<E> detailView(ListDataComponent<E> listDataComponent)

Creates a detail view navigator to edit an entity selected in the list component.

Parameters:

listDataComponent - the component which provides a selected entity to edit

See Also:

• detailView(View, Class)

detailView

public <E> DetailViewNavigator<E> detailView(EntityPickerComponent<E> picker)

Creates a detail view navigator to edit an entity selected in the picker component.

Parameters:

picker - the component which provides an entity to edit

See Also:

• detailView(View, Class)

listView

@Deprecated(since="2.3",
            forRemoval=true)
public <E> ListViewNavigator<E> listView(Class<E> entityClass)

Deprecated, for removal: This API element is subject to removal in a future version.

use listView(View, Class) instead

Creates a list view navigator for an entity class.

Example of navigating to a view for editing an entity and returning to the calling view:

 viewNavigators.listView(Customer.class)
         .withViewClass(CustomerListView.class)
         .withBackwardNavigation(true)
         .navigate();
 

Parameters:

entityClass - edited entity class

listView

public <E> ListViewNavigator<E> listView(View<?> origin,
 Class<E> entityClass)

Creates a list view navigator for an entity class.

Example of navigating to a view for editing an entity and returning to the calling view:

 viewNavigators.listView(this, Customer.class)
         .withViewClass(CustomerListView.class)
         .withBackwardNavigation(true)
         .navigate();
 

Parameters:

origin - calling view

entityClass - edited entity class

view

@Deprecated(since="2.3",
            forRemoval=true)
public <V extends View<?>> ViewClassNavigator<V> view(Class<V> viewClass)

Deprecated, for removal: This API element is subject to removal in a future version.

use view(View, Class) instead

Creates a view navigator.

Parameters:

viewClass - class of the view to navigate to

view

public <V extends View<?>> ViewClassNavigator<V> view(View<?> origin,
 Class<V> viewClass)

Creates a view navigator.

Parameters:

origin - calling view

viewClass - class of the view to navigate to

view

@Deprecated(since="2.3",
            forRemoval=true)
public ViewNavigator view(String viewId)

Deprecated, for removal: This API element is subject to removal in a future version.

use view(View, String) instead

Creates a view navigator.

Parameters:

viewId - id of the view to navigate to (as set in the ViewController annotation)

view

public ViewNavigator view(View<?> origin,
 String viewId)

Creates a view navigator.

Parameters:

origin - calling view

viewId - id of the view to navigate to (as set in the ViewController annotation)

getBeanType

protected <E> Class<E> getBeanType(ListDataComponent<E> listDataComponent)

getBeanType

protected <E> Class<E> getBeanType(EntityPickerComponent<E> picker)