org.fujion.icon

Class IconUtil

java.lang.Object

org.fujion.icon.IconUtil

public class IconUtil
extends Object

Utility class for Icon support

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.springframework.util.AntPathMatcher	matcher

Method Summary

Modifier and Type	Method and Description
static String	getIconPath(String icon) Returns the path to the icon resource.
static String	getIconPath(String library, String icon, String dimensions) Returns the path to the icon resource given its name, dimensions, and library name.
static List<String>	getMatching(String library, String icon, String dimensions) Returns the paths to matching icon resources given name, dimensions, and library name, any one of which may contain wildcard characters.

Methods inherited from class java.lang.Object

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

Field Detail

matcher

protected static final org.springframework.util.AntPathMatcher matcher

Method Detail

getIconPath

public static String getIconPath(String icon)

Returns the path to the icon resource.

For example: getIconPath("help.png") or getIconPath("silk:help:16x16")

Note: This method signature is exposed as the getIconPath tag library function.

Parameters:

icon - An icon name or specifier.

Returns:

Path to icon resource.

getIconPath

public static String getIconPath(String library,
                                 String icon,
                                 String dimensions)

Returns the path to the icon resource given its name, dimensions, and library name.

Note: This method signature is exposed as the getIconPathEx tag library function.

Parameters:

icon - Name of the requested icon (e.g., "help.png").

library - Name of the library containing the icon (e.g., "silk"). Specify null to use default.

dimensions - Dimensions of the requested icon (e.g., "16x16"). Specify null to use default.

Returns:

The icon path.

getMatching

public static List<String> getMatching(String library,
                                       String icon,
                                       String dimensions)

Returns the paths to matching icon resources given name, dimensions, and library name, any one of which may contain wildcard characters.

Parameters:

library - Library name containing the icon (e.g., "silk"). Specify null to use default.

icon - An icon name or specifier (e.g., "help.png" or "silk:help:16x16").

dimensions - Dimensions of the requested icon (e.g., "16x16"). Specify null to use default.

Returns:

The icon path.