Package io.micronaut.controlpanel.core

Class AbstractControlPanel<B>

java.lang.Object

io.micronaut.controlpanel.core.AbstractControlPanel<B>

Type Parameters:

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

All Implemented Interfaces:

ConfigurableControlPanel, ControlPanel<B>, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, io.micronaut.core.util.Toggleable

Direct Known Subclasses:

BeansControlPanel, EnvironmentControlPanel, HealthControlPanel, LoggersControlPanel, RoutesControlPanel

public abstract class AbstractControlPanel<B>
extends Object
implements ControlPanel<B>

Base class for control panels that can delegate some of its values to a ControlPanelConfiguration.

Since:

1.0.0

Author:

Álvaro Sánchez-Mariscal

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.controlpanel.core.ControlPanel

ControlPanel.Category, ControlPanel.View

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NonNull ControlPanelConfiguration	configuration
protected final @NonNull String	controlPanelName

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractControlPanel(@NonNull String controlPanelName, @NonNull ControlPanelConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
String	getIcon()	Icon CSS class of the card UI element.
@NonNull String	getName()
int	getOrder()
String	getTitle()	The title is displayed in the header of the card UI element.
boolean	isEnabled()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.controlpanel.core.ControlPanel

getBadge, getBody, getBodyView, getCategory, getDetailedView

Field Details

controlPanelName

@NonNull
protected final @NonNull String controlPanelName

configuration

@NonNull
protected final @NonNull ControlPanelConfiguration configuration

Constructor Details

AbstractControlPanel

protected AbstractControlPanel(@NonNull
 @NonNull String controlPanelName,
 @NonNull
 @NonNull ControlPanelConfiguration configuration)

Method Details

getTitle

public String getTitle()

Description copied from interface: ConfigurableControlPanel

The title is displayed in the header of the card UI element.

Specified by:

getTitle in interface ConfigurableControlPanel

Returns:

the title of the control panel.

getOrder

public int getOrder()

Specified by:

getOrder in interface io.micronaut.core.order.Ordered

getIcon

public String getIcon()

Description copied from interface: ConfigurableControlPanel

Icon CSS class of the card UI element.

Specified by:

getIcon in interface ConfigurableControlPanel

Returns:

the icon class of the control panel.

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface ConfigurableControlPanel

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable

Returns:

whether this control panel is enabled or not.

getName

@NonNull
public @NonNull String getName()

Specified by:

getName in interface io.micronaut.core.naming.Named