SinkEventAttributes

All Superinterfaces:

javax.swing.text.AttributeSet, javax.swing.text.MutableAttributeSet
```
public interface SinkEventAttributes
extends javax.swing.text.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

Version:

$Id: SinkEventAttributes.java 1633964 2014-10-23 22:01:01Z hboutemy $

Author:

ltheussl

Nested Class Summary
- Nested classes/interfaces inherited from interface javax.swing.text.AttributeSet
  javax.swing.text.AttributeSet.CharacterAttribute, javax.swing.text.AttributeSet.ColorAttribute, javax.swing.text.AttributeSet.FontAttribute, javax.swing.text.AttributeSet.ParagraphAttribute

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`ABBRV`	Specifies an abbreviated version of the content in an element.
`static java.lang.String`	`ALIGN`	Specifies the alignment of the event element within its parent element.
`static java.lang.String`	`ALT`	Defines a short description of the event element.
`static java.lang.String`	`AXIS`	Defines a name for a cell.
`static java.lang.String`	`BGCOLOR`	Specifies the background color of an event element.
`static java.lang.String`	`BORDER`	Defines a border around an event element.
`static java.lang.String`	`CELLPADDING`	Specifies the space between cell walls and contents.
`static java.lang.String`	`CELLSPACING`	Specifies the space between cells.
`static java.lang.String`	`CHARSET`	Specifies the character encoding of text associated with an event element.
`static java.lang.String`	`CLASS`	The class of the event element.
`static java.lang.String`	`COLSPAN`	Indicates the number of columns a cell should span.
`static java.lang.String`	`COORDS`	May be used in conjunction with `SHAPE`.
`static java.lang.String`	`DECORATION`	Specifies a decoration for an element.
`static java.lang.String`	`EMAIL`	An electronic mail address.
`static java.lang.String`	`FRAME`	Specifies which sides of a border surrounding an element should be visible.
`static java.lang.String`	`HEADERS`	A space-separated list of cell IDs that supply header information for the cell.
`static java.lang.String`	`HEIGHT`	Defines the height of an event element.
`static java.lang.String`	`HREF`	The target URL of an event element, eg a link.
`static java.lang.String`	`HREFLANG`	Specifies the base language of the target URL.
`static java.lang.String`	`HSPACE`	Defines white space on the left and right side of an event element.
`static java.lang.String`	`ID`	A unique id for the event element.
`static java.lang.String`	`ISMAP`	Defines an image as a server-side image map.
`static java.lang.String`	`LANG`	The language code for the event element.
`static java.lang.String`	`NAME`	Specifies the name of an anchor.
`static java.lang.String`	`NOSHADE`	Used to indicate that an element comes with a shadow.
`static java.lang.String`	`NOWRAP`	Whether to disable or enable automatic text wrapping for an element.
`static java.lang.String`	`PROFILE`	A space separated list of URL's that contains meta data information about the document.
`static java.lang.String`	`REL`	For references to external resourcs, specifies the relationship between the current document and the target URL.
`static java.lang.String`	`REV`	For references to external resourcs, specifies the relationship between the target URL and the current document.
`static java.lang.String`	`ROWSPAN`	Indicates the number of rows a cell should span.
`static java.lang.String`	`RULES`	Specifies horizontal/vertical divider lines between certain elements, eg table cells.
`static java.lang.String`	`SCOPE`	A general scope parameter.
`static java.lang.String`	`SHAPE`	Defines the type of region to be defined for a mapping.
`static java.lang.String`	`SIZE`	Specifies the size, or thickness, or height of an event element.
`static java.lang.String`	`SRC`	The URL of an external resource, eg an image.
`static java.lang.String`	`STYLE`	An inline style definition.
`static java.lang.String`	`SUMMARY`	Specifies a summary of an event attribute for speech-synthesizing/non-visual target output.
`static java.lang.String`	`TARGET`	Where to open the target URL.
`static java.lang.String`	`TITLE`	A text to display in a tool tip.
`static java.lang.String`	`TYPE`	Specifies the MIME (Multipurpose Internet Mail Extensions) type of an external resource URL, eg a link.
`static java.lang.String`	`USEMAP`	Defines an image as a client-side image map.
`static java.lang.String`	`VALIGN`	Specifies the vertical alignment of an element.
`static java.lang.String`	`VSPACE`	Defines white space on the top and bottom of the event element.
`static java.lang.String`	`WIDTH`	Sets the width of an event element.

Fields inherited from interface javax.swing.text.AttributeSet
NameAttribute, ResolveAttribute

Method Summary
- Methods inherited from interface javax.swing.text.AttributeSet
  containsAttribute, containsAttributes, copyAttributes, getAttribute, getAttributeCount, getAttributeNames, getResolveParent, isDefined, isEqual
- Methods inherited from interface javax.swing.text.MutableAttributeSet
  addAttribute, addAttributes, removeAttribute, removeAttributes, removeAttributes, setResolveParent

- Field Detail
  - CLASS
```
static final java.lang.String CLASS
```
    The class of the event element.
    
    See Also:
    
    Constant Field Values
  - ID
```
static final java.lang.String ID
```
    A unique id for the event element.
    
    See Also:
    
    Constant Field Values
  - LANG
```
static final java.lang.String LANG
```
    The language code for the event element.
    
    See Also:
    
    Constant Field Values
  - STYLE
```
static final java.lang.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
  - TITLE
