de.unirostock.sems.cbext.collections

Class DefaultIconCollection

java.lang.Object

de.unirostock.sems.cbext.IconCollection

de.unirostock.sems.cbext.collections.DefaultIconCollection

public class DefaultIconCollection
extends IconCollection

The Class DefaultIconCollection provides you with a bunch of default icons.

Field Summary

Fields

Modifier and Type	Field and Description
protected Properties	format2Icon The format2 icon.
protected static int	priority priority for this icon collection

Constructor Summary

Constructors

Constructor and Description
DefaultIconCollection() Instantiates a new default icon mapper.

Method Summary

Modifier and Type	Method and Description
String	formatToIconName(URI format) Get an icon file name given a format, as it can be found in our jar archive.
InputStream	formatToIconStream(URI format) Get an icon stream given a format.
URL	formatToIconUrl(URI format) Get a URL pointing to an icon in the archive.
Set<Object>	getAvailableFormatIcons() Get a list of formats for that we have an icon.
int	getPriority() Defines the priority of this collection.
boolean	hasIcon(URI format) Returns true, if the given format is available in this collection.
static void	setPriority(int newPriority) Sets the priority of this icon collection and triggers a resort of all icon collection.

Methods inherited from class java.lang.Object

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

Field Detail

priority

protected static int priority

priority for this icon collection

format2Icon

protected Properties format2Icon

The format2 icon.

Constructor Detail

DefaultIconCollection

public DefaultIconCollection()

Instantiates a new default icon mapper.

Method Detail

setPriority

public static void setPriority(int newPriority)

Sets the priority of this icon collection and triggers a resort of all icon collection. The higher the priority, the earlier this collection gets asked. The first collection, which is able to provide an icon, determines it's icon. Setting a negative priority will be ignored. Default collections have a priority of 100.

Parameters:

newPriority - the new priority of this collection

getPriority

public int getPriority()

Description copied from class: IconCollection

Defines the priority of this collection. The higher the priority, the sooner this collection gets asked.
Should not be negative. Default collections have a priority around 100.

Specified by:

getPriority in class IconCollection

Returns:

an integer > 0

hasIcon

public boolean hasIcon(URI format)

Description copied from class: IconCollection

Returns true, if the given format is available in this collection.

Specified by:

hasIcon in class IconCollection

Parameters:

format - the format URI

Returns:

true, if we have an icon for that format

formatToIconUrl

public URL formatToIconUrl(URI format)

Description copied from class: IconCollection

Get a URL pointing to an icon in the archive. If no icon is available null is supposed to be returned.

Specified by:

formatToIconUrl in class IconCollection

Parameters:

format - the format URI

Returns:

the URL pointing to the icon for that format

formatToIconStream

public InputStream formatToIconStream(URI format)

Description copied from class: IconCollection

Get an icon stream given a format. This stream will ship the icon as it is stored in our jar file. If no icon is available null is supposed to be returned.

Specified by:

formatToIconStream in class IconCollection

Parameters:

format - the format URI

Returns:

the stream delivering the icon for the format

formatToIconName

public String formatToIconName(URI format)

Description copied from class: IconCollection

Get an icon file name given a format, as it can be found in our jar archive. Especially useful for people who are going to extract the icons. If no icon is available null is supposed to be returned.

Specified by:

formatToIconName in class IconCollection

Parameters:

format - the format URI

Returns:

the name of the icon for this format

getAvailableFormatIcons

public Set<Object> getAvailableFormatIcons()

Get a list of formats for that we have an icon.

Returns:

set of objects that are actually strings