Package io.micronaut.controlpanel.core.config

Class ControlPanelConfiguration

java.lang.Object
io.micronaut.controlpanel.core.config.ControlPanelConfiguration
All Implemented Interfaces:
ConfigurableControlPanel, io.micronaut.core.naming.Named, io.micronaut.core.order.Ordered, io.micronaut.core.util.Toggleable
@EachProperty("micronaut.control-panel.panels") public class ControlPanelConfiguration extends Object implements ConfigurableControlPanel
Per-panel configuration properties.
Since:
1.0.0
Author:
Álvaro Sánchez-Mariscal

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final boolean
    DEFAULT_ENABLED
     
    static final String
    DEFAULT_ICON
     
    static final String
    PREFIX
     

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

    HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

  • Constructor Summary

    Constructors
    Constructor
    Description
    ControlPanelConfiguration(String name)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getIcon()
    Icon class of the card UI element.
    @NonNull String
    getName()
    The unique name of the control panel.
    int
    getOrder()
    Sets the order of this control panel, since they will be displayed sorted by order.
    String
    getTitle()
    The title is displayed in the header of the card UI element.
    boolean
    isEnabled()
    Enables/disables this control panel.
    void
    setEnabled(boolean enabled)
    Sets whether this control panel is enabled or not.
    void
    setIcon(String icon)
    Sets the icon of this control panel.
    void
    setName(String name)
    Sets the unique name of the control panel.
    void
    setOrder(int order)
    Sets the order of this control panel, since they will be displayed sorted by order.
    void
    setTitle(String title)
    Sets the title of this control panel.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • ControlPanelConfiguration

      public ControlPanelConfiguration(@Parameter String name)

  • Method Details

    • isEnabled

      public boolean isEnabled()
      Enables/disables this control panel. Default value: true.
      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.

    • getOrder

      public int getOrder()
      Sets the order of this control panel, since they will be displayed sorted by order.
      Specified by:
      getOrder in interface io.micronaut.core.order.Ordered

    • getTitle

      public String getTitle()
      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.

    • getIcon

      public String getIcon()
      Icon class of the card UI element.
      Specified by:
      getIcon in interface ConfigurableControlPanel
      Returns:
      the icon class of the control panel.

    • getName

      @NonNull public @NonNull String getName()
      The unique name of the control panel. Can be used in URLs.
      Specified by:
      getName in interface io.micronaut.core.naming.Named

    • setName

      public void setName(String name)
      Sets the unique name of the control panel. Can be used in URLs.
      Parameters:
      name - the name of the control panel.

    • setEnabled

      public void setEnabled(boolean enabled)
      Sets whether this control panel is enabled or not.
      Parameters:
      enabled - whether this control panel is enabled or not.

    • setOrder

      public void setOrder(int order)
      Sets the order of this control panel, since they will be displayed sorted by order.
      Parameters:
      order - the order of this control panel.

    • setTitle

      public void setTitle(String title)
      Sets the title of this control panel.
      Parameters:
      title - the title of this control panel.

    • setIcon

      public void setIcon(String icon)
      Sets the icon of this control panel.
      Parameters:
      icon - the icon of this control panel.