```
static final java.lang.String TITLE
```
    A text to display in a tool tip.
    
    See Also:
    
    Constant Field Values
  - PROFILE
```
static final java.lang.String PROFILE
```
    A space separated list of URL's that contains meta data information about the document.
    
    See Also:
    
    Constant Field Values
  - EMAIL
```
static final java.lang.String EMAIL
```
    An electronic mail address.
    
    See Also:
    
    Constant Field Values
  - ALIGN
```
static final java.lang.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
  - ALT
```
static final java.lang.String ALT
```
    Defines a short description of the event element.
    
    See Also:
    
    Constant Field Values
  - BORDER
```
static final java.lang.String BORDER
```
    Defines a border around an event element.
    
    See Also:
    
    Constant Field Values
  - HEIGHT
```
static final java.lang.String HEIGHT
```
    Defines the height of an event element.
    
    See Also:
    
    Constant Field Values
  - HSPACE
```
static final java.lang.String HSPACE
```
    Defines white space on the left and right side of an event element.
    
    See Also:
    
    Constant Field Values
  - ISMAP
```
static final java.lang.String ISMAP
```
    Defines an image as a server-side image map. Only used by the figureGraphics Sink event.
    
    See Also:
    
    Constant Field Values
  - SRC
```
static final java.lang.String SRC
```
    The URL of an external resource, eg an image.
    
    See Also:
    
    Constant Field Values
  - USEMAP
```
static final java.lang.String USEMAP
```
    Defines an image as a client-side image map.
    
    See Also:
    
    Constant Field Values
  - VSPACE
```
static final java.lang.String VSPACE
```
    Defines white space on the top and bottom of the event element.
    
    See Also:
    
    Constant Field Values
  - WIDTH
```
static final java.lang.String WIDTH
```
    Sets the width of an event element.
    
    See Also:
    
    Constant Field Values
  - NOSHADE
```
static final java.lang.String NOSHADE
```
    Used to indicate that an element comes with a shadow.
    
    See Also:
    
    Constant Field Values
  - SIZE
```
static final java.lang.String SIZE
```
    Specifies the size, or thickness, or height of an event element.
    
    See Also:
    
    Constant Field Values
  - NAME
```
static final java.lang.String NAME
```
    Specifies the name of an anchor.
    
    See Also:
    
    Constant Field Values
  - CHARSET
```
static final java.lang.String CHARSET
```
    Specifies the character encoding of text associated with an event element.
    
    See Also:
    
    Constant Field Values
  - COORDS
```
static final java.lang.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
  - HREF
