A set of attributes for a sink event.
All sink methods that produce some presentation-level output should have at least one form that allows to pass in a Set of SinkEventAttributes. For instance in
void text( String text, SinkEventAttributes attributes );
the
attributes
parameter can be used to specify some text styling options, or other optional parameters.
What kind of attributes are supported depends on the event and the sink implementation. The sink API just specifies a list of suggested attribute names, that sinks are expected to recognize, and parsers are expected to use preferably when emitting events.
It is recommended that for simple attributes, both keys and values should be lower-case Strings, but this is not mandatory. One example of an exception is the {@link #STYLE} attribute, whose value may itself be an AttributeSet again.
The base attributes that are supported by almost all events are {@link #CLASS}, {@link #ID}, {@link #LANG}, {@link #STYLE} and {@link #TITLE}.
@author ltheussl
@version $Id: SinkEventAttributes.java 733395 2009-01-10 23:09:40Z ltheussl $
@since 1.1