com.vaadin.server

Interface FontIcon

All Superinterfaces:

Resource, Serializable

All Known Implementing Classes:

FontAwesome, GenericFontIcon

public interface FontIcon
extends Resource

A font icon is a type of icon that is made by displaying one character from a specially constructed font containing icons ("icon font").

FontIcon is a custom resource type which uses the URI scheme fonticon://<fontfamily>/<codepoint> to reference a specific icon from a specific icon font.

Since:

7.2

Author:

Vaadin Ltd

Method Summary

Modifier and Type	Method and Description
int	getCodepoint() Returns the unicode codepoint (character location) for this icon within the font given in getFontFamily().
String	getFontFamily() Returns the name (font family) of the font from which this icon comes.
String	getHtml() Returns HTML that can be used to display the icon in places where HTML can be used, such as a Label with ContentMode.HTML.

Methods inherited from interface com.vaadin.server.Resource

getMIMEType

Method Detail

getFontFamily

String getFontFamily()

Returns the name (font family) of the font from which this icon comes. The name is used to apply the correct font where the icon is used.

Returns:

Since:

7.2

getCodepoint

int getCodepoint()

Returns the unicode codepoint (character location) for this icon within the font given in getFontFamily().

For example, 0x0021 would in a regular font be the codepoint for the exclamation-point character.
When constructing icon fonts, it might be a good idea to use the codepoints in the "Private use area", from 0xE000 0xF8FF.

Returns:

Since:

7.2

getHtml

String getHtml()

Returns HTML that can be used to display the icon in places where HTML can be used, such as a Label with ContentMode.HTML.

Returns:

HTML needed to display icon

Since:

7.2