com.openhtmltopdf.css.newmatch

Class Selector

java.lang.Object

com.openhtmltopdf.css.newmatch.Selector

public class Selector
extends Object

A Selector is really a chain of CSS selectors that all need to be valid for the selector to match.

Author:

Torbjoern Gannholm

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIVE_PSEUDOCLASS
static int	CHILD_AXIS
static int	DESCENDANT_AXIS
static int	FOCUS_PSEUDOCLASS
static int	HOVER_PSEUDOCLASS
static int	IMMEDIATE_SIBLING_AXIS
static int	MARKER_PSEUDOCLASS
static int	VISITED_PSEUDOCLASS

Constructor Summary

Constructors

Constructor and Description
Selector()

Method Summary

Modifier and Type	Method and Description
void	addAttributeEqualsCondition(String namespaceURI, String name, String value) the CSS condition [attribute=value]
void	addAttributeExistsCondition(String namespaceURI, String name) the CSS condition [attribute]
void	addAttributeMatchesFirstPartCondition(String namespaceURI, String name, String value) the CSS condition [attribute|=value]
void	addAttributeMatchesListCondition(String namespaceURI, String name, String value) the CSS condition [attribute~=value]
void	addAttributePrefixCondition(String namespaceURI, String name, String value) the CSS condition [attribute^=value]
void	addAttributeSubstringCondition(String namespaceURI, String name, String value) the CSS condition [attribute*=value]
void	addAttributeSuffixCondition(String namespaceURI, String name, String value) the CSS condition [attribute$=value]
void	addClassCondition(String className) the CSS condition .class
void	addEvenChildCondition() the CSS condition that element has pseudo-class :even
void	addFirstChildCondition() the CSS condition that element has pseudo-class :first-child
void	addIDCondition(String id) the CSS condition #ID
void	addLangCondition(String lang) the CSS condition :lang(Xx)
void	addLastChildCondition() the CSS condition that element has pseudo-class :last-child
void	addLinkCondition() the CSS condition that element has pseudo-class :link
void	addNthChildCondition(String number) the CSS condition that element has pseudo-class :nth-child(an+b)
void	addOddChildCondition() the CSS condition that element has pseudo-class :odd
void	addUnsupportedCondition() for unsupported or invalid CSS
Selector	getAncestorSelector()
int	getAxis() get the axis that this selector should be evaluated on
Selector	getChainedSelector() get the next selector in the chain, for matching against elements along the appropriate axis
String	getPseudoElement() Gets the pseudoElement attribute of the Selector object
Ruleset	getRuleset() get the Ruleset that this Selector is part of
int	getSelectorID()
int	getSpecificityB() The correct specificity value for this selector and its sibling-axis selectors
int	getSpecificityC() The correct specificity value for this selector and its sibling-axis selectors
int	getSpecificityD() The correct specificity value for this selector and its sibling-axis selectors
boolean	isPseudoClass(int pc) query if a pseudoclass must apply for this selector
boolean	matches(Object e, AttributeResolver attRes, TreeResolver treeRes) Check if the given Element matches this selector.
boolean	matchesDynamic(Object e, AttributeResolver attRes, TreeResolver treeRes) Check if the given Element matches this selector's dynamic properties.
void	setAncestorSelector(Selector ancestor)
void	setAxis(int axis)
void	setChainedSelector(Selector selector)
void	setName(String name)
void	setNamespaceURI(String namespaceURI)
void	setParent(Ruleset ruleset)
void	setPos(int pos)
void	setPseudoClass(int pc) set which pseudoclasses must apply for this selector
void	setPseudoElement(String pseudoElement) check if selector queries for dynamic properties
void	setSiblingSelector(Selector selector)
void	setSpecificityB(int b)
void	setSpecificityC(int c)
void	setSpecificityD(int d)
void	toCSS(StringBuilder sb, Set<Selector> stopAt) Prints the selector chain to a StringBuilder, stopping when it hits a selector in the stopAt set.
String	toString() For debugging, prints the entire selector chain.

Methods inherited from class java.lang.Object

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

Field Detail

DESCENDANT_AXIS

public static final int DESCENDANT_AXIS

See Also:

Constant Field Values

CHILD_AXIS

public static final int CHILD_AXIS

See Also:

Constant Field Values

IMMEDIATE_SIBLING_AXIS

public static final int IMMEDIATE_SIBLING_AXIS

See Also:

Constant Field Values

VISITED_PSEUDOCLASS

public static final int VISITED_PSEUDOCLASS

See Also:

Constant Field Values

HOVER_PSEUDOCLASS

public static final int HOVER_PSEUDOCLASS

See Also:

Constant Field Values

ACTIVE_PSEUDOCLASS

public static final int ACTIVE_PSEUDOCLASS

See Also:

Constant Field Values

FOCUS_PSEUDOCLASS

public static final int FOCUS_PSEUDOCLASS

See Also:

Constant Field Values

MARKER_PSEUDOCLASS

public static final int MARKER_PSEUDOCLASS

See Also:

Constant Field Values

Constructor Detail

Selector

public Selector()

Method Detail

matches