```
static final java.lang.String HREF
```
    The target URL of an event element, eg a link.
    
    See Also:
    
    Constant Field Values
  - HREFLANG
```
static final java.lang.String HREFLANG
```
    Specifies the base language of the target URL.
    Used in conjunction with HREF.
    
    See Also:
    
    Constant Field Values
  - REL
```
static final java.lang.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 java.lang.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
  - SHAPE
```
static final java.lang.String SHAPE
```
    Defines the type of region to be defined for a mapping.
    Used with the COORDS attribute.
    
    See Also:
    
    Constant Field Values
  - TARGET
```
static final java.lang.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 java.lang.String TYPE
```
    Specifies the MIME (Multipurpose Internet Mail Extensions) type of an external resource URL, eg a link.
    
    See Also:
    
    Constant Field Values
  - BGCOLOR
```
static final java.lang.String BGCOLOR
```
    Specifies the background color of an event element.
    
    See Also:
    
    Constant Field Values
  - CELLPADDING
```
static final java.lang.String CELLPADDING
```
    Specifies the space between cell walls and contents.
    
    See Also:
    
    Constant Field Values
  - CELLSPACING
```
static final java.lang.String CELLSPACING
```
    Specifies the space between cells.
    
    See Also:
    
    Constant Field Values
  - FRAME
```
static final java.lang.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 java.lang.String RULES
```
    Specifies horizontal/vertical divider lines between certain elements, eg table cells.
    
    See Also:
    
    Constant Field Values
  - SUMMARY
```
static final java.lang.String SUMMARY
```
    Specifies a summary of an event attribute for speech-synthesizing/non-visual target output.
    
    See Also:
    
    Constant Field Values
  - ABBRV
```
static final java.lang.String ABBRV
```
    Specifies an abbreviated version of the content in an element.
    
    See Also:
    
    Constant Field Values
  - AXIS
```
static final java.lang.String AXIS
```
    Defines a name for a cell.
    
    See Also:
    
    Constant Field Values
  - COLSPAN
```
static final java.lang.String COLSPAN
```
    Indicates the number of columns a cell should span. Used in tables.
    
    See Also:
    
    Constant Field Values
  - HEADERS
```
static final java.lang.String HEADERS
```
    A space-separated list of cell IDs that supply header information for the cell.
    
    See Also:
    
    Constant Field Values
  - NOWRAP
```
static final java.lang.String NOWRAP
```
    Whether to disable or enable automatic text wrapping for an element.
    
    See Also:
    
    Constant Field Values
  - ROWSPAN
```
static final java.lang.String ROWSPAN
```
    Indicates the number of rows a cell should span. Used in tables.
    
    See Also:
    
    Constant Field Values
  - SCOPE
```
static final java.lang.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 java.lang.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 java.lang.String DECORATION
```
    Specifies a decoration for an element.
    Generally accepted values are "underline", "overline", "line-through", "boxed".
    
    See Also:
    
    Constant Field Values

Interface SinkEventAttributes

Nested Class Summary

Nested classes/interfaces inherited from interface javax.swing.text.AttributeSet

Field Summary

Fields inherited from interface javax.swing.text.AttributeSet

Method Summary

Methods inherited from interface javax.swing.text.AttributeSet

Methods inherited from interface javax.swing.text.MutableAttributeSet

Field Detail

CLASS

ID

LANG

STYLE

TITLE

PROFILE

EMAIL

ALIGN

ALT

BORDER

HEIGHT

HSPACE

ISMAP

SRC

USEMAP

VSPACE

WIDTH

NOSHADE

SIZE

NAME

CHARSET

COORDS

HREF

HREFLANG

REL

REV

SHAPE

TARGET

TYPE

BGCOLOR

CELLPADDING

CELLSPACING

FRAME

RULES

SUMMARY

ABBRV

AXIS

COLSPAN

HEADERS

NOWRAP

ROWSPAN

SCOPE

VALIGN

DECORATION