io.jmix.ui.component

Interface JavaScriptComponent

All Superinterfaces:

Component, Component.BelongToFrame, Component.HasCaption, Component.HasDescription, Component.HasIcon, HasContextHelp, HasRequiredIndicator

All Known Implementing Classes:

JavaScriptComponentImpl

@StudioComponent(caption="JavaScriptComponent",
                 category="Containers",
                 xmlElement="jsComponent",
                 icon="io/jmix/ui/icon/container/jsComponent.svg",
                 canvasBehaviour=BOX,
                 documentationURL="https://docs.jmix.io/jmix/%VERSION%/backoffice-ui/vcl/components/js-component.html")
public interface JavaScriptComponent
extends Component, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.BelongToFrame, HasContextHelp, HasRequiredIndicator

A JavaScript wrapper.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JavaScriptComponent.ClientDependency
static class	JavaScriptComponent.DependencyType The type of dependency.
static class	JavaScriptComponent.JavaScriptCallbackEvent An event that is fired when a method is called by a client-side JavaScript function.

Nested classes/interfaces inherited from interface io.jmix.ui.component.Component

Component.Alignment, Component.BelongToFrame, Component.Disposable, Component.Editable, Component.Focusable, Component.HasCaption, Component.HasDescription, Component.HasIcon, Component.HasXmlDescriptor, Component.Wrapper

Nested classes/interfaces inherited from interface io.jmix.ui.component.HasContextHelp

HasContextHelp.ContextHelpIconClickEvent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Fields inherited from interface io.jmix.ui.component.Component

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Method Summary

Modifier and Type	Method and Description
void	addDependencies(java.lang.String... dependencies) Adds dependency paths.
void	addDependency(java.lang.String path, JavaScriptComponent.DependencyType type) Adds a dependency.
void	addFunction(java.lang.String name, java.util.function.Consumer<JavaScriptComponent.JavaScriptCallbackEvent> function) Register a Consumer that can be called from the JavaScript using the provided name.
void	callFunction(java.lang.String name, java.lang.Object... arguments) Invoke a named function that the connector JavaScript has added to the JavaScript connector wrapper object.
java.util.List<JavaScriptComponent.ClientDependency>	getDependencies()
java.lang.String	getInitFunctionName()
java.lang.Object	getState()
void	repaint() Repaint UI representation of the component.
void	setDependencies(java.util.List<JavaScriptComponent.ClientDependency> dependencies) Sets a list of dependencies.
void	setInitFunctionName(java.lang.String initFunctionName) Sets an initialization function name that will be used to find an entry point for the JS component connector.
void	setState(java.lang.Object state) Sets a state object that can be used in the client-side JS connector and accessible from the data field of the component's state.

Methods inherited from interface io.jmix.ui.component.Component.HasCaption

getCaption, setCaption

Methods inherited from interface io.jmix.ui.component.Component.HasDescription

getDescription, setDescription

Methods inherited from interface io.jmix.ui.component.Component.HasIcon

getIcon, setIcon, setIconFromSet

Methods inherited from interface io.jmix.ui.component.Component.BelongToFrame

getFrame, setFrame

Methods inherited from interface io.jmix.ui.component.Component

addStyleName, getAlignment, getHeight, getHeightSizeUnit, getId, getParent, getStyleName, getWidth, getWidthSizeUnit, isEnabled, isEnabledRecursive, isResponsive, isVisible, isVisibleRecursive, removeStyleName, setAlignment, setEnabled, setHeight, setHeightAuto, setHeightFull, setId, setParent, setResponsive, setSizeAuto, setSizeFull, setStyleName, setVisible, setWidth, setWidthAuto, setWidthFull, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, withUnwrapped, withUnwrappedComposition

Methods inherited from interface io.jmix.ui.component.HasContextHelp

getContextHelpIconClickHandler, getContextHelpText, isContextHelpTextHtmlEnabled, setContextHelpIconClickHandler, setContextHelpText, setContextHelpTextHtmlEnabled

Methods inherited from interface io.jmix.ui.component.HasRequiredIndicator

isRequiredIndicatorVisible, setRequiredIndicatorVisible

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getDependencies

java.util.List<JavaScriptComponent.ClientDependency> getDependencies()

Returns:

a list of dependencies

setDependencies

void setDependencies(java.util.List<JavaScriptComponent.ClientDependency> dependencies)

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

• WebJar resource - starts with webjar://
• VAADIN directory - starts with vaadin://

Parameters:

dependencies - dependencies to set

addDependency

void addDependency(java.lang.String path,
                   JavaScriptComponent.DependencyType type)

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

• WebJar resource - starts with webjar://
• VAADIN directory - starts with vaadin://

Parameters:

path - a dependency path

type - a dependency type

addDependencies

void addDependencies(java.lang.String... dependencies)

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

• WebJar resource - starts with webjar://
• VAADIN directory - starts with vaadin://

Parameters:

dependencies - dependencies to add

getInitFunctionName

java.lang.String getInitFunctionName()

Returns:

an initialization function name that will be used to find an entry point for the JS component connector

setInitFunctionName

@StudioProperty
void setInitFunctionName(java.lang.String initFunctionName)

Sets an initialization function name that will be used to find an entry point for the JS component connector.

CAUTION: the initialization function name must be unique within window.

Parameters:

initFunctionName - an initialization function name

getState

java.lang.Object getState()

Returns:

Returns a state object

setState

void setState(java.lang.Object state)

Sets a state object that can be used in the client-side JS connector and accessible from the data field of the component's state.

Here an example of accessing the state object:

 connector.onStateChange = function () {
    var state = connector.getState();
    let data = state.data;
    ...
 }
 

The state object should be a POJO.

CAUTION: Date fields serialized as strings with DateJsonSerializer.DATE_FORMAT format.

Parameters:

state - a state object to set

addFunction

void addFunction(java.lang.String name,
                 java.util.function.Consumer<JavaScriptComponent.JavaScriptCallbackEvent> function)

Register a Consumer that can be called from the JavaScript using the provided name. A JavaScript function with the provided name will be added to the connector wrapper object (initially available as this). Calling that JavaScript function will cause the call method in the registered Consumer to be invoked with the same arguments passed to the JavaScriptComponent.JavaScriptCallbackEvent.

Parameters:

name - the name that should be used for client-side function

function - the Consumer object that will be invoked when the JavaScript function is called

callFunction

void callFunction(java.lang.String name,
                  java.lang.Object... arguments)

Invoke a named function that the connector JavaScript has added to the JavaScript connector wrapper object. The arguments can be any boxed primitive type, String, JsonValue or arrays of any other supported type. Complex types (e.g. List, Set, Map, Connector or any JavaBean type) must be explicitly serialized to a JsonValue before sending.

Parameters:

name - the name of the function

arguments - function arguments

repaint

void repaint()

Repaint UI representation of the component.