Interface SinkEventAttributes

All Superinterfaces:
AttributeSet, MutableAttributeSet
All Known Implementing Classes:
SinkEventAttributeSet
public interface SinkEventAttributes extends MutableAttributeSet
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 STYLE attribute, whose value may itself be an AttributeSet again.

The base attributes that are supported by almost all events are CLASS, ID, LANG, STYLE and TITLE.

Since:
1.1

  • Field Details

    • CLASS

      static final String CLASS
      The class of the event element.
      See Also:

    • ID

      static final String ID
      A unique id for the event element.
      See Also:

    • LANG

      static final String LANG
      The language code for the event element.
      See Also:

    • STYLE

      static final String STYLE
      An inline style definition.

      Generally supported values are "italic", "bold", "monospaced" and AttributeSets.

      If the value of this Attribute is itself an AttributeSet, it is interpreted as a sequence of CSS properties. For instance, the HTML paragraph opening 

        <p style="color: red; margin-left: 20px">

      can be produced by an HTML Sink via the event Sink.paragraph(SinkEventAttributes), where the value of the SinkEventAttribute is an AttributeSet with two Attributes ("color" and "margin-left" with values "red" and "20px", respectively).

      See Also:

    • TITLE

      static final String TITLE
      A text to display in a tool tip.
      See Also:

    • PROFILE

      static final String PROFILE
      A space separated list of URL's that contains meta data information about the document.
      See Also:

    • EMAIL

      static final String EMAIL
      An electronic mail address.
      See Also:

    • ALIGN

      static final String ALIGN
      Specifies the alignment of the event element within its parent element.

      Generally supported values are "left", "right", "center", "justify".

      See Also:

    • ALT

      static final String ALT
      Defines a short description of the event element.
      See Also:

    • BORDER

      static final String BORDER
      Defines a border around an event element.
      See Also:

    • HEIGHT

      static final String HEIGHT
      Defines the height of an event element.
      See Also:

    • HSPACE

      static final String HSPACE
      Defines white space on the left and right side of an event element.
      See Also:

    • ISMAP

      static final String ISMAP
      Defines an image as a server-side image map. Only used by the figureGraphics Sink event.
      See Also:

    • SRC

      static final String SRC
      The URL of an external resource, eg an image.
      See Also:

    • USEMAP

      static final String USEMAP
      Defines an image as a client-side image map.
      See Also:

    • VSPACE

      static final String VSPACE
      Defines white space on the top and bottom of the event element.
      See Also:

    • WIDTH

      static final String WIDTH
      Sets the width of an event element.
      See Also:

    • NOSHADE

      static final String NOSHADE
      Used to indicate that an element comes with a shadow.
      See Also:

    • SIZE

      static final String SIZE
      Specifies the size, or thickness, or height of an event element.
      See Also:

    • NAME

      static final String NAME
      Specifies the name of an anchor.
      See Also:

    • CHARSET

      static final String CHARSET
      Specifies the character encoding of text associated with an event element.
      See Also:

    • COORDS

      static final String COORDS
      May be used in conjunction with SHAPE.

      Valid values are the same as for the corresponding HTML attributes.

      See Also:

    • HREF

      static final String HREF
      The target URL of an event element, eg a link.
      See Also:

    • HREFLANG

      static final String HREFLANG
      Specifies the base language of the target URL.

      Used in conjunction with HREF.

      See Also:

    • REL

      static final String REL
      For references to external resourcs, specifies the relationship between the current document and the target URL.

      Valid values are the same as for the corresponding HTML attribute.

      See Also:

    • REV

      static final String REV
      For references to external resourcs, specifies the relationship between the target URL and the current document.

      Valid values are the same as for the corresponding HTML attribute.

      See Also:

    • SHAPE

      static final String SHAPE
      Defines the type of region to be defined for a mapping.

      Used with the COORDS attribute.

      See Also:

    • TARGET

      static final String TARGET
      Where to open the target URL.

      Valid values are the same as for the corresponding HTML attribute.

      See Also:

    • TYPE

      static final String TYPE
      Specifies the MIME (Multipurpose Internet Mail Extensions) type of an external resource URL, eg a link.
      See Also:

    • BGCOLOR

      static final String BGCOLOR
      Specifies the background color of an event element.
      See Also:

    • CELLPADDING

      static final String CELLPADDING
      Specifies the space between cell walls and contents.
      See Also:

    • CELLSPACING

      static final String CELLSPACING
      Specifies the space between cells.
      See Also:

    • FRAME

      static final String FRAME
      Specifies which sides of a border surrounding an element should be visible.

      Valid values are the same as for the corresponding HTML attribute.

      See Also:

    • RULES

      static final String RULES
      Specifies horizontal/vertical divider lines between certain elements, eg table cells.
      See Also:

    • SUMMARY

      static final String SUMMARY
      Specifies a summary of an event attribute for speech-synthesizing/non-visual target output.
      See Also:

    • ABBRV

      static final String ABBRV
      Specifies an abbreviated version of the content in an element.
      See Also:

    • AXIS

      static final String AXIS
      Defines a name for a cell.
      See Also:

    • COLSPAN

      static final String COLSPAN
      Indicates the number of columns a cell should span. Used in tables.
      See Also:

    • HEADERS

      static final String HEADERS
      A space-separated list of cell IDs that supply header information for the cell.
      See Also:

    • NOWRAP

      static final String NOWRAP
      Whether to disable or enable automatic text wrapping for an element.
      See Also:

    • ROWSPAN

      static final String ROWSPAN
      Indicates the number of rows a cell should span. Used in tables.
      See Also:

    • SCOPE

      static final String SCOPE
      A general scope parameter. In Particular, for table cells this specifies if the cell provides header information for the rest of the row that contains it ("row"), or for the rest of the column ("col"), or for the rest of the row group that contains it ("rowgroup"), or for the rest of the column group that contains it ("colgroup").
      See Also:

    • VALIGN

      static final String VALIGN
      Specifies the vertical alignment of an element.

      Generally accepted values are "top", "baseline", "middle", "bottom", "sup", "sub".

      See Also:

    • DECORATION

      static final String DECORATION
      Specifies a decoration for an element.

      Generally accepted values are "underline", "overline", "line-through", "source".

      See Also:

    • SEMANTICS

      static final String SEMANTICS
      Specifies the semantics of an element.

      Generally accepted values are "emphasis", "strong", "small", "line-through", "citation", "quote", "definition", "abbreviation", "italic", "bold", "monospaced", "code, "variable", "sample", "keyboard", "superscript", "subscript", "annotation", "highlight", "ruby", "rubyBase", "rubyText", "rubyTextContainer", "rubyParentheses", "bidirectionalIsolation", "bidirectionalOverride", "phrase", "insert", "delete".

      See Also:

    • SECTIONS

      static final String SECTIONS
      Specifies the semantics of an element.

      Generally accepted values are "article", "section", "navigation", "sidebar".

      See Also:

    • VALUE

      static final String VALUE
      Specifies a value for the data element.
      See Also:

    • DATETIME

      static final String DATETIME
      Specifies a machine readable date/time for the time element.
      See Also:

  • Method Details

    • entrySet

      Set<Map.Entry<String,Object>> entrySet()
      Returns a Set view of the attributes in form of Map.Entry items. The set is backed by the underlying map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.
      Returns:
      a set view of the attributes
      Since:
      2.1.0