pdfHTML 6.3.0 API
Public Member Functions | List of all members
iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager Class Reference

Class that manages counters (e.g. for list symbols). More...

Public Member Functions
  CssCounterManager ()
  Creates a new CssCounterManager instance. More...
 
virtual void  ClearManager ()
  Clears information about counters. More...
 
virtual void  PushEveryCounterToCounters (IElementNode element)
  Pushes every current non-null counter to stack of counters. More...
 
virtual void  PopEveryCounterFromCounters (IElementNode element)
  Pops every given counter from stack of counters. More...
 
virtual String  ResolveTargetCounter (String id, String counterName, CounterDigitsGlyphStyle listSymbolType)
  Gets target-counter value for specified ID and counterName. More...
 
virtual String  ResolveTargetCounters (String id, String counterName, String counterSeparatorStr, CounterDigitsGlyphStyle listSymbolType)
  Gets target-counter value for specified ID and counterName. More...
 
virtual void  AddTargetCounterIfRequired (IElementNode node)
  Adds counter value to every counter in the Map corresponding to a node ID. More...
 
virtual void  AddTargetCountersIfRequired (IElementNode node)
  Adds counters value to every counter in the Map corresponding to a node ID. More...
 
virtual String  ResolveCounter (String counterName, CounterDigitsGlyphStyle listSymbolType)
  Resolves a counter. More...
 
virtual String  ResolveCounters (String counterName, String counterSeparatorStr, CounterDigitsGlyphStyle listSymbolType)
  Resolves counters. More...
 
virtual void  ResetCounter (String counterName)
  Resets the counter. More...
 
virtual void  ResetCounter (String counterName, int value)
  Resets the counter. More...
 
virtual void  IncrementCounter (String counterName)
  Increments the counter. More...
 
virtual void  IncrementCounter (String counterName, int incrementValue)
  Increments the counter. More...
 

Detailed Description

Class that manages counters (e.g. for list symbols).

Constructor & Destructor Documentation

◆ CssCounterManager()

iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager.CssCounterManager ( )
inline

Creates a new CssCounterManager instance.

Member Function Documentation

◆ AddTargetCounterIfRequired()

virtual void iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager.AddTargetCounterIfRequired ( IElementNode  node )
inlinevirtual

Adds counter value to every counter in the Map corresponding to a node ID.

Parameters
node node to take ID and scope from

◆ AddTargetCountersIfRequired()

virtual void iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager.AddTargetCountersIfRequired ( IElementNode  node )
inlinevirtual

Adds counters value to every counter in the Map corresponding to a node ID.

Parameters
node node to take ID and scope from

◆ ClearManager()

virtual void iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager.ClearManager ( )
inlinevirtual

Clears information about counters.

Clears information about counters. Target-counter(s) information remains.

◆ IncrementCounter() [1/2]

virtual void iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager.IncrementCounter ( String  counterName )
inlinevirtual

Increments the counter.

Parameters
counterName the counter name

◆ IncrementCounter() [2/2]

virtual void iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager.IncrementCounter ( String  counterName,
int  incrementValue 
)
inlinevirtual

Increments the counter.

Parameters
counterName the counter name
incrementValue the increment value

◆ PopEveryCounterFromCounters()

virtual void iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager.PopEveryCounterFromCounters ( IElementNode  element )
inlinevirtual

Pops every given counter from stack of counters.

Pops every given counter from stack of counters. This method should be called when we have finished processing child nodes.

Parameters
element the element which counters shall be popped

◆ PushEveryCounterToCounters()

virtual void iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager.PushEveryCounterToCounters ( IElementNode  element )
inlinevirtual

Pushes every current non-null counter to stack of counters.

Pushes every current non-null counter to stack of counters. This method should be called when we are about to process child nodes.

Parameters
element the element which counters shall be pushed

◆ ResetCounter() [1/2]

virtual void iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager.ResetCounter ( String  counterName )
inlinevirtual

Resets the counter.

Parameters
counterName the counter name

◆ ResetCounter() [2/2]

virtual void iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager.ResetCounter ( String  counterName,
int  value 
)
inlinevirtual

Resets the counter.

Parameters
counterName the counter name
value the new value

◆ ResolveCounter()

virtual String iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager.ResolveCounter ( String  counterName,
CounterDigitsGlyphStyle  listSymbolType 
)
inlinevirtual

Resolves a counter.

Parameters
counterName the counter name
listSymbolType the list symbol type
Returns
the counter value as a System.String

◆ ResolveCounters()

virtual String iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager.ResolveCounters ( String  counterName,
String  counterSeparatorStr,
CounterDigitsGlyphStyle  listSymbolType 
)
inlinevirtual

Resolves counters.

Parameters
counterName the counter name
counterSeparatorStr the counter separator
listSymbolType the list symbol type
Returns
the counters as a System.String

◆ ResolveTargetCounter()

virtual String iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager.ResolveTargetCounter ( String  id,
String  counterName,
CounterDigitsGlyphStyle  listSymbolType 
)
inlinevirtual

Gets target-counter value for specified ID and counterName.

Gets target-counter value for specified ID and counterName. Value is converted according to listSymbolType.

Parameters
id ID of the element. The first call adds ID to the Map, which means we require its value. The second call returns corresponding value if we already encountered corresponding element
counterName name of the counter. The first call adds counterName to the Map, which means we require its value. The second call returns corresponding value if we already encountered corresponding element
listSymbolType the list symbol type to convert counter's value. null if conversion is not required.
Returns
target-counter value.

◆ ResolveTargetCounters()

virtual String iText.Html2pdf.Css.Resolve.Func.Counter.CssCounterManager.ResolveTargetCounters ( String  id,
String  counterName,
String  counterSeparatorStr,
CounterDigitsGlyphStyle  listSymbolType 
)
inlinevirtual

Gets target-counter value for specified ID and counterName.

Gets target-counter value for specified ID and counterName. Value is converted according to listSymbolType.

Parameters
id ID of the element. The first call adds ID at the Map, which means we require its value. The second call returns corresponding value if we already encountered this element
counterName name of the counter. The first call adds name at the Map, which means we require its value. The second call returns corresponding value if we already encountered this element
counterSeparatorStr separator to separate counters values.
listSymbolType the list symbol type to convert counter's value. null if conversion is not required.
Returns
target-counter value.