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

Class CanvasUiComponentsFactory

java.lang.Object

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

All Implemented Interfaces:

CanvasComponentsFactory

Direct Known Subclasses:

CanvasDropComponentsFactory

@Component("dshbrd_CanvasUiComponentsFactory")
public class CanvasUiComponentsFactory
extends Object
implements CanvasComponentsFactory

Creates a non-editable CanvasLayout to be added to the Dashboard component.

Field Summary

Fields

Modifier and Type	Field	Description
protected UiComponents	components
static final String	DASHBOARD
static final String	DASHBOARD_MODEL
protected Messages	messages
static final String	WIDGET
protected WidgetRepository	widgetRepository

Constructor Summary

Constructors

Constructor	Description
CanvasUiComponentsFactory()

Method Summary

Modifier and Type	Method	Description
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.
CanvasCssLayout	createCssLayout(CssLayout cssLayoutModel)	Creates a CanvasCssLayout component with specified CssLayout model.

Methods inherited from class java.lang.Object

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

Field Details

WIDGET

public static final String WIDGET

See Also:

• Constant Field Values

DASHBOARD_MODEL

public static final String DASHBOARD_MODEL

See Also:

• Constant Field Values

DASHBOARD

public static final String DASHBOARD

See Also:

• Constant Field Values

widgetRepository

@Autowired
protected WidgetRepository widgetRepository

components

@Autowired
protected UiComponents components

messages

@Autowired
protected Messages messages

Constructor Details

CanvasUiComponentsFactory

public CanvasUiComponentsFactory()

Method Details

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

Parameters:

verticalLayout - vertical layout model

Returns:

created layout

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

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

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

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

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

Parameters:

rootLayout - root layout model

Returns:

created layout

createCanvasResponsiveLayout

public CanvasResponsiveLayout createCanvasResponsiveLayout(ResponsiveLayout responsiveLayout)

Description copied from interface: CanvasComponentsFactory

Creates a CanvasResponsiveLayout with specified ResponsiveLayout model.

Specified by:

createCanvasResponsiveLayout in interface CanvasComponentsFactory

Parameters:

responsiveLayout - responsive layout model

Returns:

created layout