io.jmix.dashboardsui.component.impl

Class DashboardImpl

java.lang.Object

io.jmix.ui.component.CompositeComponent<io.jmix.ui.component.VBoxLayout>

io.jmix.dashboardsui.component.impl.DashboardImpl

All Implemented Interfaces:

Dashboard, io.jmix.ui.component.AttachNotifier, io.jmix.ui.component.Component, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.CompositeWithCaption, io.jmix.ui.component.CompositeWithDescription, io.jmix.ui.component.CompositeWithIcon, io.jmix.ui.component.HasDebugId, io.jmix.ui.component.HasHtmlSanitizer

public class DashboardImpl
extends io.jmix.ui.component.CompositeComponent<io.jmix.ui.component.VBoxLayout>
implements Dashboard

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.ui.component.CompositeComponent

io.jmix.ui.component.CompositeComponent.CreateEvent

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

io.jmix.ui.component.Component.Alignment, io.jmix.ui.component.Component.BelongToFrame, io.jmix.ui.component.Component.Disposable, io.jmix.ui.component.Component.Editable, io.jmix.ui.component.Component.Focusable, io.jmix.ui.component.Component.HasCaption, io.jmix.ui.component.Component.HasDescription, io.jmix.ui.component.Component.HasIcon, io.jmix.ui.component.Component.HasXmlDescriptor, io.jmix.ui.component.Component.Wrapper

Field Summary

Fields

Modifier and Type	Field and Description
protected AccessConstraintsHelper	accessHelper
protected java.lang.String	assistantBeanName
protected io.jmix.ui.component.VBoxLayout	canvasBox
protected CanvasFragment	canvasFragment
protected java.lang.String	code
protected io.jmix.ui.UiComponents	componentsFactory
protected DashboardModel	dashboardModel
protected DashboardViewAssistant	dashboardViewAssistant
protected io.jmix.core.DataManager	dataManager
protected io.jmix.ui.Facets	facets
protected io.jmix.ui.Fragments	fragments
protected JsonConverter	jsonConverter
protected java.lang.String	jsonPath
protected io.jmix.core.Messages	messages
protected io.jmix.core.Metadata	metadata
protected io.jmix.ui.Notifications	notifications
protected ParameterTransformer	parameterTransformer
protected org.springframework.core.io.ResourceLoader	resourceLoader
protected java.lang.Integer	timerDelay
protected io.jmix.ui.UiEventPublisher	uiEventPublisher
protected java.util.List<Parameter>	xmlParameters

Fields inherited from class io.jmix.ui.component.CompositeComponent

applicationContext, frame, id, prefixId, root

Fields inherited from interface io.jmix.dashboardsui.component.Dashboard

NAME

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

AUTO_SIZE, AUTO_SIZE_PX, FULL_SIZE

Constructor Summary

Constructors

Constructor and Description
DashboardImpl()

Method Summary

Modifier and Type	Method and Description
protected void	addXmlParameters(DashboardModel dashboardModel)
void	dashboardEventListener(DashboardEvent dashboardEvent)
protected io.jmix.ui.component.Window	findWindow(io.jmix.ui.component.Component frame)
java.lang.String	getAssistantBeanName() Returns assistant bean name
DashboardModel	getDashboardModel()
protected java.util.List<Parameter>	getDuplicatesParams(DashboardModel dashboardModel)
int	getTimerDelay() Returns delay for timer
io.jmix.ui.screen.ScreenFragment	getWidget(java.lang.String widgetId) Returns widget by passed id.
void	init(java.util.Map<java.lang.String,java.lang.Object> params) Initialize dashboard with passed parameters, timer and assistant.
protected DashboardModel	loadDashboardByCode(java.lang.String code)
protected DashboardModel	loadDashboardByJson(java.lang.String jsonPath)
void	refresh() Refreshes dashboard.
void	refresh(java.util.Map<java.lang.String,java.lang.Object> params) Refreshes widget with passed parameters.
protected void	refreshWidgets(DashboardEvent dashboardEvent)
protected io.jmix.ui.screen.ScreenFragment	searchWidgetFragment(io.jmix.ui.component.Component layout, java.lang.String widgetId)
void	setAssistantBeanName(java.lang.String assistantBeanName) Set assistant bean name
void	setCode(java.lang.String code) Dashboard can be configured by setting code of existing dashboard To apply new changes the Dashboard.init(Map) method required to be invoked
void	setJsonPath(java.lang.String jsonPath) Dashboard can be configured from json file
void	setTimerDelay(int delay) Set delay for dashboard timer
void	setXmlParameters(java.util.List<Parameter> parameters) Sets passed parameters to dashboard component
protected void	updateCanvasFragment(DashboardModel dashboardModel)
protected void	updateDashboard(DashboardModel dashboardModel)

