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
andTITLE
.- Since:
- 1.1
- Author:
- ltheussl
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface javax.swing.text.AttributeSet
AttributeSet.CharacterAttribute, AttributeSet.ColorAttribute, AttributeSet.FontAttribute, AttributeSet.ParagraphAttribute
-
-
Field Summary
Fields Modifier and Type Field Description static String
ABBRV
Specifies an abbreviated version of the content in an element.static String
ALIGN
Specifies the alignment of the event element within its parent element.static String
ALT
Defines a short description of the event element.static String
AXIS
Defines a name for a cell.static String
BGCOLOR
Specifies the background color of an event element.static String
BORDER
Defines a border around an event element.static String
CELLPADDING
Specifies the space between cell walls and contents.static String
CELLSPACING
Specifies the space between cells.static String
CHARSET
Specifies the character encoding of text associated with an event element.static String
CLASS
The class of the event element.static String
COLSPAN
Indicates the number of columns a cell should span.static String
COORDS
May be used in conjunction withSHAPE
.static String
DATETIME
Specifies a machine readable date/time for the time element.static String
DECORATION
Specifies a decoration for an element.static String
EMAIL
An electronic mail address.static String
FRAME
Specifies which sides of a border surrounding an element should be visible.static String
HEADERS
A space-separated list of cell IDs that supply header information for the cell.static String
HEIGHT
Defines the height of an event element.static String
HREF
The target URL of an event element, eg a link.static String
HREFLANG
Specifies the base language of the target URL.static String
HSPACE
Defines white space on the left and right side of an event element.static String
ID
A unique id for the event element.static String
ISMAP
Defines an image as a server-side image map.static String
LANG
The language code for the event element.static String
NAME
Specifies the name of an anchor.static String
NOSHADE
Used to indicate that an element comes with a shadow.static String
NOWRAP
Whether to disable or enable automatic text wrapping for an element.static String
PROFILE
A space separated list of URL's that contains meta data information about the document.static String
REL
For references to external resourcs, specifies the relationship between the current document and the target URL.static String
REV
For references to external resourcs, specifies the relationship between the target URL and the current document.static String
ROWSPAN
Indicates the number of rows a cell should span.static String
RULES
Specifies horizontal/vertical divider lines between certain elements, eg table cells.static String
SCOPE
A general scope parameter.static String
SECTIONS
Specifies the semantics of an element.static String
SEMANTICS
Specifies the semantics of an element.static String
SHAPE
Defines the type of region to be defined for a mapping.static String
SIZE
Specifies the size, or thickness, or height of an event element.static String
SRC
The URL of an external resource, eg an image.static String
STYLE
An inline style definition.static String
SUMMARY
Specifies a summary of an event attribute for speech-synthesizing/non-visual target output.static String
TARGET
Where to open the target URL.static String
TITLE
A text to display in a tool tip.static String
TYPE
Specifies the MIME (Multipurpose Internet Mail Extensions) type of an external resource URL, eg a link.static String
USEMAP
Defines an image as a client-side image map.static String
VALIGN
Specifies the vertical alignment of an element.static String
VALUE
Specifies a value for the data element.static String
VSPACE
Defines white space on the top and bottom of the event element.static 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 String CLASS
The class of the event element.- See Also:
- Constant Field Values
-
ID
static final String ID
A unique id for the event element.- See Also:
- Constant Field Values
-
LANG
static final String LANG
The language code for the event element.- See Also:
- Constant Field Values
-
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
, 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:
- Constant Field Values
-
TITLE
static final String TITLE
A text to display in a tool tip.- 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
-
EMAIL
static final String EMAIL
An electronic mail address.- 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
-
ALT
static final String ALT
Defines a short description of the event element.- See Also:
- Constant Field Values
-
BORDER
static final String BORDER
Defines a border around an event element.- See Also:
- Constant Field Values
-
HEIGHT
static final String HEIGHT
Defines the height of an event element.- 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
-
SRC
static final String SRC
The URL of an external resource, eg an image.- See Also:
- Constant Field Values
-
USEMAP
static final String USEMAP
Defines an image as a client-side image map.- See Also:
- Constant Field Values
-
VSPACE
static final String VSPACE
Defines white space on the top and bottom of the event element.- See Also:
- Constant Field Values
-
WIDTH
static final String WIDTH
Sets the width of an event element.- See Also:
- Constant Field Values
-
NOSHADE
static final String NOSHADE
Used to indicate that an element comes with a shadow.- See Also:
- Constant Field Values
-
SIZE
static final String SIZE
Specifies the size, or thickness, or height of an event element.- See Also:
- Constant Field Values
-
NAME
static final String NAME
Specifies the name of an anchor.- 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 withSHAPE
.Valid values are the same as for the corresponding HTML attributes.
- See Also:
- Constant Field Values
-
HREF
static final String HREF
The target URL of an event element, eg a link.- See Also:
- Constant Field Values
-
HREFLANG
static final String HREFLANG
Specifies the base language of the target URL.Used in conjunction with
HREF
.- 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
-
SHAPE
static final 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 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
-
BGCOLOR
static final String BGCOLOR
Specifies the background color of an event element.- See Also:
- Constant Field Values
-
CELLPADDING
static final String CELLPADDING
Specifies the space between cell walls and contents.- See Also:
- Constant Field Values
-
CELLSPACING
static final String CELLSPACING
Specifies the space between cells.- 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
-
ABBRV
static final String ABBRV
Specifies an abbreviated version of the content in an element.- See Also:
- Constant Field Values
-
AXIS
static final String AXIS
Defines a name for a cell.- 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
-
VALUE
static final String VALUE
Specifies a value for the data element.- See Also:
- Constant Field Values
-
DATETIME
static final String DATETIME
Specifies a machine readable date/time for the time element.- See Also:
- Constant Field Values
-
-