io.jmix.ui.screen

Class ScreenDependencyUtils

java.lang.Object

io.jmix.ui.screen.ScreenDependencyUtils

@ParametersAreNonnullByDefault
public final class ScreenDependencyUtils
extends java.lang.Object

A class that facilitates adding dependencies such as CSS, JavaScript, HTML to the current page for screens and fragments.

Constructor Summary

Constructors

Constructor and Description
ScreenDependencyUtils()

Method Summary

Modifier and Type	Method and Description
static void	addScreenDependencies(FrameOwner frameOwner, java.lang.String... dependencies) Adds dependency paths to the given frameOwner.
static void	addScreenDependency(FrameOwner frameOwner, java.lang.String path, com.vaadin.ui.Dependency.Type type) Adds a dependency to the given frameOwner.
protected static java.util.Optional<JmixWindowVerticalLayout>	findWindowVerticalLayout(FrameOwner frameOwner)
static java.util.List<com.vaadin.ui.HasDependencies.ClientDependency>	getScreenDependencies(FrameOwner frameOwner) Returns a list of dependencies previously added to the given frame owner.
static void	setScreenDependencies(FrameOwner frameOwner, java.util.List<com.vaadin.ui.HasDependencies.ClientDependency> dependencies) Sets a list of dependencies to the given frameOwner.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScreenDependencyUtils

public ScreenDependencyUtils()

Method Detail

getScreenDependencies

public static java.util.List<com.vaadin.ui.HasDependencies.ClientDependency> getScreenDependencies(FrameOwner frameOwner)

Returns a list of dependencies previously added to the given frame owner.

Parameters:

frameOwner - a frame owner from which the dependency list is obtained

Returns:

a list of dependencies

setScreenDependencies

public static void setScreenDependencies(FrameOwner frameOwner,
                                         java.util.List<com.vaadin.ui.HasDependencies.ClientDependency> dependencies)

Sets a list of dependencies to the given frameOwner. Each dependency represented with a HasDependencies.ClientDependency object which path corresponds to one of the sources:

• WebJar resource - starts with webjar://
• VAADIN directory - starts with vaadin://
• Web resource - starts with http:// or https://

Parameters:

frameOwner - a frame owner to which dependencies are added

dependencies - dependencies to set

addScreenDependencies

public static void addScreenDependencies(FrameOwner frameOwner,
                                         java.lang.String... dependencies)

Adds dependency paths to the given frameOwner. Each path corresponds to one of the sources:

• WebJar resource - starts with webjar://
• VAADIN directory - starts with vaadin://
• Web resource - starts with http:// or https://

Parameters:

frameOwner - a frame owner to which dependencies are added

dependencies - dependencies to add

addScreenDependency

public static void addScreenDependency(FrameOwner frameOwner,
                                       java.lang.String path,
                                       com.vaadin.ui.Dependency.Type type)

Adds a dependency to the given frameOwner. Path corresponds to one of the sources:

• WebJar resource - starts with webjar://
• VAADIN directory - starts with vaadin://
• Web resource - starts with http:// or https://

Parameters:

frameOwner - a frame owner to which a dependency is added

path - a dependency path

type - a dependency type

findWindowVerticalLayout

protected static java.util.Optional<JmixWindowVerticalLayout> findWindowVerticalLayout(FrameOwner frameOwner)