com.threerings.media

Class IconManager

java.lang.Object

com.threerings.media.IconManager

public class IconManager
extends Object

Manages the creation of icons from tileset images. The icon manager is provided with a configuration file, which maps icon set identifiers to uniform tilesets and provides the metric information for said tilesets. UI code can subsequently request icons from the icon manager based on icon set identifier and index.

The configuration might look like the following:

 arrows.path = /rsrc/media/icons/arrows.png
 arrows.metrics = 20, 25  # icons that are 20 pixels wide and 25 pixels tall

 smileys.path = /rsrc/media/icons/smileys.png
 smileys.metrics = 16, 16  # icons that are 16 pixels square
 

A user could then request an arrows icon like so:

 Icon icon = iconmgr.getIcon("arrows", 2);
 

Constructor Summary

Constructors

Constructor and Description
IconManager(TileManager tmgr, Properties config) Creates an icon manager that will obtain tilesets from the supplied tile manager and which will read its configuration information from the supplied properties file.
IconManager(TileManager tmgr, String configPath) Creates an icon manager that will obtain tilesets from the supplied tile manager and which will load its configuration information from the specified properties file.

Method Summary

Modifier and Type	Method and Description
Icon	getIcon(String iconSet, int index) Fetches the icon with the specified index from the named icon set.
void	setSource(String resourceSet) If icon images should be loaded from a set of resource bundles rather than the classpath, that set can be set here.

Methods inherited from class java.lang.Object

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

Constructor Detail

IconManager

public IconManager(TileManager tmgr,
                   String configPath)
            throws IOException

Creates an icon manager that will obtain tilesets from the supplied tile manager and which will load its configuration information from the specified properties file.

Parameters:

tmgr - the tile manager to use when fetching tilesets.

configPath - the path (relative to the classpath) from which the icon manager configuration can be loaded.

Throws:

IOException - thrown if an error occurs loading the configuration file.

IconManager

public IconManager(TileManager tmgr,
                   Properties config)

Creates an icon manager that will obtain tilesets from the supplied tile manager and which will read its configuration information from the supplied properties file.

Method Detail

setSource

public void setSource(String resourceSet)

If icon images should be loaded from a set of resource bundles rather than the classpath, that set can be set here.

getIcon

public Icon getIcon(String iconSet,
                    int index)

Fetches the icon with the specified index from the named icon set.