Package com.vaadin.flow.internal.nodefeature

Class VirtualChildrenList

java.lang.Object

com.vaadin.flow.internal.nodefeature.NodeFeature

com.vaadin.flow.internal.nodefeature.NodeList<StateNode>

com.vaadin.flow.internal.nodefeature.StateNodeNodeList

com.vaadin.flow.internal.nodefeature.VirtualChildrenList

All Implemented Interfaces:

Serializable

public class VirtualChildrenList
extends StateNodeNodeList

List of nodes describing the virtually connected child elements of an element.

For internal use only. May be renamed or removed in a future release.

Since:

1.0

Author:

Vaadin Ltd

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.internal.nodefeature.NodeList

NodeList.SetView<T extends Serializable>

Constructor Summary

Constructors

Constructor	Description
VirtualChildrenList(StateNode node)	Creates a new element virtual children list for the given node.

Method Summary

Modifier and Type	Method	Description
void	add(int index, StateNode node, String type)	Inserts an item supplied with payload type at the given index of the list.
void	add(int index, StateNode node, String type, com.fasterxml.jackson.databind.JsonNode payload)	Inserts an item supplied with payload data at the given index of the list.
void	add(int index, StateNode node, String type, String payload)	Inserts an item supplied with payload data at the given index of the list.
void	append(StateNode node, String type)	Appends an item supplied with payload type as last in the list.
void	append(StateNode node, String type, com.fasterxml.jackson.databind.JsonNode payload)	Appends an item supplied with payload data as last in the list.
void	append(StateNode node, String type, String payload)	Appends an item supplied with payload data as last in the list.
protected void	clear()	Removes all nodes, including those not known by the server.
StateNode	get(int index)	Gets the item at the given index.
int	indexOf(StateNode node)	Gets the position of a value in the list.
Iterator<StateNode>	iterator()	Gets an iterator returning all items in this list.
StateNode	remove(int index)	Removes the item at the given index.
int	size()	Gets the number of items in this list.

Methods inherited from class com.vaadin.flow.internal.nodefeature.StateNodeNodeList

add, addAll, forEachChild, isNodeValues

Methods inherited from class com.vaadin.flow.internal.nodefeature.NodeList

add, collectChanges, generateChangesFromEmpty, getChangeTracker, onDetach

Methods inherited from class com.vaadin.flow.internal.nodefeature.NodeFeature

allowsChanges, attachPotentialChild, detatchPotentialChild, getNode, onAttach

Methods inherited from class java.lang.Object

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

Constructor Details

VirtualChildrenList

public VirtualChildrenList(StateNode node)

Creates a new element virtual children list for the given node.

Parameters:

node - the node that the list belongs to

Method Details

add

public void add(int index,
 StateNode node,
 String type,
 String payload)

Inserts an item supplied with payload data at the given index of the list.

Parameters:

index - index to insert at

node - the item to append

type - the payload type

payload - the payload data

add

public void add(int index,
 StateNode node,
 String type,
 com.fasterxml.jackson.databind.JsonNode payload)

Inserts an item supplied with payload data at the given index of the list.

Parameters:

index - index to insert at

node - the item to append

type - the payload type

payload - the payload data

add

public void add(int index,
 StateNode node,
 String type)

Inserts an item supplied with payload type at the given index of the list.

Parameters:

index - index to insert at

node - the item to append

type - the payload type

append

public void append(StateNode node,
 String type,
 String payload)

Appends an item supplied with payload data as last in the list.

Parameters:

node - the item to append

type - the payload type

payload - the payload data

append

public void append(StateNode node,
 String type,
 com.fasterxml.jackson.databind.JsonNode payload)

Appends an item supplied with payload data as last in the list.

Parameters:

node - the item to append

type - the payload type

payload - the payload data

append

public void append(StateNode node,
 String type)

Appends an item supplied with payload type as last in the list.

Parameters:

node - the item to append

type - the payload type

get

public StateNode get(int index)

Description copied from class: NodeList

Gets the item at the given index.

Overrides:

get in class NodeList<StateNode>

Parameters:

index - the of the desired item

Returns:

the item at the given index

iterator

public Iterator<StateNode> iterator()

Description copied from class: NodeList

Gets an iterator returning all items in this list.

Overrides:

iterator in class NodeList<StateNode>

Returns:

an iterator returning all items

indexOf

public int indexOf(StateNode node)

Description copied from class: NodeList

Gets the position of a value in the list.

Overrides:

indexOf in class NodeList<StateNode>

Parameters:

node - the value to look for

Returns:

the position in the list or -1 if not found

remove

public StateNode remove(int index)

Description copied from class: NodeList

Removes the item at the given index.

Overrides:

remove in class StateNodeNodeList

Parameters:

index - index of the item to remove

Returns:

the element previously at the specified position

clear

protected void clear()

Description copied from class: NodeList

Removes all nodes, including those not known by the server.

Overrides:

clear in class StateNodeNodeList

size

public int size()

Description copied from class: NodeList

Gets the number of items in this list.

Overrides:

size in class NodeList<StateNode>

Returns:

the number of items