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
    Author:
    ltheussl
    • Field Detail

      • 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:
        Constant Field Values
      • PROFILE

        static final String PROFILE
        A space separated list of URL's that contains meta data information about the document.
        See Also:
        Constant Field Values
      • 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:
        Constant Field Values
      • HSPACE

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

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

        static final String CHARSET
        Specifies the character encoding of text associated with an event element.
        See Also:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • 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:
        Constant Field Values
      • TARGET

        static final String TARGET
        Where to open the target URL.

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

        See Also:
        Constant Field Values
      • TYPE

        static final String TYPE
        Specifies the MIME (Multipurpose Internet Mail Extensions) type of an external resource URL, eg a link.
        See Also:
        Constant Field Values
      • 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:
        Constant Field Values
      • RULES

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

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

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

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

        static final String NOWRAP
        Whether to disable or enable automatic text wrapping for an element.
        See Also:
        Constant Field Values
      • ROWSPAN

        static final String ROWSPAN
        Indicates the number of rows a cell should span. Used in tables.
        See Also:
        Constant Field Values
      • 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:
        Constant Field Values
      • VALIGN

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

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

        See Also:
        Constant Field Values
      • DECORATION

        static final String DECORATION
        Specifies a decoration for an element.

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

        See Also:
        Constant Field Values
      • 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:
        Constant Field Values
      • SECTIONS

        static final String SECTIONS
        Specifies the semantics of an element.

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

        See Also:
        Constant Field Values