de.saxsys.mvvmfx.utils.viewlist

Class CachedViewModelCellFactory<V extends de.saxsys.mvvmfx.internal.viewloader.View<VM>,VM extends ViewModel>

java.lang.Object

de.saxsys.mvvmfx.utils.viewlist.CachedViewModelCellFactory<V,VM>

All Implemented Interfaces:

ViewListCellFactory<VM>, ViewTupleMapper<VM>, javafx.util.Callback<javafx.scene.control.ListView<VM>,javafx.scene.control.ListCell<VM>>

@Beta
public class CachedViewModelCellFactory<V extends de.saxsys.mvvmfx.internal.viewloader.View<VM>,VM extends ViewModel>
extends Object
implements ViewListCellFactory<VM>

An implementation of the ViewListCellFactory that can be used for ListViews that are based on a list of ViewModels. Additionally this CellFactory has a cache for ViewTuples that where already loaded before.

This can be useful because the ListView can call the CellFactory not only when the items list changes but also on other events like scrolling. Without a cache a new View would be loaded each time. This can cause unwanted effects like view items that are not responding to clicks on controls in the item view.

Typical useage:

 public class OverviewView implements FxmlView <OverviewViewModel> {

      @FXML
     public ListView <ItemViewModel> itemList;
      @InjectViewModel
     private OverviewViewModel viewModel;

     public void initialize(){
                itemList.setItems(viewModel.itemsProperty());

                itemList.setCellFactory(CachedViewModelCellFactory.createForFxmlView(ItemView.class));
     }
 }
 

The example above uses the createForFxmlView(Class) factory method for a specific View type.
If you need more control over the loading process (like providing custom resourceBundles) you can use the create(Callback) method instead. This method takes a Callback as argument. This callback gets an instance of the ViewModel as argument and has to return a ViewTuple for this viewModel. This means that you have to call the FluentViewLoader by yourself.
See the following example which is equivalent to the one above:

 itemList.setCellFactory(CachedViewModelCellFactory.create(
                vm -> FluentViewLoader.fxmlView(ItemView.class).viewModel(vm).load()));
 

Author:

manuel.mauky

Constructor Summary

Constructors

Constructor and Description
CachedViewModelCellFactory(javafx.util.Callback<VM,ViewTuple<V,VM>> loadFactory)

Method Summary

Modifier and Type	Method and Description
static <V extends de.saxsys.mvvmfx.internal.viewloader.View<VM>,VM extends ViewModel> CachedViewModelCellFactory<V,VM>	create(javafx.util.Callback<VM,ViewTuple<V,VM>> callback)
static <V extends FxmlView<VM>,VM extends ViewModel> CachedViewModelCellFactory<V,VM>	createForFxmlView(Class<V> viewType)
static <V extends JavaView<VM>,VM extends ViewModel> CachedViewModelCellFactory<V,VM>	createForJavaView(Class<V> viewType)
ViewTuple<V,VM>	map(VM viewModel) Map a <T> to a ViewTuple.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.saxsys.mvvmfx.utils.viewlist.ViewListCellFactory

call

Constructor Detail

CachedViewModelCellFactory

public CachedViewModelCellFactory(javafx.util.Callback<VM,ViewTuple<V,VM>> loadFactory)

Method Detail

map

public ViewTuple<V,VM> map(VM viewModel)

Description copied from interface: ViewTupleMapper

Map a <T> to a ViewTuple.

Specified by:

map in interface ViewListCellFactory<VM extends ViewModel>

Specified by:

map in interface ViewTupleMapper<VM extends ViewModel>

Parameters:

viewModel - to map

Returns:

created ViewTuple

create

public static <V extends de.saxsys.mvvmfx.internal.viewloader.View<VM>,VM extends ViewModel> CachedViewModelCellFactory<V,VM> create(javafx.util.Callback<VM,ViewTuple<V,VM>> callback)

createForFxmlView

public static <V extends FxmlView<VM>,VM extends ViewModel> CachedViewModelCellFactory<V,VM> createForFxmlView(Class<V> viewType)

createForJavaView

public static <V extends JavaView<VM>,VM extends ViewModel> CachedViewModelCellFactory<V,VM> createForJavaView(Class<V> viewType)