org.freedesktop.icons

Class DefaultIconService

java.lang.Object

org.freedesktop.AbstractFreedesktopService<T>

org.freedesktop.themes.AbstractThemeService<IconTheme>

org.freedesktop.icons.DefaultIconService

All Implemented Interfaces:

FreedesktopService<IconTheme>, IconService, ThemeService<IconTheme>

Direct Known Subclasses:

LinuxIconService

public class DefaultIconService
extends AbstractThemeService<IconTheme>
implements IconService

Default implementations of an IconService. Four image types are supported. PNG, GIF, XPM and SVG.

Icon locations are also cached in memory, keyed on [iconName]_[preferredSize]. Use clearCache() to remove all cached locations.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	defaultThemeName
static String[]	SUPPORTED_EXTENSIONS Support file extensions

Fields inherited from class org.freedesktop.AbstractFreedesktopService

bases, basesList

Constructor Summary

Constructors

Constructor and Description
DefaultIconService()

Method Summary

Modifier and Type	Method and Description
void	addBase(org.apache.commons.vfs2.FileObject base) Add a directory to the list of those that should be searched.
void	clearCache()
org.apache.commons.vfs2.FileObject	findIcon(String name, int size) Find the closest matching icon.
protected IconTheme	getDefaultTheme()
Iterator<String>	iconNames() Iterator over all the available icon names in the currently selected theme for a given size.
Iterator<org.apache.commons.vfs2.FileObject>	icons(int size) Iterator over all the available icons in the currently selected theme for a given size.
boolean	isIconExists(String name, int size) Find the closest matching icon.
void	postInit() Must be called after construction to set the initial theme.
void	removeBase(org.apache.commons.vfs2.FileObject base) Remove a directory from the list that is is searched.
protected Collection<IconTheme>	scanBase(org.apache.commons.vfs2.FileObject base)
void	setDefaultThemeName(String defaultThemeName)
void	setReturnMissingImage(boolean returnMissingImage) Set whether the special Missing image is returned when no other matches is found.
void	setSelectedTheme(IconTheme theme) Set the currently selected theme.

Methods inherited from class org.freedesktop.themes.AbstractThemeService

getSelectedTheme

Methods inherited from class org.freedesktop.AbstractFreedesktopService

checkAndAddBase, checkAndAddBase, getAllEntities, getBases, getBasesInReverse, getEntities, getEntity, listDirs

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.freedesktop.themes.ThemeService

getSelectedTheme

Methods inherited from interface org.freedesktop.FreedesktopService

getAllEntities, getBases, getEntities, getEntity

Field Detail

SUPPORTED_EXTENSIONS

public static final String[] SUPPORTED_EXTENSIONS

Support file extensions

defaultThemeName

protected String defaultThemeName

Constructor Detail

DefaultIconService

public DefaultIconService()
                   throws IOException,
                          ParseException

Throws:

IOException

ParseException

Method Detail

setDefaultThemeName

public void setDefaultThemeName(String defaultThemeName)

postInit

public final void postInit()

Description copied from interface: IconService

Must be called after construction to set the initial theme.

Specified by:

postInit in interface IconService

getDefaultTheme

protected IconTheme getDefaultTheme()

addBase

public void addBase(org.apache.commons.vfs2.FileObject base)
             throws IOException

Description copied from interface: FreedesktopService

Add a directory to the list of those that should be searched. The base directories will be searched in the order they were added.

Specified by:

addBase in interface FreedesktopService<IconTheme>

Overrides:

addBase in class AbstractFreedesktopService<IconTheme>

Parameters:

base - base directory

Throws:

IOException - if location is invalid in some way

removeBase

public void removeBase(org.apache.commons.vfs2.FileObject base)

Description copied from interface: FreedesktopService

Remove a directory from the list that is is searched.

Specified by:

removeBase in interface FreedesktopService<IconTheme>

Overrides:

removeBase in class AbstractFreedesktopService<IconTheme>

Parameters:

base - base directory to remove from the list that is searched

See Also:

#addBase(File)

setSelectedTheme

public void setSelectedTheme(IconTheme theme)

Description copied from interface: ThemeService

Set the currently selected theme.

Specified by:

setSelectedTheme in interface ThemeService<IconTheme>

Overrides:

setSelectedTheme in class AbstractThemeService<IconTheme>

Parameters:

theme - selected theme

icons

public Iterator<org.apache.commons.vfs2.FileObject> icons(int size)

Description copied from interface: IconService

Iterator over all the available icons in the currently selected theme for a given size.

Specified by:

icons in interface IconService

Parameters:

size - preferred size

Returns:

icon iterator

iconNames

public Iterator<String> iconNames()

Description copied from interface: IconService

Iterator over all the available icon names in the currently selected theme for a given size.

Specified by:

iconNames in interface IconService

Returns:

icon iterator

findIcon

public org.apache.commons.vfs2.FileObject findIcon(String name,
                                                   int size)
                                            throws IOException

Description copied from interface: IconService

Find the closest matching icon. See the class description for IconService for a complete description of the search algorithm. null will only be returned if no matching icon can be found and the image-missing icon cannot be found either

Specified by:

findIcon in interface IconService

Parameters:

name - name of icon

size - closest pixel size

Returns:

file icon file

Throws:

IOException

isIconExists

public boolean isIconExists(String name,
                            int size)
                     throws IOException

Description copied from interface: IconService

Find the closest matching icon. See the class description for IconService for a complete description of the search algorithm.

Specified by:

isIconExists in interface IconService

Parameters:

name - name of icon

size - closest pixel size

Returns:

file or null if no icon can be found

Throws:

IOException

setReturnMissingImage

public void setReturnMissingImage(boolean returnMissingImage)

Description copied from interface: IconService

Set whether the special Missing image is returned when no other matches is found. If true and this image isn't found, an IOException will be thrown.

Specified by:

setReturnMissingImage in interface IconService

clearCache

public void clearCache()

scanBase

protected Collection<IconTheme> scanBase(org.apache.commons.vfs2.FileObject base)
                                  throws IOException

Specified by:

scanBase in class AbstractFreedesktopService<IconTheme>

Throws:

IOException