Package com.vaadin.flow.shared.ui

Class Dependency

java.lang.Object
com.vaadin.flow.shared.ui.Dependency
All Implemented Interfaces:
Serializable
public class Dependency extends Object implements Serializable
Represents an html import, stylesheet or JavaScript to include on the page.
Since:
1.0
Author:
Vaadin Ltd
See Also:

  • Field Details

  • Constructor Details

    • Dependency

      public Dependency(Dependency.Type type, String url, LoadMode loadMode)
      Creates a new dependency of the given type, to be loaded from the given URL.

      The URL is passed through the translation mechanism before loading, so custom protocols, specified at VaadinUriResolver can be used.

      Parameters:
      type - the type of the dependency, not null
      url - the URL to load the dependency from, not null
      loadMode - determines dependency load mode, refer to LoadMode for details

    • Dependency

      public Dependency(Dependency.Type type, String url, LoadMode loadMode, String id)
      Creates a new dependency of the given type, to be loaded from the given URL with an optional ID for tracking.

      The URL is passed through the translation mechanism before loading, so custom protocols, specified at VaadinUriResolver can be used.

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

      Parameters:
      type - the type of the dependency, not null
      url - the URL to load the dependency from, not null
      loadMode - determines dependency load mode, refer to LoadMode for details
      id - optional ID for tracking the dependency
      Since:
      25.0

    • Dependency

      public Dependency(Dependency.Type type, String url, LoadMode loadMode, String id, String layer)
      Creates a new dependency of the given type, to be loaded from the given URL into the given CSS cascade layer, with an optional ID for tracking.

      The URL is passed through the translation mechanism before loading, so custom protocols, specified at VaadinUriResolver can be used.

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

      Parameters:
      type - the type of the dependency, not null
      url - the URL to load the dependency from, not null
      loadMode - determines dependency load mode, refer to LoadMode for details
      id - optional ID for tracking the dependency
      layer - the CSS cascade layer to load a style sheet into, or null to not use a layer
      Throws:
      IllegalArgumentException - if a layer is given for a dependency that is not a Dependency.Type.STYLESHEET

    • Dependency

      public Dependency(Dependency.Type type, String expression)
      Creates a new dependency of the given type, to be loaded using JS expression which is supposed to return a Promise.

      The created instance dependency mode is LoadMode.LAZY.

      Parameters:
      type - the type of the dependency, not null
      expression - the JS expression to load the dependency, not null
      Since:
      2.1

  • Method Details

    • getUrl

      public String getUrl()
      Gets the untranslated URL for the dependency.
      Returns:
      the URL for the dependency

    • getType

      public Dependency.Type getType()
      Gets the type of the dependency.
      Returns:
      the type of the dependency

    • getLoadMode

      public LoadMode getLoadMode()
      Gets load mode that will be used for dependency loading. Refer to LoadMode for details.
      Returns:
      the load mode that will be used during dependency loading

    • getId

      public String getId()
      Gets the ID associated with this dependency.

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

      Returns:
      the dependency ID or null if not set
      Since:
      25.0

    • getLayer

      public String getLayer()
      Gets the CSS cascade layer the style sheet is loaded into.

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

      Returns:
      the layer name or null if the dependency does not use a layer

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object