A B C D E F G H I L M N O P R S T U V W

A

addEventListener(EventListener) - Method in class org.apache.fop.events.CompositeEventListener

Adds an event listener to the broadcaster.

addEventListener(EventListener) - Method in class org.apache.fop.events.DefaultEventBroadcaster

Adds an event listener to the broadcaster.

addEventListener(EventListener) - Method in interface org.apache.fop.events.EventBroadcaster

Adds an event listener to the broadcaster.

addEventModel(EventModel) - Static method in class org.apache.fop.events.DefaultEventBroadcaster

Adds a new EventModel to the list of registered event models.

addFileset(FileSet) - Method in class org.apache.fop.tools.EventProducerCollectorTask

Adds a file set.

addMethod(EventMethodModel) - Method in class org.apache.fop.events.model.EventProducerModel

Adds a model instance of an event method.

addParameter(EventMethodModel.Parameter) - Method in class org.apache.fop.events.model.EventMethodModel

Adds a method parameter.

addParameter(Class, String) - Method in class org.apache.fop.events.model.EventMethodModel

Adds a method parameter.

addProducer(EventProducerModel) - Method in class org.apache.fop.events.model.EventModel

Adds the model of an event producer to the event model.

B

broadcastEvent(Event) - Method in class org.apache.fop.events.DefaultEventBroadcaster

Broadcasts an event.

broadcastEvent(Event) - Method in interface org.apache.fop.events.EventBroadcaster

Broadcasts an event.

build() - Method in class org.apache.fop.events.Event.ParamsBuilder

Returns the accumulated parameter map.

C

CompositeEventListener - Class in org.apache.fop.events

EventListener implementation forwards events to possibly multiple other EventListeners.

CompositeEventListener() - Constructor for class org.apache.fop.events.CompositeEventListener

createException(Event) - Method in interface org.apache.fop.events.EventExceptionManager.ExceptionFactory

Creates an exception from an event.

createProxyFor(Class) - Method in class org.apache.fop.events.DefaultEventBroadcaster

Creates a dynamic proxy for the given EventProducer interface that will handle the conversion of the method call into the broadcasting of an event instance.

D

DefaultEventBroadcaster - Class in org.apache.fop.events

Default implementation of the EventBroadcaster interface.

DefaultEventBroadcaster() - Constructor for class org.apache.fop.events.DefaultEventBroadcaster

E

ERROR - Static variable in class org.apache.fop.events.model.EventSeverity

error level

Event - Class in org.apache.fop.events

This is the default event class used by this package.

Event(Object, String, EventSeverity, Map<String, Object>) - Constructor for class org.apache.fop.events.Event

Creates a new Event using default locale.

Event(Object, String, EventSeverity, Locale, Map<String, Object>) - Constructor for class org.apache.fop.events.Event

Creates a new Event.

Event.ParamsBuilder - Class in org.apache.fop.events

This class is a fluent builder class for building up the parameter map.

EventBroadcaster - Interface in org.apache.fop.events

The EventBroadcaster is the central relay point for events.

EventConventionException - Exception in org.apache.fop.tools

This exception is used to indicate a violation of the conventions for event producers.

EventConventionException(String) - Constructor for exception org.apache.fop.tools.EventConventionException

Creates a new EventConventionException

EventExceptionManager - Class in org.apache.fop.events

This class is responsible for converting events into exceptions.

EventExceptionManager.ExceptionFactory - Interface in org.apache.fop.events

This interface is implementation by exception factories that can create exceptions from events.

EventFormatter - Class in org.apache.fop.events

Converts events into human-readable, localized messages.

EventFormatter.LookupFieldPartFactory - Class in org.apache.fop.events

PartFactory for lookups.

EventListener - Interface in org.apache.fop.events

This interface is implemented by clients who want to listen for events.

EventMethodModel - Class in org.apache.fop.events.model

Represents an event method.

EventMethodModel(String, EventSeverity) - Constructor for class org.apache.fop.events.model.EventMethodModel

Creates an new instance.

EventMethodModel.Parameter - Class in org.apache.fop.events.model

Represents an event parameter.

EventModel - Class in org.apache.fop.events.model

Represents a whole event model that supports multiple event producers.

EventModel() - Constructor for class org.apache.fop.events.model.EventModel

Creates a new, empty event model

EventModelParser - Class in org.apache.fop.events.model

