com.vaadin.flow.dom.impl.

java.lang.Object
- com.vaadin.flow.dom.impl.AbstractNodeStateProvider

All Implemented Interfaces:

ElementStateProvider, Serializable

Direct Known Subclasses:

BasicElementStateProvider, ShadowRootStateProvider
```
public abstract class AbstractNodeStateProvider
extends Object
implements ElementStateProvider
```
Abstract implementation of the ElementStateProvider related to the composition essence of the provider.
For internal use only. May be renamed or removed in a future release.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

AbstractNodeStateProvider()

Method Summary

All Methods
Modifier and Type	Method	Description
`void`	`appendVirtualChild(StateNode node, Element child, String type, String payload)`	Append the given element as a virtual child.
`void`	`attachExistingElement(StateNode node, String tagName, Element previousSibling, ChildElementConsumer callback)`	Attaches a child element with the given `tagName` which is the next sibling for the `previousSibling`.
`Element`	`getChild(StateNode node, int index)`	Returns the child element at the given position.
`int`	`getChildCount(StateNode node)`	Gets the number of child elements.
`protected abstract Node<?>`	`getNode(StateNode node)`	Gets the flyweight instance for the `node` supported by the provider.
`Node`	`getParent(StateNode node)`	Gets the parent element.
`protected abstract Class<? extends NodeFeature>[]`	`getProviderFeatures()`	Returns the features supported by the provider.
`void`	`insertChild(StateNode node, int index, Element child)`	Inserts the given child at the given position.
`void`	`removeAllChildren(StateNode node)`	Removes all child elements.
`void`	`removeChild(StateNode node, int index)`	Removes the child at the given position.
`void`	`removeChild(StateNode node, Element child)`	Removes the given child.
`boolean`	`supports(StateNode node)`	Checks if the element state provider supports the given state node.
`protected void`	`visitDescendants(Node<?> node, NodeVisitor visitor)`	Apply the `visitor` for the descendants of the `node`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.flow.dom.ElementStateProvider
addEventListener, addPropertyChangeListener, attachShadow, getAttribute, getAttributeNames, getClassList, getComponent, getProperty, getPropertyNames, getShadowRoot, getStyle, getTag, getTextContent, hasAttribute, hasProperty, isTextNode, isVisible, removeAttribute, removeProperty, setAttribute, setAttribute, setComponent, setProperty, setTextContent, setVisible, visit

- Constructor Detail
  - AbstractNodeStateProvider
```
public AbstractNodeStateProvider()
```
- Method Detail
  - supports
```
public boolean supports(StateNode node)
```
    Description copied from interface: ElementStateProvider
    
    Checks if the element state provider supports the given state node.
    
    Specified by:
    
    supports in interface ElementStateProvider
    
    Parameters:
    
    node - the state node to check
    
    Returns:
    
    true if the element state provider is compatible with the given state node, false otherwise
  - getProviderFeatures
```
protected abstract Class<? extends NodeFeature>[] getProviderFeatures()
```
    Returns the features supported by the provider.
    
    Returns:
    
    features supported by the provider
  - getParent
```
public Node getParent(StateNode node)
```
    Description copied from interface: ElementStateProvider
    
    Gets the parent element.
    
    Specified by:
    
    getParent in interface ElementStateProvider
    
    Parameters:
    
    node - the node containing the data
    
    Returns:
    
    the parent element or null if the element has no parent
  - getChildCount
```
public int getChildCount(StateNode node)
```
    Description copied from interface: ElementStateProvider
    
    Gets the number of child elements.
    
    Specified by:
    
    getChildCount in interface ElementStateProvider
    
    Parameters:
    
    node - the node containing the data
    
    Returns:
    
    the number of child elements
  - getChild
```
public Element getChild(StateNode node,
                        int index)
```
    Description copied from interface: ElementStateProvider
    
    Returns the child element at the given position.
    
    Specified by:
    
    getChild in interface ElementStateProvider
    
    Parameters:
    
    node - the node containing the data
    
    index - the index of the child element to return
    
    Returns:
    
    the child element
  - insertChild
```
public void insertChild(StateNode node,
                        int index,
                        Element child)
```
    Description copied from interface: ElementStateProvider
    
    Inserts the given child at the given position.
    
    Specified by:
    
    insertChild in interface ElementStateProvider
    
    Parameters:
    
    node - the node containing the data
    
    index - the position at which to insert the new child
    
    child - the child element to insert
  - removeChild
```
public void removeChild(StateNode node,
                        int index)
```
    Description copied from interface: ElementStateProvider
    
    Removes the child at the given position.
    
    Specified by:
    
    removeChild in interface ElementStateProvider
    
    Parameters:
    
    node - the node containing the data
    
    index - the position of the child element to remove
  - removeAllChildren
```
public void removeAllChildren(StateNode node)
```
    Description copied from interface: ElementStateProvider
    
    Removes all child elements.
    
    Specified by:
    
    removeAllChildren in interface ElementStateProvider
    
    Parameters:
    
    node - the node containing the data
  - removeChild
```
public void removeChild(StateNode node,
                        Element child)
```
    Description copied from interface: ElementStateProvider
    
    Removes the given child.
    
    Specified by:
    
    removeChild in interface ElementStateProvider
    
    Parameters:
    
    node - the node containing the data
    
    child - the child element to remove
  - attachExistingElement
```
public void attachExistingElement(StateNode node,
                                  String tagName,
                                  Element previousSibling,
                                  ChildElementConsumer callback)
```
    Description copied from interface: ElementStateProvider
    
    Attaches a child element with the given tagName which is the next sibling for the previousSibling.
    The previousSibling parameter value can be null which means that the very first child with the given tagName will be used to attach (if any).
    
    Specified by:
    
    attachExistingElement in interface ElementStateProvider
    
    Parameters:
    
    node - the parent node
    
    tagName - the tag name of the element to attach, not null
    
    previousSibling - previous sibling, may be null
    
    callback - the callback which will be invoked with a server side element instance or an error will be reported, not null
  - appendVirtualChild
```
public void appendVirtualChild(StateNode node,
                               Element child,
                               String type,
                               String payload)
```
    Description copied from interface: ElementStateProvider
    
    Append the given element as a virtual child.
    
    Specified by:
    
    appendVirtualChild in interface ElementStateProvider
    
    Parameters:
    
    node - the node containing the data
    
    child - the child element to add
    
    type - the type of additional payload data
    
    payload - the additional payload data
  - visitDescendants
```
protected void visitDescendants(Node<?> node,
                                NodeVisitor visitor)
```
    Apply the visitor for the descendants of the node.
    
    Parameters:
    
    node - the node whose descendants are targets to apply the visitor
    
    visitor - the visitor to apply
  - getNode
```
protected abstract Node<?> getNode(StateNode node)
```
    Gets the flyweight instance for the node supported by the provider.
    
    Parameters:
    
    node - the node to wrap into flyweight
    
    Returns:
    
    the flyweight instance for the node
    
    See Also:
    
    supports(StateNode)

com.vaadin.flow.dom.impl.

Class AbstractNodeStateProvider

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.vaadin.flow.dom.ElementStateProvider

Constructor Detail

AbstractNodeStateProvider

Method Detail

supports

getProviderFeatures

getParent

getChildCount

getChild

insertChild

removeChild

removeAllChildren

removeChild

attachExistingElement

appendVirtualChild

visitDescendants

getNode