001/*
002 *  Copyright 2022 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.cms.tag;
017
018import org.ametys.cms.color.AbstractColorsComponent;
019
020/**
021 * Interface for colorable Tag
022 */
023public interface ColorableTag extends Tag
024{
025    /**
026     * Get the color index in the component palete
027     * @param withDefaultValue <code>true</code> if we want to get first the color of the parent then the default value
028     * @return the color. Can be null if withDefaultValue is <code>false</code>
029     */
030    public String getColor(boolean withDefaultValue);
031    
032    
033    /**
034     * Get the color component
035     * @return the color component
036     */
037    public AbstractColorsComponent getColorComponent();
038    
039    /**
040     * Get the color css class
041     * @return the color css class
042     */
043    public default String getColorCSSClassPrefix()
044    {
045        return getColorComponent().getColorCSSClassPrefix();
046    }
047    
048}