Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
IconRenderer | 31 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.icon; | |
21 | ||
22 | import org.xwiki.component.annotation.Role; | |
23 | ||
24 | /** | |
25 | * Component to render an icon (either with Wiki Syntax or HTML). | |
26 | * | |
27 | * @since 6.2M1 | |
28 | * @version $Id: 86b7d84b7aa78bb285dcc9eba5b02d7f56a3b092 $ | |
29 | */ | |
30 | @Role | |
31 | public interface IconRenderer | |
32 | { | |
33 | /** | |
34 | * Generate the wiki syntax to display an icon. | |
35 | * @param iconName name of the icon to render | |
36 | * @param iconSet icon set that contains the icon to display | |
37 | * @return the wiki syntax that displays the icon or an empty string if the icon does not exist | |
38 | * @throws IconException if problems occur | |
39 | */ | |
40 | String render(String iconName, IconSet iconSet) throws IconException; | |
41 | ||
42 | /** | |
43 | * Generate the HTML code to display an icon. | |
44 | * @param iconName name of the icon to render | |
45 | * @param iconSet icon set that contains the icon to display | |
46 | * @return the HTML code that displays the icon or an empty string if the icon does not exist | |
47 | * @throws IconException if problems occur | |
48 | */ | |
49 | String renderHTML(String iconName, IconSet iconSet) throws IconException; | |
50 | } |