org.xwiki.rendering.util.IconProvider Maven / Gradle / Ivy
/*
* 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.util;
import org.xwiki.component.annotation.Role;
import org.xwiki.rendering.block.Block;
import org.xwiki.stability.Unstable;
/**
* Component to provide an icon from its name.
*
* @version $Id: 295de17b261fccfae4a517390b634b9570cbdb84 $
* @since 16.7.0
*/
@Role
@Unstable
public interface IconProvider
{
/**
* Provides an inline icon from its name.
* E.g. an ImageBlock, a RawBlock with the HTML of the icon
* @param iconName the name of the icon needed
* @return the block containing the icon
*/
Block get(String iconName);
}