This is a parser for the event model XML.

EventProducer - Interface in org.apache.fop.events

This is a marker interface which all event producer interfaces need to extend.

EventProducerCollectorTask - Class in org.apache.fop.tools

Ant task which inspects a file set for Java interfaces which extend the EventProducer interface.

EventProducerCollectorTask() - Constructor for class org.apache.fop.tools.EventProducerCollectorTask

EventProducerModel - Class in org.apache.fop.events.model

Represents the model of an event producer with multiple event methods.

EventProducerModel(String) - Constructor for class org.apache.fop.events.model.EventProducerModel

Creates a new instance.

EventSeverity - Class in org.apache.fop.events.model

Enumeration class for event severities.

execute() - Method in class org.apache.fop.tools.EventProducerCollectorTask

F

FATAL - Static variable in class org.apache.fop.events.model.EventSeverity

fatal error

format(Event) - Static method in class org.apache.fop.events.EventFormatter

Formats an event using the default locale.

format(Event, Locale) - Static method in class org.apache.fop.events.EventFormatter

Formats an event using a given locale.

format(Event, String) - Static method in class org.apache.fop.events.EventFormatter

Formats the event using a given pattern.

G

getContentHandler(EventModel) - Static method in class org.apache.fop.events.model.EventModelParser

Creates a new ContentHandler instance that you can send the event model XML to.

getEventGroupID() - Method in class org.apache.fop.events.Event

Returns the event group identifier.

getEventID() - Method in class org.apache.fop.events.Event

Returns the event identifier.

getEventKey() - Method in class org.apache.fop.events.Event

Returns the event key.

getEventProducerFor(Class) - Method in class org.apache.fop.events.DefaultEventBroadcaster

Returns an event producer instance for the given interface class.

getEventProducerFor(Class<T>) - Method in interface org.apache.fop.events.EventBroadcaster

Returns an event producer instance for the given interface class.

getExceptionClass() - Method in interface org.apache.fop.events.EventExceptionManager.ExceptionFactory

Returns the Exception class created by this factory.

getExceptionClass() - Method in class org.apache.fop.events.model.EventMethodModel

Returns the primary exception class for this event method.

getFormat() - Method in class org.apache.fop.events.EventFormatter.LookupFieldPartFactory

getInterfaceName() - Method in class org.apache.fop.events.model.EventProducerModel

Returns the fully qualified interface name of the event producer.

getLocale() - Method in class org.apache.fop.events.Event

Returns the locale.

getMethod(String) - Method in class org.apache.fop.events.model.EventProducerModel

Returns the model instance of an event method for the given method name.

getMethodName() - Method in class org.apache.fop.events.model.EventMethodModel

Returns the event method name

getMethods() - Method in class org.apache.fop.events.model.EventProducerModel

Returns an iterator over the contained event producer methods.

getName() - Method in class org.apache.fop.events.model.EventMethodModel.Parameter

Returns the parameter name.

getName() - Method in class org.apache.fop.events.model.EventSeverity

getParam(String) - Method in class org.apache.fop.events.Event

Returns a parameter.

getParameters() - Method in class org.apache.fop.events.model.EventMethodModel

Returns an unmodifiable list of parameters for this event method.

getParams() - Method in class org.apache.fop.events.Event

Returns an unmodifiable Map with all event parameters.

getProducer(String) - Method in class org.apache.fop.events.model.EventModel

Returns the model of an event producer with the given interface name.

getProducer(Class) - Method in class org.apache.fop.events.model.EventModel

Returns the model of an event producer with the given interface.

getProducers() - Method in class org.apache.fop.events.model.EventModel

Returns an iterator over the contained event producer models.

getSeverity() - Method in class org.apache.fop.events.Event

Returns the severity level.

getSeverity() - Method in class org.apache.fop.events.model.EventMethodModel

Returns the event's severity level.

getTranslationFile() - Method in class org.apache.fop.tools.EventProducerCollectorTask

Returns the translation file for the event producer methods.

getType() - Method in class org.apache.fop.events.model.EventMethodModel.Parameter

Returns the parameter type.

H

hasEventListeners() - Method in class org.apache.fop.events.CompositeEventListener

Indicates whether any listeners have been registered with the broadcaster.

hasEventListeners() - Method in class org.apache.fop.events.DefaultEventBroadcaster