Methods inherited from class io.jmix.ui.component.CompositeComponent

addAttachListener, addCreateListener, addDetachListener, addStyleName, assignDebugId, attached, detached, disableEventListeners, enableEventListeners, getAlignment, getComposition, getCompositionOrNull, getDebugId, getEventHub, getFrame, getFullId, getHeight, getHeightSizeUnit, getId, getInnerComponent, getInnerComponentOptional, getParent, getPrefixId, getStyleName, getUiEventListeners, getWidth, getWidthSizeUnit, hasSubscriptions, isAttached, isEnabled, isEnabledRecursive, isHtmlSanitizerEnabled, isResponsive, isVisible, isVisibleRecursive, publish, removeStyleName, setAlignment, setApplicationContext, setComposition, setDebugId, setEnabled, setFrame, setHeight, setHtmlSanitizerEnabled, setId, setParent, setResponsive, setStyleName, setUiEventListeners, setVisible, setWidth, unsubscribe, unwrap, unwrapComposition, unwrapCompositionOrNull, unwrapOrNull, updateComponentIds, updateIdIfNeeded, withUnwrapped, withUnwrappedComposition

Methods inherited from class java.lang.Object

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

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.CompositeWithIcon

getIcon, setIcon, setIconFromSet

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

getCaption, setCaption

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

getDescription, setDescription

Field Detail

canvasBox

protected io.jmix.ui.component.VBoxLayout canvasBox

dataManager

@Autowired
protected io.jmix.core.DataManager dataManager

jsonConverter

@Autowired
protected JsonConverter jsonConverter

resourceLoader

@Autowired
protected org.springframework.core.io.ResourceLoader resourceLoader

metadata

@Autowired
protected io.jmix.core.Metadata metadata

accessHelper

@Autowired
protected AccessConstraintsHelper accessHelper

componentsFactory

@Autowired
protected io.jmix.ui.UiComponents componentsFactory

facets

@Autowired
protected io.jmix.ui.Facets facets

notifications

@Autowired
protected io.jmix.ui.Notifications notifications

fragments

@Autowired
protected io.jmix.ui.Fragments fragments

parameterTransformer

@Autowired
protected ParameterTransformer parameterTransformer

dashboardViewAssistant

protected DashboardViewAssistant dashboardViewAssistant

uiEventPublisher

@Autowired
protected io.jmix.ui.UiEventPublisher uiEventPublisher

canvasFragment

protected CanvasFragment canvasFragment

messages

@Autowired
protected io.jmix.core.Messages messages

code

protected java.lang.String code

jsonPath

protected java.lang.String jsonPath

timerDelay

protected java.lang.Integer timerDelay

xmlParameters

protected java.util.List<Parameter> xmlParameters

assistantBeanName

protected java.lang.String assistantBeanName

dashboardModel

protected DashboardModel dashboardModel

Constructor Detail

DashboardImpl

public DashboardImpl()

Method Detail

init

public void init(java.util.Map<java.lang.String,java.lang.Object> params)

Description copied from interface: Dashboard

Initialize dashboard with passed parameters, timer and assistant.

Specified by:

init in interface Dashboard

Parameters:

params - map of dashboard params

refresh

public void refresh()

Description copied from interface: Dashboard

