org.jenkins.ui.icon

Class IconSet

java.lang.Object

org.jenkins.ui.icon.IconSet

public class IconSet
extends Object

An icon set.

Author:

tom.fennelly@gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
static IconSet	icons

Constructor Summary

Constructors

Constructor and Description
IconSet()

Method Summary

Modifier and Type	Method and Description
IconSet	addIcon(Icon icon)
Icon	getIconByClassSpec(groovy.lang.GString iconClassSpec) Get an icon instance from a class specification.
Icon	getIconByClassSpec(String iconClassSpec) Get an icon instance from a class specification.
Icon	getIconByNormalizedCSSSelector(groovy.lang.GString cssSelector) Get an icon instance from it's normalized CSS selector.
Icon	getIconByNormalizedCSSSelector(String cssSelector) Get an icon instance from it's normalized CSS selector.
Icon	getIconByUrl(groovy.lang.GString url) Get an icon instance from it's url.
Icon	getIconByUrl(String url) Get an icon instance from it's url.
static void	initPageVariables(org.apache.commons.jelly.JellyContext context)
static String	toNormalizedIconNameClass(groovy.lang.GString string) Normalize the supplied string to an Icon name class e.g.
static String	toNormalizedIconNameClass(String string) Normalize the supplied string to an Icon name class e.g.
static String	toNormalizedIconSizeClass(groovy.lang.GString string) Normalize the supplied string to an Icon size class e.g.
static String	toNormalizedIconSizeClass(String string) Normalize the supplied string to an Icon size class e.g.
static String	toNormalizedIconUrl(groovy.lang.GString url) Normalize the supplied url.
static String	toNormalizedIconUrl(String url) Normalize the supplied url.

Methods inherited from class java.lang.Object

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

Field Detail

icons

public static final IconSet icons

Constructor Detail

IconSet

public IconSet()

Method Detail

initPageVariables

public static void initPageVariables(org.apache.commons.jelly.JellyContext context)

addIcon

public IconSet addIcon(Icon icon)

getIconByNormalizedCSSSelector

public Icon getIconByNormalizedCSSSelector(groovy.lang.GString cssSelector)

Get an icon instance from it's normalized CSS selector.

Parameters:

cssSelector - The icon's normalized CSS selector.

Returns:

The icon instance, or null if no such icon.

getIconByNormalizedCSSSelector

public Icon getIconByNormalizedCSSSelector(String cssSelector)

Get an icon instance from it's normalized CSS selector.

Parameters:

cssSelector - The icon's normalized CSS selector.

Returns:

The icon instance, or null if no such icon.

getIconByClassSpec

public Icon getIconByClassSpec(groovy.lang.GString iconClassSpec)

Get an icon instance from a class specification.

Parameters:

iconClassSpec - The icon's class spec as defined on the <l:icon class> attribute.

Returns:

The icon instance, or null if no such icon.

getIconByClassSpec

public Icon getIconByClassSpec(String iconClassSpec)

Get an icon instance from a class specification.

Parameters:

iconClassSpec - The icon's class spec as defined on the <l:icon class> attribute.

Returns:

The icon instance, or null if no such icon.

getIconByUrl

public Icon getIconByUrl(groovy.lang.GString url)

Get an icon instance from it's url.

Parameters:

url - The icon url.

Returns:

The icon instance, or null if no such icon.

getIconByUrl

public Icon getIconByUrl(String url)

Get an icon instance from it's url.

Parameters:

url - The icon url.

Returns:

The icon instance, or null if no such icon.

toNormalizedIconNameClass

public static String toNormalizedIconNameClass(groovy.lang.GString string)

Normalize the supplied string to an Icon name class e.g. "blue_anime" to "icon-blue-anime".

Parameters:

string - The string to be normalized.

Returns:

The normalized icon name class.

toNormalizedIconNameClass

public static String toNormalizedIconNameClass(String string)

Normalize the supplied string to an Icon name class e.g. "blue_anime" to "icon-blue-anime".

Parameters:

string - The string to be normalized.

Returns:

The normalized icon name class.

toNormalizedIconSizeClass

public static String toNormalizedIconSizeClass(groovy.lang.GString string)

Normalize the supplied string to an Icon size class e.g. "16x16" to "icon-sm".

Parameters:

string - The string to be normalized.

Returns:

The normalized icon size class, or the unmodified string arg if it was an unrecognised icon size.

toNormalizedIconSizeClass

public static String toNormalizedIconSizeClass(String string)

Normalize the supplied string to an Icon size class e.g. "16x16" to "icon-sm".

Parameters:

string - The string to be normalized.

Returns:

The normalized icon size class, or the unmodified string arg if it was an unrecognised icon size.

toNormalizedIconUrl

public static String toNormalizedIconUrl(groovy.lang.GString url)

Normalize the supplied url.

Parameters:

url - The url to be normalized.

Returns:

The normalized url.

toNormalizedIconUrl

public static String toNormalizedIconUrl(String url)

Normalize the supplied url.

Parameters:

url - The url to be normalized.

Returns:

The normalized url.