/*
*
* This file is part of the iText (R) project.
Copyright (c) 1998-2017 iText Group NV
* Authors: Balder Van Camp, Emiel Ackermann, et al.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License version 3
* as published by the Free Software Foundation with the addition of the
* following permission added to Section 15 as permitted in Section 7(a):
* FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
* ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
* OF THIRD PARTY RIGHTS.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
* warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
* details. You should have received a copy of the GNU Affero General Public License along with this program; if not,
* see http://www.gnu.org/licenses or write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA, 02110-1301 USA, or download the license from the following URL: http://itextpdf.com/terms-of-use/
*
* The interactive user interfaces in modified source and object code versions of this program must display Appropriate
* Legal Notices, as required under Section 5 of the GNU Affero General Public License.
*
* In accordance with Section 7(b) of the GNU Affero General Public License, a covered work must retain the producer
* line in every PDF that is created or manipulated using iText.
*
* You can be released from the requirements of the license by purchasing a commercial license. Buying such a license is
* mandatory as soon as you develop commercial activities involving the iText software without disclosing the source
* code of your own applications. These activities include: offering paid services to customers as an ASP, serving PDFs
* on the fly in a web application, shipping iText with a closed source product.
*
* For more information, please contact iText Software Corp. at this address: sales@itextpdf.com
*/
package com.itextpdf.tool.xml.html;
import java.util.ArrayList;
import java.util.List;
import com.itextpdf.text.Element;
import com.itextpdf.text.Font;
import com.itextpdf.text.ListItem;
import com.itextpdf.tool.xml.NoCustomContextException;
import com.itextpdf.tool.xml.Tag;
import com.itextpdf.tool.xml.WorkerContext;
import com.itextpdf.tool.xml.css.CSS;
import com.itextpdf.tool.xml.css.CssUtils;
import com.itextpdf.tool.xml.css.FontSizeTranslator;
import com.itextpdf.tool.xml.exceptions.LocaleMessages;
import com.itextpdf.tool.xml.exceptions.RuntimeWorkerException;
import com.itextpdf.tool.xml.pipeline.html.HtmlPipelineContext;
/**
* @author Emiel Ackermann
*
*/
public class OrderedUnorderedList extends AbstractTagProcessor {
/**
*
*/
private static final FontSizeTranslator fst = FontSizeTranslator.getInstance();
/**
*
*/
private static final CssUtils utils = CssUtils.getInstance();
/*
* (non-Javadoc)
*
* @see com.itextpdf.tool.xml.TagProcessor#endElement(com.itextpdf.tool.xml.Tag, java.util.List)
*/
@Override
public List<Element> end(final WorkerContext ctx, final Tag tag, final List<Element> currentContent) {
List<Element> listElements = populateList(currentContent);
int size = listElements.size();
List<Element> returnedList = new ArrayList<Element>();
if (size > 0) {
HtmlPipelineContext htmlPipelineContext = null;
com.itextpdf.text.List list;
try {
htmlPipelineContext = getHtmlPipelineContext(ctx);
list = (com.itextpdf.text.List) getCssAppliers().apply(new com.itextpdf.text.List(), tag, htmlPipelineContext);
} catch (NoCustomContextException e) {
list = (com.itextpdf.text.List) getCssAppliers().apply(new com.itextpdf.text.List(), tag, null);
}
int i = 0;
for (Element li : listElements) {
if (li instanceof ListItem) {
Tag child = tag.getChildren().get(i);
if (size == 1) {
child.getCSS().put(CSS.Property.MARGIN_TOP,
calculateTopOrBottomSpacing(true, false, tag, child, ctx) + "pt");
float marginBottom = calculateTopOrBottomSpacing(false, false, tag, child, ctx);
child.getCSS().put(CSS.Property.MARGIN_BOTTOM, marginBottom + "pt");
} else {
if (i == 0) {
child.getCSS().put(CSS.Property.MARGIN_TOP,
calculateTopOrBottomSpacing(true, false, tag, child, ctx) + "pt");
}
if (i == size - 1) {
float marginBottom = calculateTopOrBottomSpacing(false, true, tag, child, ctx);
child.getCSS().put(CSS.Property.MARGIN_BOTTOM, marginBottom + "pt");
}
}
try {
list.add(getCssAppliers().apply(li, child, getHtmlPipelineContext(ctx)));
} catch (NoCustomContextException e1) {
throw new RuntimeWorkerException(LocaleMessages.getInstance().getMessage(LocaleMessages.NO_CUSTOM_CONTEXT), e1);
}
} else {
list.add(li);
}
i++;
}
returnedList.add(list);
}
return returnedList;
}
/**
* Fills a java.util.List with all elements found in currentContent. Places elements that are not a {@link ListItem}
* or {@link com.itextpdf.text.List} in a new ListItem object.
*
* @param currentContent
* @return java.util.List with only {@link ListItem}s or {@link com.itextpdf.text.List}s in it.
*/
private List<Element> populateList(final List<Element> currentContent) {
List<Element> listElements = new ArrayList<Element>();
for (Element e : currentContent) {
if (e instanceof ListItem || e instanceof com.itextpdf.text.List) {
listElements.add(e);
} else {
ListItem listItem = new ListItem();
listItem.add(e);
listElements.add(listItem);
}
}
return listElements;
}
/**
* Calculates top or bottom spacing of the list. In HTML following possibilities exist:
* <ul>
* <li><b>padding-top of the ul/ol tag == 0.</b><br />
* The margin-top values of the ul/ol tag and its <b>first</b> li tag are <b>compared</b>. The total spacing before
* is the largest margin value and the first li's padding-top.</li>
* <li><b>padding-top of the ul/ol tag != 0.</b><br />
* The margin-top or bottom values of the ul/ol tag and its first li tag are <b>accumulated</b>, along with
* padding-top values of both tags.</li>
* <li><b>padding-bottom of the ul/ol tag == 0.</b><br />
* The margin-bottom values of the ul/ol tag and its <b>last</b> li tag are <b>compared</b>. The total spacing after
* is the largest margin value and the first li's padding-bottom.</li>
* <li><b>padding-bottom of the ul/ol tag != 0.</b><br />
* The margin-bottom or bottom values of the ul/ol tag and its last li tag are <b>accumulated</b>, along with
* padding-bottom values of both tags.</li>
* </ul>
*
* @param isTop boolean, if true the top spacing is calculated, if false the bottom spacing is calculated.
* @param storeMarginBottom if true the calculated margin bottom value is stored for later comparison with the top
* margin value of the next tag.
* @param tag the ul/ol tag.
* @param child first or last li tag of this list.
* @param ctx
* @return float containing the spacing before or after.
*/
private float calculateTopOrBottomSpacing(final boolean isTop, final boolean storeMarginBottom, final Tag tag,
final Tag child, final WorkerContext ctx) {
float totalSpacing = 0;
try {
HtmlPipelineContext context = getHtmlPipelineContext(ctx);
String end = isTop ? "-top" : "-bottom";
float ownFontSize = fst.getFontSize(tag);
if (ownFontSize == Font.UNDEFINED)
ownFontSize = 0;
float ownMargin = 0;
String marginValue = tag.getCSS().get(CSS.Property.MARGIN + end);
if (marginValue == null) {
if (null != tag.getParent()
&& getHtmlPipelineContext(ctx).getRootTags().contains(tag.getParent().getName())) {
ownMargin = ownFontSize;
}
} else {
ownMargin = utils.parseValueToPt(marginValue, ownFontSize);
}
float ownPadding = tag.getCSS().get(CSS.Property.PADDING + end) != null ? utils.parseValueToPt(tag.getCSS()
.get(CSS.Property.PADDING + end), ownFontSize) : 0;
float childFontSize = fst.getFontSize(child);
float childMargin = child.getCSS().get(CSS.Property.MARGIN + end) != null ? utils.parseValueToPt(child
.getCSS().get(CSS.Property.MARGIN + end), childFontSize) : 0;
// Margin values of this tag and its first child need to be compared if paddingTop or bottom = 0.
if (ownPadding == 0) {
float margin = 0;
if (ownMargin != 0 && childMargin != 0) {
margin = ownMargin >= childMargin ? ownMargin : childMargin;
} else if (ownMargin != 0) {
margin = ownMargin;
} else if (childMargin != 0) {
margin = childMargin;
}
if (!isTop && storeMarginBottom) {
context.getMemory().put(HtmlPipelineContext.LAST_MARGIN_BOTTOM, margin);
}
totalSpacing = margin;
} else { // ownpadding != 0 and all margins and paddings need to be accumulated.
totalSpacing = ownMargin + ownPadding + childMargin;
if (!isTop && storeMarginBottom) {
context.getMemory().put(HtmlPipelineContext.LAST_MARGIN_BOTTOM, ownMargin);
}
}
} catch (NoCustomContextException e) {
throw new RuntimeWorkerException(LocaleMessages.getInstance().getMessage(LocaleMessages.NO_CUSTOM_CONTEXT),
e);
}
return totalSpacing;
}
/*
* (non-Javadoc)
*
* @see com.itextpdf.tool.xml.TagProcessor#isStackOwner()
*/
@Override
public boolean isStackOwner() {
return true;
}
}