Package org.ametys.cms.color

Class AbstractColorsComponent

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.cms.color.AbstractColorsComponent

All Implemented Interfaces:

LogEnabled, Component, Configurable

Direct Known Subclasses:

AbstractSkinColorsComponent, CategoryColorsComponent, SiteColorsComponent, TagColorsComponent

public abstract class AbstractColorsComponent
extends AbstractLogEnabled
implements Component, Configurable

Component listing the available colors

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	AbstractColorsComponent.ColorsDefinition	Class representing a colors definition

Constructor Summary

Constructors

Constructor	Description
AbstractColorsComponent()

Method Summary

Modifier and Type	Method	Description
void	configure(Configuration configuration)
String	getColorCSSClassPrefix()	Get the color class
Map<String,Map<String,String>>	getColors()	Get the colors by index A 'color' is an association key-hexacolor.
String	getDefaultKey()	Get the key to use as default in the colors
AbstractColorsComponent.ColorsDefinition	parseColors(Configuration configuration)	Parse colors from configuration

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractColorsComponent

public AbstractColorsComponent()

Method Details

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

getDefaultKey

public String getDefaultKey()

Get the key to use as default in the colors

Returns:

A non null key.

getColors

public Map<String,Map<String,String>> getColors()

Get the colors by index A 'color' is an association key-hexacolor. Where key can be 'main', 'text'...

Returns:

The map

getColorCSSClassPrefix

public String getColorCSSClassPrefix()

Get the color class

Returns:

the color class

parseColors

public AbstractColorsComponent.ColorsDefinition parseColors(Configuration configuration)
                                                     throws ConfigurationException

Parse colors from configuration

Parameters:

configuration - the configuration

Returns:

the colors configuration

Throws:

ConfigurationException - if a configuration error occurred