io.jmix.dashboardsui.dashboard.tools.factory.impl

Class CanvasDropComponentsFactory

java.lang.Object

io.jmix.dashboardsui.dashboard.tools.factory.impl.CanvasUiComponentsFactory

io.jmix.dashboardsui.dashboard.tools.factory.impl.CanvasDropComponentsFactory

All Implemented Interfaces:

CanvasComponentsFactory

@Component(value="dshbrd_CanvasDropComponentsFactory")
public class CanvasDropComponentsFactory
extends CanvasUiComponentsFactory

Creates a layout to use in the dashboard editor.
Additional fields are set for the layout:

• Description;
• Actions;
• Click listener (only for CanvasRootLayout.

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionsProvider	actionsProvider
protected io.jmix.ui.UiComponents	factory
protected io.jmix.core.Metadata	metadata
protected io.jmix.ui.UiEventPublisher	uiEventPublisher

Fields inherited from class io.jmix.dashboardsui.dashboard.tools.factory.impl.CanvasUiComponentsFactory

components, DASHBOARD, DASHBOARD_MODEL, messages, WIDGET, widgetRepository

Constructor Summary

Constructors

Constructor and Description
CanvasDropComponentsFactory()

Method Summary

Modifier and Type	Method and Description
protected void	addLayoutClickListener(CanvasLayout layout)
protected io.jmix.ui.component.Button	createButton(io.jmix.ui.action.Action action)
CanvasGridLayout	createCanvasGridLayout(GridLayout gridLayout) Creates a CanvasGridLayout component with specified GridLayout model.
CanvasHorizontalLayout	createCanvasHorizontalLayout(HorizontalLayout horizontalLayout) Creates a CanvasHorizontalLayout component with specified HorizontalLayout model.
CanvasResponsiveLayout	createCanvasResponsiveLayout(ResponsiveLayout responsiveLayout) Creates a CanvasResponsiveLayout with specified ResponsiveLayout model.
CanvasRootLayout	createCanvasRootLayout(RootLayout rootLayout) Creates a CanvasRootLayout with specified RootLayout model.
CanvasVerticalLayout	createCanvasVerticalLayout(VerticalLayout verticalLayout) Creates a CanvasVerticalLayout component with specified VerticalLayout model.
CanvasWidgetLayout	createCanvasWidgetLayout(CanvasFragment canvasFragment, WidgetLayout widgetLayout) Creates a CanvasWidgetLayout with specified WidgetLayout model.
protected io.jmix.ui.component.Button	createCaptionButton(DashboardLayout layout)
CanvasCssLayout	createCssLayout(CssLayout cssLayoutModel) Creates a CanvasCssLayout component with specified CssLayout model.
protected CanvasLayout	findCanvasLayout(io.jmix.ui.component.Component component)

Methods inherited from class java.lang.Object

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

Field Detail

factory

@Autowired
protected io.jmix.ui.UiComponents factory

uiEventPublisher

@Autowired
protected io.jmix.ui.UiEventPublisher uiEventPublisher

metadata

@Autowired
protected io.jmix.core.Metadata metadata

actionsProvider

@Autowired
protected ActionsProvider actionsProvider

Constructor Detail

CanvasDropComponentsFactory

public CanvasDropComponentsFactory()

Method Detail

createCanvasVerticalLayout

public CanvasVerticalLayout createCanvasVerticalLayout(VerticalLayout verticalLayout)

Description copied from interface: CanvasComponentsFactory

Creates a CanvasVerticalLayout component with specified VerticalLayout model.

Specified by:

createCanvasVerticalLayout in interface CanvasComponentsFactory

Overrides:

createCanvasVerticalLayout in class CanvasUiComponentsFactory

Parameters:

verticalLayout - vertical layout model

Returns:

created layout

createButton

protected io.jmix.ui.component.Button createButton(io.jmix.ui.action.Action action)

createCanvasHorizontalLayout

public CanvasHorizontalLayout createCanvasHorizontalLayout(HorizontalLayout horizontalLayout)

Description copied from interface: CanvasComponentsFactory

Creates a CanvasHorizontalLayout component with specified HorizontalLayout model.

Specified by:

createCanvasHorizontalLayout in interface CanvasComponentsFactory

Overrides:

createCanvasHorizontalLayout in class CanvasUiComponentsFactory

Parameters:

horizontalLayout - horizontal layout model

Returns:

created layout

createCssLayout

public CanvasCssLayout createCssLayout(CssLayout cssLayoutModel)

Description copied from interface: CanvasComponentsFactory

Creates a CanvasCssLayout component with specified CssLayout model.

Specified by:

createCssLayout in interface CanvasComponentsFactory

Overrides:

createCssLayout in class CanvasUiComponentsFactory

Parameters:

cssLayoutModel - CSS layout model

Returns:

created layout

createCanvasGridLayout

public CanvasGridLayout createCanvasGridLayout(GridLayout gridLayout)

Description copied from interface: CanvasComponentsFactory

Creates a CanvasGridLayout component with specified GridLayout model.

Specified by:

createCanvasGridLayout in interface CanvasComponentsFactory

Overrides:

createCanvasGridLayout in class CanvasUiComponentsFactory

Parameters:

gridLayout - grid layout model

Returns:

created layout

createCanvasWidgetLayout

public CanvasWidgetLayout createCanvasWidgetLayout(CanvasFragment canvasFragment,
                                                   WidgetLayout widgetLayout)

Description copied from interface: CanvasComponentsFactory

Creates a CanvasWidgetLayout with specified WidgetLayout model.

Specified by:

createCanvasWidgetLayout in interface CanvasComponentsFactory

Overrides:

createCanvasWidgetLayout in class CanvasUiComponentsFactory

Parameters:

canvasFragment - canvas to add a widget fragment

widgetLayout - widget layout model

Returns:

created layout

createCanvasRootLayout

public CanvasRootLayout createCanvasRootLayout(RootLayout rootLayout)

Description copied from interface: CanvasComponentsFactory

Creates a CanvasRootLayout with specified RootLayout model.

Specified by:

createCanvasRootLayout in interface CanvasComponentsFactory

Overrides:

createCanvasRootLayout in class CanvasUiComponentsFactory

Parameters:

rootLayout - root layout model

Returns:

created layout

createCaptionButton

protected io.jmix.ui.component.Button createCaptionButton(DashboardLayout layout)

addLayoutClickListener

protected void addLayoutClickListener(CanvasLayout layout)

findCanvasLayout

@Nullable
protected CanvasLayout findCanvasLayout(io.jmix.ui.component.Component component)

createCanvasResponsiveLayout

public CanvasResponsiveLayout createCanvasResponsiveLayout(ResponsiveLayout responsiveLayout)

Description copied from interface: CanvasComponentsFactory

Creates a CanvasResponsiveLayout with specified ResponsiveLayout model.

Specified by:

createCanvasResponsiveLayout in interface CanvasComponentsFactory

Overrides:

createCanvasResponsiveLayout in class CanvasUiComponentsFactory

Parameters:

responsiveLayout - responsive layout model

Returns:

created layout