com.vaadin.flow.data.provider.hierarchy.HierarchicalArrayUpdater.HierarchicalUpdate API 24.7.0.beta2 | Vaadin

com.vaadin.flow.data.provider.hierarchy.

All Superinterfaces:

ArrayUpdater.Update, Serializable

Enclosing interface:

HierarchicalArrayUpdater

public static interface HierarchicalArrayUpdater.HierarchicalUpdate extends ArrayUpdater.Update

Array updater strategy that is aware of hierarchical changes.

Method Summary

Modifier and Type

Method

Description

void

clear(int start, int length, String parentKey)

Clears length elements in array from the start position.

void

commit()

Commits enqueued function calls added via enqueue(String, Serializable...).

void

commit(int updateId, String parentKey, int levelSize)

Commits changes for the given updateId and parent key.

void

enqueue(String name, Serializable... arguments)

Enqueue function call with the given arguments.

void

set(int start, List<elemental.json.JsonValue> items, String parentKey)

Sets the items at the start position.

Methods inherited from interface com.vaadin.flow.data.provider.ArrayUpdater.Update
clear, commit, set

Method Details
- clear
  
  void clear(int start, int length, String parentKey)
  
  Clears length elements in array from the start position.
  
  Parameters:
  
  start - the start index
  
  length - the number of elements to clear
  
  parentKey - Parent item key that cleared range affects
- set
  
  void set(int start, List<elemental.json.JsonValue> items, String parentKey)
  
  Sets the items at the start position.
  
  Parameters:
  
  start - the start index
  
  items - the items to set
  
  parentKey - Parent item key where given items belongs to
- commit
  
  void commit()
  
  Commits enqueued function calls added via enqueue(String, Serializable...).
- enqueue
  
  void enqueue(String name, Serializable... arguments)
  
  Enqueue function call with the given arguments.
  Parameters:
  
  name - the name of the function to call, may contain dots to indicate a function on a property.
  
  arguments - the arguments to pass to the function. Must be of a type supported by the communication mechanism, as defined by JsonCodec
  
  See Also:
  
  JsonCodec for supported argument types
- commit
  
  void commit(int updateId, String parentKey, int levelSize)
  
  Commits changes for the given updateId and parent key.
  
  Parameters:
  
  updateId - the update identifier of the commit for the target parentKey
  
  parentKey - target parent key
  
  levelSize - Total number of direct child items for the given parent key