com.xmlmind.xmledit.stylesheet

Interface StyleSpecs

All Known Implementing Classes:

SimpleCellStyleSpecs, StyleSheet, StyleSpecsBase, StyleSpecsImpl, StyleSpecsImpl, StyleSpecsImpl

public interface StyleSpecs

This interface specifies the basic services provided by a StyleSheet. A StyleSheet can be seen as a collection of StyleSpecs with methods to find which StyleSpec are applicable to an element or to a pseudo-element (:before, :after, :comment, :processing-instruction).

This interface is of course implemented by a StyleSheet but also by custom extension code wishing to specify intrinsic styles to the StyledViewFactory (that is, a kind of partial built-in style sheet for a class of documents). This is for example the case for XHTML (HTML 4) tables and for DocBook (CALS) tables.

See Also:

StyleSpec, StyleSheet, ViewFactoryBase.addIntrinsicStyleSpecs(com.xmlmind.xmledit.stylesheet.StyleSpecs)

Field Summary

Fields

Modifier and Type	Field and Description
static int	AFTER_ELEMENT Index of the StyleSpec of the :after pseudo-element in the StyleSpec array.
static int	AFTER_ELEMENT_MASK Bit set to indicate that a StyleSpec has been found for the :after pseudo-element.
static int	BEFORE_ELEMENT Index of the StyleSpec of the :before pseudo-element in the StyleSpec array.
static int	BEFORE_ELEMENT_MASK Bit set to indicate that a StyleSpec has been found for the :before pseudo-element.
static int	ELEMENT Index of the StyleSpec of the element in the StyleSpec array.
static int	ELEMENT_MASK Bit set to indicate that a StyleSpec has been found for the element.

Method Summary

Modifier and Type	Method and Description
boolean	findStyleSpec(Comment comment, StyleSpec spec) Find a StyleSpec matching the specified comment.
int	findStyleSpec(Element element, StyleSpec[] specs) Find up to 3 StyleSpecs matching the specified element and its :before and :after pseudo-elements if any.
boolean	findStyleSpec(ProcessingInstruction pi, StyleSpec spec) Find a StyleSpec matching the specified processing-instruction.

Field Detail

ELEMENT

static final int ELEMENT

Index of the StyleSpec of the element in the StyleSpec array.

See Also:

findStyleSpec(Element, StyleSpec[]), Constant Field Values

BEFORE_ELEMENT

static final int BEFORE_ELEMENT

Index of the StyleSpec of the :before pseudo-element in the StyleSpec array.

See Also:

findStyleSpec(Element, StyleSpec[]), Constant Field Values

AFTER_ELEMENT

static final int AFTER_ELEMENT

Index of the StyleSpec of the :after pseudo-element in the StyleSpec array.

See Also:

findStyleSpec(Element, StyleSpec[]), Constant Field Values

ELEMENT_MASK

static final int ELEMENT_MASK

Bit set to indicate that a StyleSpec has been found for the element.

See Also:

findStyleSpec(Element, StyleSpec[]), Constant Field Values

BEFORE_ELEMENT_MASK

static final int BEFORE_ELEMENT_MASK

Bit set to indicate that a StyleSpec has been found for the :before pseudo-element.

See Also:

findStyleSpec(Element, StyleSpec[]), Constant Field Values

AFTER_ELEMENT_MASK

static final int AFTER_ELEMENT_MASK

Bit set to indicate that a StyleSpec has been found for the :after pseudo-element.

See Also:

findStyleSpec(Element, StyleSpec[]), Constant Field Values

Method Detail

findStyleSpec

int findStyleSpec(Element element,
                  StyleSpec[] specs)

Find up to 3 StyleSpecs matching the specified element and its :before and :after pseudo-elements if any.

Parameters:

element - element for which StyleSpecs are to be found

specs - array of 3 StyleSpecs created by the caller. This method directly modifies the 3 StyleSpecs contained in this array. For example, this method adds to specs[BEFORE_ELEMENT] all the property values contained in the StyleSpec matching the :before pseudo-element.

Returns:

OR-ed ELEMENT_MASK, BEFORE_ELEMENT_MASK, AFTER_ELEMENT_MASK, specifying which StyleSpecs have been found

findStyleSpec

boolean findStyleSpec(Comment comment,
                      StyleSpec spec)

Find a StyleSpec matching the specified comment.

Parameters:

comment - comment for which a StyleSpec is to be found

spec - StyleSpec created by the caller which is modified by this method. This method adds to spec all the property values contained in the StyleSpec matching comment.

Returns:

true if StyleSpec has been found; false otherwise

findStyleSpec

boolean findStyleSpec(ProcessingInstruction pi,
                      StyleSpec spec)

Find a StyleSpec matching the specified processing-instruction.

Parameters:

pi - processing-instruction for which a StyleSpec is to be found

spec - StyleSpec created by the caller which is modified by this method. This method adds to spec all the property values contained in the StyleSpec matching pi.

Returns:

true if StyleSpec has been found; false otherwise