org.xwiki.rendering.internal.macro.message.MacroIconPrettyNameProvider Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-rendering-macro-message Show documentation

Displays information, warning, error and success messages in a styled box format, using different icons

The newest version!

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.rendering.internal.macro.message;

import org.apache.commons.lang3.StringUtils;
import org.xwiki.component.annotation.Component;

import javax.inject.Singleton;

/**
 * Default component to provide an alternative text for an icon.
 *
 * @version $Id: 3c3229e1e129701a0752d545a4a4a99cc9ff079e $
 * @since 16.7.0
 */
@Singleton
@Component(roles = MacroIconPrettyNameProvider.class)
public class MacroIconPrettyNameProvider
{
    /**
     * @param macroId the id of the macro whose icon needs an alternative text
     * @return the alternative text associated to the provided icon
     */
    String getIconPrettyName(String macroId) 
    {
        return StringUtils.capitalize(macroId);
    }
}