Package com.openhtmltopdf.css.newmatch

Class CascadedStyle

java.lang.Object

com.openhtmltopdf.css.newmatch.CascadedStyle

public class CascadedStyle
extends java.lang.Object

Holds a set of PropertyDeclarations for each unique CSS property name. What properties belong in the set is not determined, except that multiple entries are resolved into a single set using cascading rules. The set is cascaded during instantiation, so once you have a CascadedStyle, the PropertyDeclarations you retrieve from it will have been resolved following the CSS cascading rules. Note that this class knows nothing about CSS selector-matching rules. Before creating a CascadedStyle, you will need to determine which PropertyDeclarations belong in the set--for example, by matching Rulesets to Document Elements via their selectors. You can get individual properties by using propertyByName(CSSName) or an Iterator of properties with getCascadedPropertyDeclarations(). Check for individual property assignments using hasProperty(CSSName). A CascadedStyle is immutable, as properties can not be added or removed from it once instantiated.

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Map<CSSName,PropertyDeclaration>	cascadedProperties	Map of PropertyDeclarations, keyed by CSSName
static CascadedStyle	emptyCascadedStyle	Get an empty singleton, used to negate inheritance of properties
private java.lang.String	fingerprint

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CascadedStyle()	Default constructor with no initialization.
private	CascadedStyle(CascadedStyle startingPoint, java.util.Iterator<PropertyDeclaration> props)
(package private)	CascadedStyle(java.util.Iterator<PropertyDeclaration> iter)	Constructs a new CascadedStyle, given an Iterator of PropertyDeclarations already sorted by specificity of the CSS selector they came from.

Method Summary

Modifier and Type	Method	Description
private void	addProperties(java.util.Iterator<PropertyDeclaration> iter)
int	countAssigned()
static CascadedStyle	createAnonymousStyle(IdentValue display)	Creates an otherwise empty CascadedStyle, setting the display property to the value of the display parameter.
static PropertyDeclaration	createLayoutPropertyDeclaration(CSSName cssName, IdentValue display)	Creates a PropertyDeclaration suitable for passing to createLayoutStyle(PropertyDeclaration[]) or createLayoutStyle(CascadedStyle, PropertyDeclaration[])
static CascadedStyle	createLayoutStyle(CascadedStyle startingPoint, PropertyDeclaration[] decls)	Creates a CascadedStyle using style information from startingPoint and then adding the property declarations from decls.
static CascadedStyle	createLayoutStyle(PropertyDeclaration[] decls)	Creates a CascadedStyle using the provided property declarations.
static CascadedStyle	createLayoutStyle(java.util.List<PropertyDeclaration> decls)
java.util.Collection<PropertyDeclaration>	getCascadedPropertyDeclarations()	Returns an Iterator over the set of PropertyDeclarations already matched in this CascadedStyle.
java.lang.String	getFingerprint()
IdentValue	getIdent(CSSName cssName)	Gets the ident attribute of the CascadedStyle object
boolean	hasProperty(CSSName cssName)	Returns true if property has been defined in this style.
PropertyDeclaration	propertyByName(CSSName cssName)	Returns a PropertyDeclaration by CSS property name, e.g.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cascadedProperties

private final java.util.Map<CSSName,PropertyDeclaration> cascadedProperties

Map of PropertyDeclarations, keyed by CSSName

fingerprint

private java.lang.String fingerprint

emptyCascadedStyle

public static final CascadedStyle emptyCascadedStyle

Get an empty singleton, used to negate inheritance of properties

Constructor Detail

CascadedStyle

CascadedStyle(java.util.Iterator<PropertyDeclaration> iter)

Constructs a new CascadedStyle, given an Iterator of PropertyDeclarations already sorted by specificity of the CSS selector they came from. The Iterator can have multiple PropertyDeclarations with the same name; the property cascade will be resolved during instantiation, resulting in a set of PropertyDeclarations. Once instantiated, properties may be retrieved using the normal API for the class.

Parameters:

iter - An Iterator containing PropertyDeclarations in order of specificity.

CascadedStyle

private CascadedStyle(CascadedStyle startingPoint,
                      java.util.Iterator<PropertyDeclaration> props)

CascadedStyle

private CascadedStyle()

Default constructor with no initialization. Don't use this to instantiate the class, as the class is immutable and this will leave it without any properties.

Method Detail

createLayoutStyle

public static CascadedStyle createLayoutStyle(PropertyDeclaration[] decls)

Creates a CascadedStyle using the provided property declarations. It is used when a box requires a style that does not correspond to anything in the parsed stylesheets.

Parameters:

decls - An array of PropertyDeclaration objects created with createLayoutPropertyDeclaration(CSSName, IdentValue)

See Also:

createLayoutPropertyDeclaration(CSSName, IdentValue)

createLayoutStyle

public static CascadedStyle createLayoutStyle(java.util.List<PropertyDeclaration> decls)

createLayoutStyle

public static CascadedStyle createLayoutStyle(CascadedStyle startingPoint,
                                              PropertyDeclaration[] decls)

Creates a CascadedStyle using style information from startingPoint and then adding the property declarations from decls.

Parameters:

decls - An array of PropertyDeclaration objects created with createLayoutPropertyDeclaration(CSSName, IdentValue)

See Also:

createLayoutPropertyDeclaration(CSSName, IdentValue)

createLayoutPropertyDeclaration

public static PropertyDeclaration createLayoutPropertyDeclaration(CSSName cssName,
                                                                  IdentValue display)

Creates a PropertyDeclaration suitable for passing to createLayoutStyle(PropertyDeclaration[]) or createLayoutStyle(CascadedStyle, PropertyDeclaration[])

createAnonymousStyle

public static CascadedStyle createAnonymousStyle(IdentValue display)

Creates an otherwise empty CascadedStyle, setting the display property to the value of the display parameter.

addProperties

private void addProperties(java.util.Iterator<PropertyDeclaration> iter)

hasProperty

public boolean hasProperty(CSSName cssName)

Returns true if property has been defined in this style.

Parameters:

cssName - The CSS property name, e.g. "font-family".

Returns:

True if the property is defined in this set.

propertyByName

public PropertyDeclaration propertyByName(CSSName cssName)

Returns a PropertyDeclaration by CSS property name, e.g. "font-family". Properties are already cascaded during instantiation, so this will return the actual property (and corresponding value) to use for CSS-based layout and rendering.

Parameters:

cssName - The CSS property name, e.g. "font-family".

Returns:

The PropertyDeclaration, if declared in this set, or null if not found.

getIdent

public IdentValue getIdent(CSSName cssName)

Gets the ident attribute of the CascadedStyle object

Parameters:

cssName - PARAM

Returns:

The ident value

getCascadedPropertyDeclarations

public java.util.Collection<PropertyDeclaration> getCascadedPropertyDeclarations()

Returns an Iterator over the set of PropertyDeclarations already matched in this CascadedStyle. For a given property name, there may be no match, in which case there will be no PropertyDeclaration for that property name in the Iterator.

Returns:

Iterator over a set of properly cascaded PropertyDeclarations.

countAssigned

public int countAssigned()

getFingerprint

public java.lang.String getFingerprint()