Refreshes dashboard. Dashboard will be refreshed . If existed parameter has the same name as one of the param from passed map, it will be overwritten by param from map.

Specified by:

refresh in interface Dashboard

refresh

public void refresh(java.util.Map<java.lang.String,java.lang.Object> params)

Refreshes widget with passed parameters. Dashboard will be refreshed with merged existed and new parameters. If existed parameter has the same name as one of the param from passed map, it will be overwritten by param from map.

Specified by:

refresh in interface Dashboard

Parameters:

params - map with new dashboard parameters

dashboardEventListener

@EventListener
public void dashboardEventListener(DashboardEvent dashboardEvent)
                                           throws java.lang.reflect.InvocationTargetException,
                                                  java.lang.IllegalAccessException

Throws:

java.lang.reflect.InvocationTargetException

java.lang.IllegalAccessException

updateDashboard

protected void updateDashboard(@Nullable
                               DashboardModel dashboardModel)

loadDashboardByJson

protected DashboardModel loadDashboardByJson(java.lang.String jsonPath)

loadDashboardByCode

@Nullable
protected DashboardModel loadDashboardByCode(java.lang.String code)

addXmlParameters

protected void addXmlParameters(DashboardModel dashboardModel)

getDuplicatesParams

protected java.util.List<Parameter> getDuplicatesParams(DashboardModel dashboardModel)

updateCanvasFragment

protected void updateCanvasFragment(DashboardModel dashboardModel)

refreshWidgets

protected void refreshWidgets(DashboardEvent dashboardEvent)

findWindow

@Nullable
protected io.jmix.ui.component.Window findWindow(io.jmix.ui.component.Component frame)

getWidget

public io.jmix.ui.screen.ScreenFragment getWidget(java.lang.String widgetId)

Description copied from interface: Dashboard

Returns widget by passed id.

Specified by:

getWidget in interface Dashboard

Parameters:

widgetId - widget identifier

Returns:

widget fragment

searchWidgetFragment

@Nullable
protected io.jmix.ui.screen.ScreenFragment searchWidgetFragment(io.jmix.ui.component.Component layout,
                                                                          java.lang.String widgetId)

setCode

public void setCode(java.lang.String code)

Description copied from interface: Dashboard

Dashboard can be configured by setting code of existing dashboard To apply new changes the Dashboard.init(Map) method required to be invoked

Specified by:

setCode in interface Dashboard

Parameters:

code - another dashboard code

setJsonPath

public void setJsonPath(java.lang.String jsonPath)

Description copied from interface: Dashboard

Dashboard can be configured from json file

Specified by:

setJsonPath in interface Dashboard

Parameters:

jsonPath - path to json configuration file

setXmlParameters

public void setXmlParameters(java.util.List<Parameter> parameters)

Description copied from interface: Dashboard

Sets passed parameters to dashboard component

Specified by:

setXmlParameters in interface Dashboard

Parameters:

parameters - list of parameters to be set

setTimerDelay

public void setTimerDelay(int delay)

Description copied from interface: Dashboard

Set delay for dashboard timer

Specified by:

setTimerDelay in interface Dashboard

Parameters:

delay - delay time in seconds

getTimerDelay

public int getTimerDelay()

Description copied from interface: Dashboard

Returns delay for timer

Specified by:

getTimerDelay in interface Dashboard

Returns:

delay time in seconds

getDashboardModel

public DashboardModel getDashboardModel()

Specified by:

getDashboardModel in interface Dashboard

Returns:

dashboard entity

getAssistantBeanName

public java.lang.String getAssistantBeanName()

Description copied from interface: Dashboard

Returns assistant bean name

Specified by:

getAssistantBeanName in interface Dashboard

Returns:

name of assistant bean

setAssistantBeanName

public void setAssistantBeanName(java.lang.String assistantBeanName)

Description copied from interface: Dashboard

Set assistant bean name

Specified by:

setAssistantBeanName in interface Dashboard

Parameters:

assistantBeanName - name of the assistant bean