Interface SinkEventAttributes
- All Superinterfaces:
AttributeSet
,MutableAttributeSet
- All Known Implementing Classes:
SinkEventAttributeSet
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
-
Nested Class Summary
Nested classes/interfaces inherited from interface javax.swing.text.AttributeSet
AttributeSet.CharacterAttribute, AttributeSet.ColorAttribute, AttributeSet.FontAttribute, AttributeSet.ParagraphAttribute
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Specifies an abbreviated version of the content in an element.static final String
Specifies the alignment of the event element within its parent element.static final String
Defines a short description of the event element.static final String
Defines a name for a cell.static final String
Specifies the background color of an event element.static final String
Defines a border around an event element.static final String
Specifies the space between cell walls and contents.static final String
Specifies the space between cells.static final String
Specifies the character encoding of text associated with an event element.static final String
The class of the event element.static final String
Indicates the number of columns a cell should span.static final String
May be used in conjunction withSHAPE
.static final String
Specifies a machine readable date/time for the time element.static final String
Specifies a decoration for an element.static final String
An electronic mail address.static final String
Specifies which sides of a border surrounding an element should be visible.static final String
A space-separated list of cell IDs that supply header information for the cell.static final String
Defines the height of an event element.static final String
The target URL of an event element, eg a link.static final String
Specifies the base language of the target URL.static final String
Defines white space on the left and right side of an event element.static final String
A unique id for the event element.static final String
Defines an image as a server-side image map.static final String
The language code for the event element.static final String
Specifies the name of an anchor.static final String
Used to indicate that an element comes with a shadow.static final String
Whether to disable or enable automatic text wrapping for an element.static final String
A space separated list of URL's that contains meta data information about the document.static final String
For references to external resourcs, specifies the relationship between the current document and the target URL.static final String
For references to external resourcs, specifies the relationship between the target URL and the current document.static final String
Indicates the number of rows a cell should span.static final String
Specifies horizontal/vertical divider lines between certain elements, eg table cells.static final String
A general scope parameter.static final String
Specifies the semantics of an element.static final String
Specifies the semantics of an element.static final String
Defines the type of region to be defined for a mapping.static final String
Specifies the size, or thickness, or height of an event element.static final String
The URL of an external resource, eg an image.static final String
An inline style definition.static final String
Specifies a summary of an event attribute for speech-synthesizing/non-visual target output.static final String
Where to open the target URL.static final String
A text to display in a tool tip.static final String
Specifies the MIME (Multipurpose Internet Mail Extensions) type of an external resource URL, eg a link.static final String
Defines an image as a client-side image map.static final String
Specifies the vertical alignment of an element.static final String
Specifies a value for the data element.static final String
Defines white space on the top and bottom of the event element.static final String
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 Details
-
CLASS
The class of the event element.- See Also:
-
ID
A unique id for the event element.- See Also:
-
LANG
The language code for the event element.- See Also:
-
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
, where the value of the SinkEventAttribute is an AttributeSet with two Attributes ("Sink.paragraph(SinkEventAttributes)
color
" and "margin-left
" with values "red
" and "20px
", respectively).- See Also:
-
TITLE
A text to display in a tool tip.- See Also:
-
PROFILE
A space separated list of URL's that contains meta data information about the document.- See Also:
-
EMAIL
An electronic mail address.- See Also:
-
ALIGN
Specifies the alignment of the event element within its parent element.Generally supported values are "left", "right", "center", "justify".
- See Also:
-
ALT
Defines a short description of the event element.- See Also:
-
BORDER
Defines a border around an event element.- See Also:
-
HEIGHT
Defines the height of an event element.- See Also:
-
HSPACE
Defines white space on the left and right side of an event element.- See Also:
-
ISMAP
Defines an image as a server-side image map. Only used by the figureGraphics Sink event.- See Also:
-
SRC
The URL of an external resource, eg an image.- See Also:
-
USEMAP
Defines an image as a client-side image map.- See Also:
-
VSPACE
Defines white space on the top and bottom of the event element.- See Also:
-
WIDTH
Sets the width of an event element.- See Also:
-
NOSHADE
Used to indicate that an element comes with a shadow.- See Also:
-
SIZE
Specifies the size, or thickness, or height of an event element.- See Also:
-
NAME
Specifies the name of an anchor.- See Also:
-
CHARSET
Specifies the character encoding of text associated with an event element.- See Also:
-
COORDS
May be used in conjunction withSHAPE
.Valid values are the same as for the corresponding HTML attributes.
- See Also:
-
HREF
The target URL of an event element, eg a link.- See Also:
-
HREFLANG
Specifies the base language of the target URL.Used in conjunction with
HREF
.- See Also:
-
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
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
Defines the type of region to be defined for a mapping.Used with the
COORDS
attribute.- See Also:
-
TARGET
Where to open the target URL.Valid values are the same as for the corresponding HTML attribute.
- See Also:
-
TYPE
Specifies the MIME (Multipurpose Internet Mail Extensions) type of an external resource URL, eg a link.- See Also:
-
BGCOLOR
Specifies the background color of an event element.- See Also:
-
CELLPADDING
Specifies the space between cell walls and contents.- See Also:
-
CELLSPACING
Specifies the space between cells.- See Also:
-
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
Specifies horizontal/vertical divider lines between certain elements, eg table cells.- See Also:
-
SUMMARY
Specifies a summary of an event attribute for speech-synthesizing/non-visual target output.- See Also:
-
ABBRV
Specifies an abbreviated version of the content in an element.- See Also:
-
AXIS
Defines a name for a cell.- See Also:
-
COLSPAN
Indicates the number of columns a cell should span. Used in tables.- See Also:
-
HEADERS
A space-separated list of cell IDs that supply header information for the cell.- See Also:
-
NOWRAP
Whether to disable or enable automatic text wrapping for an element.- See Also:
-
ROWSPAN
Indicates the number of rows a cell should span. Used in tables.- See Also:
-
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
Specifies the vertical alignment of an element.Generally accepted values are "top", "baseline", "middle", "bottom", "sup", "sub".
- See Also:
-
DECORATION
Specifies a decoration for an element.Generally accepted values are "underline", "overline", "line-through", "boxed".
- See Also:
-
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
Specifies the semantics of an element.Generally accepted values are "article", "section", "navigation", "sidebar".
- See Also:
-
VALUE
Specifies a value for the data element.- See Also:
-
DATETIME
Specifies a machine readable date/time for the time element.- See Also:
-