org.xwiki.rendering.transformation.icon

Interface IconTransformationConfiguration

@Role
public interface IconTransformationConfiguration

Configuration properties for the Icon transformation.

Since:

2.6RC1

Version:

$Id: 03b17ab75cff47ace39fb867b529c7360729e161 $

Method Summary

Methods

Modifier and Type	Method and Description
void	addMapping(String iconCharacters, String iconName) Adds a new mapping between a set of characters representing an icon (eg ":)", "(y)") and an icon name (eg "emoticon_smile", "thumbs_up").
Properties	getMappings()

Method Detail

getMappings

Properties getMappings()

Returns:

the mappings between a set of characters representing an icon (eg ":)", "(y)") and an icon name (eg "emoticon_smile", "thumbs_up")

addMapping

void addMapping(String iconCharacters,
              String iconName)

Adds a new mapping between a set of characters representing an icon (eg ":)", "(y)") and an icon name (eg "emoticon_smile", "thumbs_up").

Parameters:

iconCharacters - the set of characters representing the icon

iconName - the icon name based on a well-known list of names