Skip to content

Commit

Permalink
#180 - Implemented -fs-if-cut-off function and test with overflow page.
Browse files Browse the repository at this point in the history 
Also cleaned up ContentFunctionFactory class.
  • Loading branch information
@danfickle
danfickle committed Mar 8, 2019
1 parent 6d2ac84 commit 9f25039
Show file tree
Hide file tree
Showing 4 changed files with 131 additions and 24 deletions.
98 changes: 74 additions & 24 deletions openhtmltopdf-core/src/main/java/com/openhtmltopdf/context/ContentFunctionFactory.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,52 +35,88 @@
import com.openhtmltopdf.render.InlineLayoutBox;
import com.openhtmltopdf.render.InlineText;
import com.openhtmltopdf.render.LineBox;
import com.openhtmltopdf.render.PageBox;
import com.openhtmltopdf.render.RenderingContext;

public class ContentFunctionFactory {
private List _functions = new ArrayList();
{
private final List<ContentFunction> _functions = new ArrayList<>();

public ContentFunctionFactory() {
_functions.add(new PageCounterFunction());
_functions.add(new PagesCounterFunction());
_functions.add(new TargetCounterFunction());
_functions.add(new LeaderFunction());
_functions.add(new FsIfCutOffFunction());
}

public ContentFunction lookupFunction(LayoutContext c, FSFunction function) {
for (Iterator i = _functions.iterator(); i.hasNext(); ) {
ContentFunction f = (ContentFunction)i.next();
if (f.canHandle(c, function)) {
return f;
}
}
return null;
return _functions.stream()
.filter(f -> f.canHandle(c, function))
.findFirst().orElse(null);
}

public void registerFunction(ContentFunction function) {
_functions.add(function);
}

/**
* Content function which returns its argument if on a cut off page, else the empty string.
* Example:
* <code>content: "Page " counter(page) -fs-if-cut-off(" continued") " of " counter(pages);</code>
*/
private static class FsIfCutOffFunction implements ContentFunction {
@Override
public boolean isStatic() {
return false;
}

@Override
public String calculate(LayoutContext c, FSFunction function) {
return null;
}

@Override
public String calculate(RenderingContext c, FSFunction function, InlineText text) {
return c.getShadowPageNumber() >= 0 ?
function.getParameters().get(0).getStringValue() :
"";
}

@Override
public String getLayoutReplacementText() {
// Needs to be non-empty.
return "cont";
}

@Override
public boolean canHandle(LayoutContext c, FSFunction function) {
return function.getName().equals("-fs-if-cut-off") &&
function.getParameters().size() == 1 &&
function.getParameters().get(0).getPrimitiveType() == CSSPrimitiveValue.CSS_STRING;
}
}

private static abstract class PageNumberFunction implements ContentFunction {
@Override
public boolean isStatic() {
return false;
}

@Override
public String calculate(LayoutContext c, FSFunction function) {
return null;
}

@Override
public String getLayoutReplacementText() {
return "999";
}

protected IdentValue getListStyleType(FSFunction function) {
IdentValue result = IdentValue.DECIMAL;

List parameters = function.getParameters();
List<PropertyValue> parameters = function.getParameters();
if (parameters.size() == 2) {
PropertyValue pValue = (PropertyValue)parameters.get(1);
PropertyValue pValue = parameters.get(1);
IdentValue iValue = IdentValue.valueOf(pValue.getStringValue());
if (iValue != null) {
result = iValue;
Expand All @@ -92,16 +128,16 @@ protected IdentValue getListStyleType(FSFunction function) {

protected boolean isCounter(FSFunction function, String counterName) {
if (function.getName().equals("counter")) {
List parameters = function.getParameters();
List<PropertyValue> parameters = function.getParameters();
if (parameters.size() == 1 || parameters.size() == 2) {
PropertyValue param = (PropertyValue)parameters.get(0);
PropertyValue param = parameters.get(0);
if (param.getPrimitiveType() != CSSPrimitiveValue.CSS_IDENT ||
! param.getStringValue().equals(counterName)) {
return false;
}

if (parameters.size() == 2) {
param = (PropertyValue)parameters.get(1);
param = parameters.get(1);
return param.getPrimitiveType() == CSSPrimitiveValue.CSS_IDENT;
}

Expand All @@ -114,22 +150,26 @@ protected boolean isCounter(FSFunction function, String counterName) {
}

private static class PageCounterFunction extends PageNumberFunction implements ContentFunction {
@Override
public String calculate(RenderingContext c, FSFunction function, InlineText text) {
int value = c.getRootLayer().getRelativePageNo(c) + 1;
return CounterFunction.createCounterText(getListStyleType(function), value);
}

@Override
public boolean canHandle(LayoutContext c, FSFunction function) {
return c.isPrint() && isCounter(function, "page");
}
}

private static class PagesCounterFunction extends PageNumberFunction implements ContentFunction {
@Override
public String calculate(RenderingContext c, FSFunction function, InlineText text) {
int value = c.getRootLayer().getRelativePageCount(c);
return CounterFunction.createCounterText(getListStyleType(function), value);
}

@Override
public boolean canHandle(LayoutContext c, FSFunction function) {
return c.isPrint() && isCounter(function, "pages");
}
Expand All @@ -140,10 +180,12 @@ public boolean canHandle(LayoutContext c, FSFunction function) {
* http://www.w3.org/TR/2007/WD-css3-gcpm-20070504/#cross-references
*/
private static class TargetCounterFunction implements ContentFunction {
@Override
public boolean isStatic() {
return false;
}

@Override
public String calculate(RenderingContext c, FSFunction function, InlineText text) {
String uri = text.getParent().getElement().getAttribute("href");
if (uri != null && uri.startsWith("#")) {
Expand All @@ -157,27 +199,30 @@ public String calculate(RenderingContext c, FSFunction function, InlineText text
return "";
}

@Override
public String calculate(LayoutContext c, FSFunction function) {
return null;
}

@Override
public String getLayoutReplacementText() {
return "999";
}

@Override
public boolean canHandle(LayoutContext c, FSFunction function) {
if (c.isPrint() && function.getName().equals("target-counter")) {
List parameters = function.getParameters();
List<PropertyValue> parameters = function.getParameters();
if (parameters.size() == 2 || parameters.size() == 3) {
FSFunction f = ((PropertyValue)parameters.get(0)).getFunction();
FSFunction f = parameters.get(0).getFunction();
if (f == null ||
f.getParameters().size() != 1 ||
f.getParameters().get(0).getPrimitiveType() != CSSPrimitiveValue.CSS_IDENT ||
! f.getParameters().get(0).getStringValue().equals("href")) {
return false;
}

PropertyValue param = (PropertyValue)parameters.get(1);
PropertyValue param = parameters.get(1);
return param.getPrimitiveType() == CSSPrimitiveValue.CSS_IDENT &&
param.getStringValue().equals("page");
}
Expand All @@ -192,10 +237,12 @@ public boolean canHandle(LayoutContext c, FSFunction function) {
* http://www.w3.org/TR/2007/WD-css3-gcpm-20070504/#leaders
*/
private static class LeaderFunction implements ContentFunction {
@Override
public boolean isStatic() {
return false;
}

@Override
public String calculate(RenderingContext c, FSFunction function, InlineText text) {
InlineLayoutBox iB = text.getParent();
LineBox lineBox = iB.getLineBox();
Expand All @@ -204,9 +251,9 @@ public String calculate(RenderingContext c, FSFunction function, InlineText text
// Because the leader should fill up the line, we need the correct
// width and must first compute the target-counter function.
boolean dynamic = false;
Iterator childIterator = lineBox.getChildIterator();
Iterator<Box> childIterator = lineBox.getChildIterator();
while (childIterator.hasNext()) {
Box child = (Box)childIterator.next();
Box child = childIterator.next();
if (child == iB) {
dynamic = true;
} else if (dynamic && child instanceof InlineLayoutBox) {
Expand Down Expand Up @@ -264,19 +311,22 @@ public String calculate(RenderingContext c, FSFunction function, InlineText text
return leaderString;
}

@Override
public String calculate(LayoutContext c, FSFunction function) {
return null;
}

@Override
public String getLayoutReplacementText() {
return " . ";
}

@Override
public boolean canHandle(LayoutContext c, FSFunction function) {
if (c.isPrint() && function.getName().equals("leader")) {
List parameters = function.getParameters();
List<PropertyValue> parameters = function.getParameters();
if (parameters.size() == 1) {
PropertyValue param = (PropertyValue)parameters.get(0);
PropertyValue param = parameters.get(0);
return param.getPrimitiveType() == CSSPrimitiveValue.CSS_STRING ||
(param.getPrimitiveType() == CSSPrimitiveValue.CSS_IDENT &&
(param.getStringValue().equals("dotted") ||
Expand Down
Binary file added openhtmltopdf-examples/src/main/resources/visualtest/expected/text/content-page-numbers.pdf
View file
Binary file not shown.
49 changes: 49 additions & 0 deletions openhtmltopdf-examples/src/main/resources/visualtest/html/text/content-page-numbers.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<html>
<head>
<style>
@page {
size: 180px 100px;
margin: 18px;
-fs-max-overflow-pages: 10;
-fs-overflow-pages-direction: ltr;

@top-left {
content: "Page " counter(page) -fs-if-cut-off(" (continued)") " of " counter(pages);
font-family: 'TestFont';
font-size: 12px;
}
}
body {
margin: 0;
}
div {
box-sizing: border-box;
margin: 0;
}
.outer {
border: 1px solid black;
background-color: red;
min-height: 20px;
}
.inner {
border: 1px solid blue;
background-color: orange;
min-height: 15px;
}
</style>
</head>
<body style="font-family: 'TestFont'; color: black; font-size: 12px;">
PAGE 1.

<div style="page-break-before: always;"></div>

PAGE 2 (with overflow).
<div class="outer" style="width: 150%;">
<div class="inner" style="width: 100%;">ABCDEFGHIJKLMNOPQRSTUVWXYZ</div>
</div>

<div style="page-break-before: always;"></div>

PAGE 3.
</body>
</html>
8 changes: 8 additions & 0 deletions ...mples/src/test/java/com/openhtmltopdf/visualregressiontests/TextVisualRegressionTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -488,4 +488,12 @@ public void testTablePaginated() throws IOException {
public void testTableHorizPageOverflow() throws IOException {
assertTrue(run("table-horiz-page-overflow"));
}

/**
* Tests page and pages counter as well as -fs-if-cut-off function with overflow page.
*/
@Test
public void testContentPageNumbers() throws IOException {
assertTrue(run("content-page-numbers"));
}
}

0 comments on commit 9f25039

Please sign in to comment.