Package io.jenkins.plugins.fontawesome

Class SvgTag

java.lang.Object

io.jenkins.plugins.fontawesome.SvgTag

public class SvgTag
extends Object

Textual SVG tag representation that shows a FontAwesome icon.

Author:

Ullrich Hafner

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SvgTag.FontAwesomeStyle	Available Font Awesome styles.

Constructor Summary

Constructors

Constructor	Description
SvgTag(String iconName)	Creates a new SvgTag that renders the specified SVG icon of FontAwesome using SvgTag.FontAwesomeStyle.SOLID.
SvgTag(String iconName, SvgTag.FontAwesomeStyle style)	Creates a new SvgTag that renders the specified SVG icon of FontAwesome.

Method Summary

Modifier and Type	Method	Description
static SvgTag	fontAwesomeSvgIcon(String iconName)	Creates a new SvgTag that renders the specified SVG icon of FontAwesome using SvgTag.FontAwesomeStyle.SOLID.
static SvgTag	fontAwesomeSvgIcon(String iconName, SvgTag.FontAwesomeStyle style)	Creates a new SvgTag that renders the specified SVG icon of FontAwesome.
String	render()	Renders this tag into plain HTML String representation.
String	toString()
SvgTag	withClasses(String... classNames)	Uses the specified class names for this SVG tag.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

SvgTag

public SvgTag(String iconName)

Creates a new SvgTag that renders the specified SVG icon of FontAwesome using SvgTag.FontAwesomeStyle.SOLID.

Parameters:

iconName - the name of the icon (without fa- prefix), e.g. chevron-circle-up.

SvgTag

public SvgTag(String iconName,
 SvgTag.FontAwesomeStyle style)

Creates a new SvgTag that renders the specified SVG icon of FontAwesome.

Parameters:

iconName - the name of the icon (without fa- prefix), e.g. chevron-circle-up.

style - Font Awesome style of the icon

Method Details

fontAwesomeSvgIcon

public static SvgTag fontAwesomeSvgIcon(String iconName)

Creates a new SvgTag that renders the specified SVG icon of FontAwesome using SvgTag.FontAwesomeStyle.SOLID.

Parameters:

iconName - the name of the icon (without fa- prefix), e.g. chevron-circle-up.

Returns:

the HTML tag

fontAwesomeSvgIcon

public static SvgTag fontAwesomeSvgIcon(String iconName,
 SvgTag.FontAwesomeStyle style)

Creates a new SvgTag that renders the specified SVG icon of FontAwesome.

Parameters:

iconName - the name of the icon (without fa- prefix), e.g. chevron-circle-up.

style - Font Awesome style of the icon

Returns:

the HTML tag

withClasses

public SvgTag withClasses(String... classNames)

Uses the specified class names for this SVG tag. Adds the tag ICON_MD as well as class.

Parameters:

classNames - the additional class names, might be empty

Returns:

this tag

render

public String render()

Renders this tag into plain HTML String representation.

Returns:

the tag as HTML String

toString

public String toString()

Overrides:

toString in class Object