org.fujion.icon

Class IconLibraryBase

java.lang.Object

org.fujion.icon.IconLibraryBase

All Implemented Interfaces:

IIconLibrary, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public abstract class IconLibraryBase
extends Object
implements IIconLibrary, org.springframework.context.ApplicationContextAware

An abstract base implementation for webjar-packaged icon libraries.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IconLibraryBase(String webjarName, String defaultExtension, String... dimensions) Create icon library definition.

Method Summary

Modifier and Type	Method and Description
protected abstract String	doFormatPath(String iconName, String dimensions)
protected String	expandName(String name)
protected String	getDefaultDimension()
protected String	getDefaultExtension()
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 dims) Returns a list of relative paths for icons that match the criteria.
protected List<String>	resolveDims(String dims) Returns a list of matching dimensions.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
String[]	supportedDimensions() Returns an array of dimensions supported by this library.

Methods inherited from class java.lang.Object

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

Constructor Detail

IconLibraryBase

protected IconLibraryBase(String webjarName,
                          String defaultExtension,
                          String... dimensions)

Create icon library definition.

Parameters:

webjarName - The webjar name.

defaultExtension - The default file extension (e.g., "png").

dimensions - The supported dimensions.

Method Detail

getId

public String getId()

Description copied from interface: IIconLibrary

Returns the unique identifier for the library.

Specified by:

getId in interface IIconLibrary

Returns:

The unique identifier.

getIconPath

public String getIconPath(String iconName,
                          String dimensions)

Description copied from interface: IIconLibrary

Returns the relative path for the requested icon.

Specified by:

getIconPath in interface IIconLibrary

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

public List<String> getMatching(String iconName,
                                String dims)

Description copied from interface: IIconLibrary

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

Specified by:

getMatching in interface IIconLibrary

Parameters:

iconName - Name of icon to match.

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

Returns:

List of matching paths.

supportedDimensions

public String[] supportedDimensions()

Description copied from interface: IIconLibrary

Returns an array of dimensions supported by this library.

Specified by:

supportedDimensions in interface IIconLibrary

Returns:

Array of supported dimensions.

getDefaultExtension

protected String getDefaultExtension()

getDefaultDimension

protected String getDefaultDimension()

resolveDims

protected List<String> resolveDims(String dims)

Returns a list of matching dimensions.

Parameters:

dims - Input dimensions (wildcards allowed).

Returns:

List of matching dimensions (never null);

expandName

protected String expandName(String name)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

doFormatPath

protected abstract String doFormatPath(String iconName,
                                       String dimensions)