org.fujion.icon

Interface IIconLibrary

All Known Implementing Classes:

IconLibraryBase

public interface IIconLibrary

Interface for plug-in icon libraries.

Method Summary

Modifier and Type	Method and Description
String	getIconPath(String iconName, String dimensions) Returns the relative path for the requested icon.
String	getId() Returns the unique identifier for the library.
List<String>	getMatching(String iconName, String dimensions) Returns a list of relative paths for icons that match the criteria.
String[]	supportedDimensions() Returns an array of dimensions supported by this library.

Method Detail

getId

String getId()

Returns the unique identifier for the library.

Returns:

The unique identifier.

getIconPath

String getIconPath(String iconName,
                   String dimensions)

Returns the relative path for the requested icon.

Parameters:

iconName - The icon file name.

dimensions - The desired dimensions (for example, 16x16). May be null for default dimensions.

Returns:

The relative path referencing the requested icon.

getMatching

List<String> getMatching(String iconName,
                         String dimensions)

Returns a list of relative paths for icons that match the criteria. Criteria may include wildcard characters. For example, getMatching("weather*", "*x16")

Parameters:

iconName - Name of icon to match.

dimensions - Desired dimensions to match. May be null for default dimensions.

Returns:

List of matching paths.

supportedDimensions

String[] supportedDimensions()

Returns an array of dimensions supported by this library.

Returns:

Array of supported dimensions.