org.daisy.pipeline.css

Class CounterEvaluator<E>

java.lang.Object

org.daisy.pipeline.css.CounterEvaluator<E>

public abstract class CounterEvaluator<E>
extends Object

Traverses a document while keeping track of counter values and providing the ability to generate counter representations.

Field Summary

Fields

Modifier and Type	Field and Description
protected LinkedList<Map<String,Integer>>	counterValues

Constructor Summary

Constructors

Constructor and Description
CounterEvaluator()

Method Summary

Modifier and Type	Method and Description
void	endElement() This method must be called at the end of every element while traversing the document tree in depth-first order.
int	evaluateCounter(String name) Get the value of the innermost counter in the counter set with the given name, or instaniate a counter with value 0 (see https://www.w3.org/TR/css-lists-3/#counter-functions)
String	evaluateCounter(String name, CounterStyle style, boolean withPrefixAndSuffix) Generate a counter representation of the innermost counter in the counter set with the given name (see https://www.w3.org/TR/css-lists-3/#counter-functions)
String	evaluateCounters(String name, CounterStyle style, String separator) Generate a counter representation of all the counters in the counter set with the given name (see https://www.w3.org/TR/css-lists-3/#counter-functions)
String	generateMarkerContents(E elementStyle) Evaluate marker contents (see https://www.w3.org/TR/css-lists-3/#content-property)
protected abstract Collection<? extends cz.vutbr.web.css.TermPair<String,Integer>>	getCounterIncrement(E elementStyle) Get counter-increment property.
protected abstract Collection<? extends cz.vutbr.web.css.TermPair<String,Integer>>	getCounterReset(E elementStyle) Get counter-reset property.
protected abstract Collection<? extends cz.vutbr.web.css.TermPair<String,Integer>>	getCounterSet(E elementStyle) Get counter-set property.
protected abstract org.daisy.braille.css.BrailleCSSProperty.Display	getDisplay(E elementStyle) Get display property.
protected abstract CounterStyle	getListStyleType(E elementStyle, CounterStyle parentListStyleType) Get list counter style.
protected abstract Collection<cz.vutbr.web.css.Term<?>>	getMarkerContent(E elementStyle) Get content property of ::marker pseudo-element.
protected abstract CounterStyle	getNamedCounterStyle(String name) Get counter style for given name
void	startElement(E elementStyle) This method must be called at the start of every element while traversing the document tree in depth-first order.

Methods inherited from class java.lang.Object

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

Field Detail

counterValues

protected final LinkedList<Map<String,Integer>> counterValues

Constructor Detail

CounterEvaluator

public CounterEvaluator()

Method Detail

getCounterReset

protected abstract Collection<? extends cz.vutbr.web.css.TermPair<String,Integer>> getCounterReset(E elementStyle)

Get counter-reset property.

getCounterSet

protected abstract Collection<? extends cz.vutbr.web.css.TermPair<String,Integer>> getCounterSet(E elementStyle)

Get counter-set property.

getCounterIncrement

protected abstract Collection<? extends cz.vutbr.web.css.TermPair<String,Integer>> getCounterIncrement(E elementStyle)

Get counter-increment property.

getDisplay

protected abstract org.daisy.braille.css.BrailleCSSProperty.Display getDisplay(E elementStyle)

Get display property.

getMarkerContent

protected abstract Collection<cz.vutbr.web.css.Term<?>> getMarkerContent(E elementStyle)

Get content property of ::marker pseudo-element. null means there is no ::marker pseudo-element. An empty list means the pseudo-element has no content.

getListStyleType

protected abstract CounterStyle getListStyleType(E elementStyle,
                                                 CounterStyle parentListStyleType)

Get list counter style.

getNamedCounterStyle

protected abstract CounterStyle getNamedCounterStyle(String name)

Get counter style for given name

startElement

public void startElement(E elementStyle)

This method must be called at the start of every element while traversing the document tree in depth-first order. New counter values are determined based on the given style.

Parameters:

elementStyle - The style of the current element, possibly containing counter-reset, counter-set and counter-increment properties.

endElement

public void endElement()

This method must be called at the end of every element while traversing the document tree in depth-first order.

generateMarkerContents

public String generateMarkerContents(E elementStyle)
                              throws IllegalArgumentException

Evaluate marker contents (see https://www.w3.org/TR/css-lists-3/#content-property)

Throws:

IllegalArgumentException

evaluateCounter

public String evaluateCounter(String name,
                              CounterStyle style,
                              boolean withPrefixAndSuffix)

Generate a counter representation of the innermost counter in the counter set with the given name (see https://www.w3.org/TR/css-lists-3/#counter-functions)

evaluateCounter

public int evaluateCounter(String name)

Get the value of the innermost counter in the counter set with the given name, or instaniate a counter with value 0 (see https://www.w3.org/TR/css-lists-3/#counter-functions)

evaluateCounters

public String evaluateCounters(String name,
                               CounterStyle style,
                               String separator)

Generate a counter representation of all the counters in the counter set with the given name (see https://www.w3.org/TR/css-lists-3/#counter-functions)