Package com.levigo.jadice.appbase.font.factory.annotation

Class ChainedAnnotationFontFactory

java.lang.Object

com.levigo.jadice.appbase.font.factory.annotation.ChainedAnnotationFontFactory

All Implemented Interfaces:

AnnotationFontFactory, FontFactory

Direct Known Subclasses:

ChainedSwingAnnotationFontFactory

public class ChainedAnnotationFontFactory
extends Object
implements AnnotationFontFactory

Holds a list of AnnotationFontFactory instances which it delegates calls to, one after the other. The first result will become the chain's result. No further delegates will be asked. If all delegates return null, this will also be the ChainedAnnotationFontFactory's result.

A typical place to use AnnotationFontFactory instances is in Annotations helper class. The AnnotationFontFactory registered there must never return null. A simple way to fulfill this requirement is to register a ChainedAnnotationFontFactory which, as its last delegate, has a AnnotationFontFactory that always returns a Font. One such example is the AnnotationBasicFontFactory.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<AnnotationFontFactory>	factoryChain

Constructor Summary

Constructors

Constructor	Description
ChainedAnnotationFontFactory(AnnotationFontFactory... factoryChain)

Method Summary

Modifier and Type	Method	Description
Font	create(FontAttributeSet fontAttributeSet, Map<String,Object> scope)	Supply a Font which fits well for the requested parameters.
Collection<FontAttributeSet>	getAvailableFontAttributeSets()	Returns available fonts provided by this implementation described via FontAttributeSet class.

Methods inherited from class java.lang.Object

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

Field Detail

factoryChain

protected final List<AnnotationFontFactory> factoryChain

Constructor Detail

ChainedAnnotationFontFactory

public ChainedAnnotationFontFactory(AnnotationFontFactory... factoryChain)

Method Detail

create

public Font create(FontAttributeSet fontAttributeSet,
                   Map<String,Object> scope)

Description copied from interface: FontFactory

Supply a Font which fits well for the requested parameters. Care should be taken to provide a fast implementation. This method might be called frequently and from various Threads at the same time. Blocking should be avoided.

Specified by:

create in interface FontFactory

Parameters:

fontAttributeSet - The Attributes the requested font should have. Characteristics like its name or styles.

scope - Information about this request's scope. This could encompass things like its intent, target, purpose or source.

Returns:

a Font deemed appropriate, or null if no such Font is available. Some implementations might be able to return a Font which fits all requested characteristics. Others might have several to choose from or none at all. The Font which is returned doesn't have to fit all of the requested characteristics, or even any at all. It must only be appropriate in the given situation.

See Also:

Scopes

getAvailableFontAttributeSets

public Collection<FontAttributeSet> getAvailableFontAttributeSets()

Description copied from interface: AnnotationFontFactory

Returns available fonts provided by this implementation described via FontAttributeSet class. This method is currently used by annotation based font face editors. Current implementations provide a simple FontAttributeSet definition containing FamilyName attribute only.

Specified by:

getAvailableFontAttributeSets in interface AnnotationFontFactory

Returns:

FontAttributeSet definition