Indicates whether any listeners have been registered with the broadcaster.

hasEventListeners() - Method in interface org.apache.fop.events.EventBroadcaster

Indicates whether any listeners have been registered with the broadcaster.

I

INFO - Static variable in class org.apache.fop.events.model.EventSeverity

info level

L

listeners - Variable in class org.apache.fop.events.DefaultEventBroadcaster

Holds all registered event listeners

LookupFieldPartFactory() - Constructor for class org.apache.fop.events.EventFormatter.LookupFieldPartFactory

M

main(String[]) - Static method in class org.apache.fop.tools.EventProducerCollectorTask

Command-line interface for testing purposes.

N

newPart(String, String) - Method in class org.apache.fop.events.EventFormatter.LookupFieldPartFactory

O

org.apache.fop.events - package org.apache.fop.events

org.apache.fop.events.model - package org.apache.fop.events.model

Model classes for the event subsystem.

org.apache.fop.tools - package org.apache.fop.tools

P

param(String, Object) - Method in class org.apache.fop.events.Event.ParamsBuilder

Adds a new parameter (a name/value pair).

Parameter(Class, String) - Constructor for class org.apache.fop.events.model.EventMethodModel.Parameter

Creates a new event parameter.

paramsBuilder() - Static method in class org.apache.fop.events.Event

Creates and returns a fluent builder object for building up the parameter map.

ParamsBuilder() - Constructor for class org.apache.fop.events.Event.ParamsBuilder

parse(Source) - Static method in class org.apache.fop.events.model.EventModelParser

Parses an event model file into an EventModel instance.

processEvent(Event) - Method in class org.apache.fop.events.CompositeEventListener

This method is called for each event that is generated.

processEvent(Event) - Method in interface org.apache.fop.events.EventListener

This method is called for each event that is generated.

processFileSets(EventProducerCollector) - Method in class org.apache.fop.tools.EventProducerCollectorTask

Processes the file sets defined for the task.

R

removeEventListener(EventListener) - Method in class org.apache.fop.events.CompositeEventListener

Removes an event listener from the broadcaster.

removeEventListener(EventListener) - Method in class org.apache.fop.events.DefaultEventBroadcaster

Removes an event listener from the broadcaster.

removeEventListener(EventListener) - Method in interface org.apache.fop.events.EventBroadcaster

Removes an event listener from the broadcaster.

S

saveToXML(File) - Method in class org.apache.fop.events.model.EventModel

Saves this event model to an XML file.

setDestDir(File) - Method in class org.apache.fop.tools.EventProducerCollectorTask

Sets the destination directory for the event models.

setExceptionClass(String) - Method in class org.apache.fop.events.model.EventMethodModel

Sets the primary exception class for this event method.

setInterfaceName(String) - Method in class org.apache.fop.events.model.EventProducerModel

Sets the fully qualified interface name of the event producer.

setMethodName(String) - Method in class org.apache.fop.events.model.EventMethodModel

Sets the event method name.

setSeverity(EventSeverity) - Method in class org.apache.fop.events.Event

Sets the event's severity level.

setSeverity(EventSeverity) - Method in class org.apache.fop.events.model.EventMethodModel

Sets the event's severity level.

setTranslationFile(File) - Method in class org.apache.fop.tools.EventProducerCollectorTask

Sets the translation file for the event producer methods.

T

throwException(Event, String) - Static method in class org.apache.fop.events.EventExceptionManager

Converts an event into an exception and throws that.

toSAX(ContentHandler) - Method in class org.apache.fop.events.model.EventMethodModel.Parameter

toSAX(ContentHandler) - Method in class org.apache.fop.events.model.EventMethodModel

toSAX(ContentHandler) - Method in class org.apache.fop.events.model.EventModel

toSAX(ContentHandler) - Method in class org.apache.fop.events.model.EventProducerModel

toString() - Method in class org.apache.fop.events.model.EventSeverity

U

updateTranslationFile(File) - Method in class org.apache.fop.tools.EventProducerCollectorTask

Updates the translation file with new entries for newly found event producer methods.

V

valueOf(String) - Static method in class org.apache.fop.events.model.EventSeverity

Returns the enumeration/singleton object based on its name.

W

WARN - Static variable in class org.apache.fop.events.model.EventSeverity

warning level

A B C D E F G H I L M N O P R S T U V W