Interface ControlPanel<B>

Type Parameters:

B - the type of the body of the control panel.

All Superinterfaces:

ConfigurableControlPanel, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, io.micronaut.core.util.Toggleable

All Known Implementing Classes:

AbstractCacheControlPanel, AbstractControlPanel, AbstractEachBeanControlPanel, BeansControlPanel, CaffeineCacheControlPanel, DataSourceControlPanel, DisabledBeansControlPanel, EhcacheControlPanel, EnvironmentControlPanel, HazelcastSyncCacheControlPanel, HealthControlPanel, InfinispanSyncCacheControlPanel, KafkaStreamsControlPanel, LoggersControlPanel, ObjectStorageControlPanel, RoutesControlPanel, TestResourcesControlPanel

public interface ControlPanel<B>
extends ConfigurableControlPanel

A control panel is a UI component that displays some information about the application.

Since:

1.0.0

Author:

Álvaro Sánchez-Mariscal

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ControlPanel.Category	Control panels are grouped by category.
static final record	ControlPanel.View	View to be rendered by the control panel.

Field Summary

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
default String	getBadge()	Badge text to be displayed in the header of the card UI element.
B	getBody()	Used to render the body of the control panel.
default ControlPanel.View	getBodyView()	ControlPanel.View that will be used to render the body of the control panel.
default ControlPanel.Category	getCategory()	The category of the control panel.
default ControlPanel.View	getDetailedView()	ControlPanel.View that will be used to render the body of the control panel when it has been selected.
default boolean	hasDetails()	Indicates whether this control panel has additional details that can be displayed.

Methods inherited from interface ConfigurableControlPanel

getIcon, getName, getTitle, isEnabled

Methods inherited from interface io.micronaut.core.order.Ordered

getOrder

Method Details

getBody

B getBody()

Used to render the body of the control panel.

Returns:

the body of the control panel.

getBodyView

default ControlPanel.View getBodyView()

ControlPanel.View that will be used to render the body of the control panel.

Returns:

the view of the control panel.

getDetailedView

default ControlPanel.View getDetailedView()

ControlPanel.View that will be used to render the body of the control panel when it has been selected.

Returns:

the view of the control panel.

getBadge

default String getBadge()

Badge text to be displayed in the header of the card UI element.

Returns:

the badge text of the control panel.

getCategory

default ControlPanel.Category getCategory()

The category of the control panel.

Returns:

the category of the control panel.

hasDetails

default boolean hasDetails()

Indicates whether this control panel has additional details that can be displayed. By default, it is assumed that a control panel has details.

Returns:

true if the control panel has details, false otherwise

Since:

2.0.0