com.vaadin.flow.dom.ShadowRoot API 24.7.0.alpha6 | Vaadin

com.vaadin.flow.dom.

java.lang.Object

com.vaadin.flow.dom.Node<ShadowRoot>

com.vaadin.flow.dom.ShadowRoot

All Implemented Interfaces:

public class ShadowRoot extends Node<ShadowRoot>

Represents a shadow dom root of an element.

The root can be created by Element.attachShadow().

Since:

1.0

Author:

Vaadin Ltd

See Also:

Method Summary

Modifier and Type

Method

Description

static ShadowRoot

get(StateNode node)

Gets the shadow root instance mapped to the given state node.

Element

getHost()

Node<?>

getParentNode()

Gets the parent node.

protected ShadowRoot

getSelf()

Gets the narrow typed reference to this object.

ShadowRootStateProvider

getStateProvider()

Gets the state provider for this element.

static boolean

isShadowRoot(StateNode node)

Checks whether the given node is a shadow root node.

Methods inherited from class com.vaadin.flow.dom.Node
accept, appendChild, appendChild, appendVirtualChild, appendVirtualChild, ensureChildHasParent, equals, getChild, getChildCount, getChildren, getNode, hashCode, indexOfChild, insertChild, insertChild, isVirtualChild, removeAllChildren, removeChild, removeChild, removeChild, removeVirtualChild, removeVirtualChild, setChild

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

Method Details
- get
  
  public static ShadowRoot get(StateNode node)
  
  Gets the shadow root instance mapped to the given state node.
  
  Parameters:
  
  node - the state node, not null
  
  Returns:
  
  the shadow root for the node, not null
- isShadowRoot
  
  public static boolean isShadowRoot(StateNode node)
  
  Checks whether the given node is a shadow root node.
  
  Parameters:
  
  node - the state node, not null
  
  Returns:
  
  true if it's a shadow root, not null
- getParentNode
  
  public Node<?> getParentNode()
  
  Description copied from class: Node
  
  Gets the parent node.
  
  Overrides:
  
  getParentNode in class Node<ShadowRoot>
  
  Returns:
  
  the parent node or null if this element does not have a parent
- getHost
  
  public Element getHost()
- getSelf
  
  protected ShadowRoot getSelf()
  
  Description copied from class: Node
  
  Gets the narrow typed reference to this object.
  
  Specified by:
  
  getSelf in class Node<ShadowRoot>
  
  Returns:
  
  this object casted to its type
- getStateProvider
  
  public ShadowRootStateProvider getStateProvider()
  
  Description copied from class: Node
  
  Gets the state provider for this element.
  This method is meant for internal use only.
  
  Overrides:
  
  getStateProvider in class Node<ShadowRoot>
  
  Returns:
  
  the state provider for this element