Class BarColumn
- java.lang.Object
-
- org.jacoco.report.internal.html.table.BarColumn
-
- All Implemented Interfaces:
IColumnRenderer
public class BarColumn extends java.lang.Object implements IColumnRenderer
Column with a graphical bar that represents the total amount of items in with length, and the coverage ratio with a red/green sections. The implementation is stateful, instances must not be used in parallel.
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.Comparator<ITableItem>
comparator
private ICoverageNode.CounterEntity
entity
private java.text.NumberFormat
integerFormat
private int
max
private static int
WIDTH
-
Constructor Summary
Constructors Constructor Description BarColumn(ICoverageNode.CounterEntity entity, java.util.Locale locale)
Creates a new column that is based on theICounter
for the given entity.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description private void
bar(HTMLElement td, int count, java.lang.String image, Resources resources, ReportOutputFolder base)
void
footer(HTMLElement td, ICoverageNode total, Resources resources, ReportOutputFolder base)
Renders the footer for this column.java.util.Comparator<ITableItem>
getComparator()
Returns the comparator to sort this table column.boolean
init(java.util.List<? extends ITableItem> items, ICoverageNode total)
Initializes the column before any output method is called.void
item(HTMLElement td, ITableItem item, Resources resources, ReportOutputFolder base)
Renders a single item in this column.
-
-
-
Field Detail
-
WIDTH
private static final int WIDTH
- See Also:
- Constant Field Values
-
entity
private final ICoverageNode.CounterEntity entity
-
integerFormat
private final java.text.NumberFormat integerFormat
-
max
private int max
-
comparator
private final java.util.Comparator<ITableItem> comparator
-
-
Constructor Detail
-
BarColumn
public BarColumn(ICoverageNode.CounterEntity entity, java.util.Locale locale)
Creates a new column that is based on theICounter
for the given entity.- Parameters:
entity
- counter entity for visualizationlocale
- locale for rendering numbers
-
-
Method Detail
-
init
public boolean init(java.util.List<? extends ITableItem> items, ICoverageNode total)
Description copied from interface:IColumnRenderer
Initializes the column before any output method is called.- Specified by:
init
in interfaceIColumnRenderer
- Parameters:
items
- all items that will be displayed in the tabletotal
- the summary of all coverage data items in the table- Returns:
true
if the column should be visible
-
footer
public void footer(HTMLElement td, ICoverageNode total, Resources resources, ReportOutputFolder base) throws java.io.IOException
Description copied from interface:IColumnRenderer
Renders the footer for this column.- Specified by:
footer
in interfaceIColumnRenderer
- Parameters:
td
- the parent table celltotal
- the summary of all coverage data items in the tableresources
- static resources that might be referencedbase
- base folder of the table- Throws:
java.io.IOException
- in case of IO problems with the element output
-
item
public void item(HTMLElement td, ITableItem item, Resources resources, ReportOutputFolder base) throws java.io.IOException
Description copied from interface:IColumnRenderer
Renders a single item in this column.- Specified by:
item
in interfaceIColumnRenderer
- Parameters:
td
- the parent table cellitem
- the item to displayresources
- static resources that might be referencedbase
- base folder of the table- Throws:
java.io.IOException
- in case of IO problems with the element output
-
bar
private void bar(HTMLElement td, int count, java.lang.String image, Resources resources, ReportOutputFolder base) throws java.io.IOException
- Throws:
java.io.IOException
-
getComparator
public java.util.Comparator<ITableItem> getComparator()
Description copied from interface:IColumnRenderer
Returns the comparator to sort this table column.- Specified by:
getComparator
in interfaceIColumnRenderer
- Returns:
- comparator for this column
-
-