public boolean matches(Object e,
                       AttributeResolver attRes,
                       TreeResolver treeRes)

Check if the given Element matches this selector. Note: the parser should give all class

matchesDynamic

public boolean matchesDynamic(Object e,
                              AttributeResolver attRes,
                              TreeResolver treeRes)

Check if the given Element matches this selector's dynamic properties. Note: the parser should give all class

addUnsupportedCondition

public void addUnsupportedCondition()

for unsupported or invalid CSS

addLinkCondition

public void addLinkCondition()

the CSS condition that element has pseudo-class :link

addFirstChildCondition

public void addFirstChildCondition()

the CSS condition that element has pseudo-class :first-child

addLastChildCondition

public void addLastChildCondition()

the CSS condition that element has pseudo-class :last-child

addNthChildCondition

public void addNthChildCondition(String number)

the CSS condition that element has pseudo-class :nth-child(an+b)

addEvenChildCondition

public void addEvenChildCondition()

the CSS condition that element has pseudo-class :even

addOddChildCondition

public void addOddChildCondition()

the CSS condition that element has pseudo-class :odd

addLangCondition

public void addLangCondition(String lang)

the CSS condition :lang(Xx)

addIDCondition

public void addIDCondition(String id)

the CSS condition #ID

addClassCondition

public void addClassCondition(String className)

the CSS condition .class

addAttributeExistsCondition

public void addAttributeExistsCondition(String namespaceURI,
                                        String name)

the CSS condition [attribute]

addAttributeEqualsCondition

public void addAttributeEqualsCondition(String namespaceURI,
                                        String name,
                                        String value)

the CSS condition [attribute=value]

addAttributePrefixCondition

public void addAttributePrefixCondition(String namespaceURI,
                                        String name,
                                        String value)

the CSS condition [attribute^=value]

addAttributeSuffixCondition

public void addAttributeSuffixCondition(String namespaceURI,
                                        String name,
                                        String value)

the CSS condition [attribute$=value]

addAttributeSubstringCondition

public void addAttributeSubstringCondition(String namespaceURI,
                                           String name,
                                           String value)

the CSS condition [attribute*=value]

addAttributeMatchesListCondition

public void addAttributeMatchesListCondition(String namespaceURI,
                                             String name,
                                             String value)

the CSS condition [attribute~=value]

addAttributeMatchesFirstPartCondition

public void addAttributeMatchesFirstPartCondition(String namespaceURI,
                                                  String name,
                                                  String value)

the CSS condition [attribute|=value]

setPseudoClass

public void setPseudoClass(int pc)

set which pseudoclasses must apply for this selector

Parameters:

pc - the values from AttributeResolver should be used. Once set they cannot be unset. Note that the pseudo-classes should be set one at a time, otherwise specificity of declaration becomes wrong.

setPseudoElement

public void setPseudoElement(String pseudoElement)

check if selector queries for dynamic properties

Parameters:

pseudoElement - The new pseudoElement value

isPseudoClass

public boolean isPseudoClass(int pc)

query if a pseudoclass must apply for this selector

Parameters:

pc - the values from AttributeResolver should be used.

Returns:

The pseudoClass value

getPseudoElement

public String getPseudoElement()

Gets the pseudoElement attribute of the Selector object

Returns:

The pseudoElement value

getChainedSelector

public Selector getChainedSelector()

get the next selector in the chain, for matching against elements along the appropriate axis

Returns:

The chainedSelector value

getRuleset

public Ruleset getRuleset()

get the Ruleset that this Selector is part of

Returns:

The ruleset value

getAxis

public int getAxis()

get the axis that this selector should be evaluated on

Returns:

The axis value

getSpecificityB

public int getSpecificityB()

The correct specificity value for this selector and its sibling-axis selectors

getSpecificityD

public int getSpecificityD()

The correct specificity value for this selector and its sibling-axis selectors

getSpecificityC

public int getSpecificityC()

The correct specificity value for this selector and its sibling-axis selectors

toCSS

public void toCSS(StringBuilder sb,
                  Set<Selector> stopAt)

Prints the selector chain to a StringBuilder, stopping when it hits a selector in the stopAt set. For example, given the selector 'body svg rect' and the stop set contains 'svg' then this will print 'rect' to the builder. This method is used to recreate CSS selectors to pass to SVG or other plugins. FIXME: Does not handle sibling selector.

getSelectorID

public int getSelectorID()

setName

public void setName(String name)

setPos

public void setPos(int pos)

setParent

public void setParent(Ruleset ruleset)

setAxis

public void setAxis(int axis)

setSpecificityB

public void setSpecificityB(int b)

setSpecificityC

public void setSpecificityC(int c)

setSpecificityD

public void setSpecificityD(int d)

setChainedSelector

public void setChainedSelector(Selector selector)

setSiblingSelector

public void setSiblingSelector(Selector selector)

setNamespaceURI

public void setNamespaceURI(String namespaceURI)

setAncestorSelector

public void setAncestorSelector(Selector ancestor)

getAncestorSelector

public Selector getAncestorSelector()

toString

public String toString()

For debugging, prints the entire selector chain. FIXME: Does not handle sibling selectors.

Overrides:

toString in class Object