Package net.sf.gridarta.model.face

Class FilterFaceProvider

java.lang.Object

net.sf.gridarta.model.face.AbstractFaceProvider

net.sf.gridarta.model.face.FilterFaceProvider

All Implemented Interfaces:

FaceProvider

public class FilterFaceProvider
extends AbstractFaceProvider

A FilterFaceProvider provides modified versions of icons provided by another FaceProvider by applying a Filter.

Constructor Summary

Constructors

Constructor	Description
FilterFaceProvider(@NotNull java.awt.image.ImageFilter filter)	Creates a new instance.
FilterFaceProvider(@Nullable FaceProvider parent, @NotNull java.awt.image.ImageFilter filter)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected @Nullable javax.swing.ImageIcon	createImage(@NotNull java.lang.String faceName, long stretch)	Creates an image not found in the cache.
void	setParent(@Nullable FaceProvider parent)	Sets a new provider as parent.

Methods inherited from class net.sf.gridarta.model.face.AbstractFaceProvider

getImageIconForFacename, reload

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterFaceProvider

public FilterFaceProvider(@NotNull
                          @NotNull java.awt.image.ImageFilter filter)

Creates a new instance. The parent is unset. The parent must be set with setParent(FaceProvider) before invoking AbstractFaceProvider.getImageIconForFacename(String, long) or createImage(String, long) or getting a face resp. creating an image will throw an IllegalStateException.

Parameters:

filter - ImageFilter to apply for creating the images

FilterFaceProvider

public FilterFaceProvider(@Nullable
                          @Nullable FaceProvider parent,
                          @NotNull
                          @NotNull java.awt.image.ImageFilter filter)

Creates a new instance.

Parameters:

parent - parent provider to get unfiltered images from

filter - ImageFilter to apply for creating the images

Method Detail

setParent

public void setParent(@Nullable
                      @Nullable FaceProvider parent)

Sets a new provider as parent.

Parameters:

parent - parent provider to get unfiltered images from

createImage

@Nullable
protected @Nullable javax.swing.ImageIcon createImage(@NotNull
                                                      @NotNull java.lang.String faceName,
                                                      long stretch)

Description copied from class: AbstractFaceProvider

Creates an image not found in the cache.

Specified by:

createImage in class AbstractFaceProvider

Parameters:

faceName - face name to get image for, excluding path and ending

stretch - stretch factor

Returns:

icon for faceName