com.openhtmltopdf.css.newmatch.PageInfo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openhtmltopdf-core Show documentation
Open HTML to PDF is a CSS 2.1 renderer written in Java. This artifact contains the core rendering and layout code.
The newest version!
/*
 * {{{ header & license
 * Copyright (c) 2007 Wisconsin Court System
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 * }}}
 */
package com.openhtmltopdf.css.newmatch;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;

import com.openhtmltopdf.css.constants.CSSName;
import com.openhtmltopdf.css.constants.IdentValue;
import com.openhtmltopdf.css.constants.MarginBoxName;
import com.openhtmltopdf.css.parser.PropertyValue;
import com.openhtmltopdf.css.sheet.PropertyDeclaration;
import com.openhtmltopdf.css.sheet.StylesheetInfo;
import com.openhtmltopdf.css.style.CalculatedStyle;
import com.openhtmltopdf.css.style.EmptyStyle;
import com.openhtmltopdf.util.LogMessageId;
import com.openhtmltopdf.util.XRLog;

public class PageInfo {
    private final CascadedStyle _pageStyle;
    private final Map> _marginBoxes;

    private final List _properties;
    private final List _xmpPropertyList;
    private final List _footnote;

    public PageInfo(
            List properties,
            CascadedStyle pageStyle,
            Map>  marginBoxes,
            List footnote) {
        _properties = properties;
        _pageStyle = pageStyle;
        _marginBoxes = marginBoxes;
        _footnote = footnote;

        _xmpPropertyList = marginBoxes.remove(MarginBoxName.FS_PDF_XMP_METADATA);
    }

    public Map> getMarginBoxes() {
        return _marginBoxes;
    }
    
    public CascadedStyle getPageStyle() {
        return _pageStyle;
    }
    
    public List getProperties() {
        return _properties;
    }

    public CalculatedStyle getFootnoteAreaRawMaxHeightStyle() {
        CascadedStyle cascaded = new CascadedStyle(_footnote.iterator());

        if (cascaded.hasProperty(CSSName.MAX_HEIGHT)) {
            return new EmptyStyle().deriveStyle(cascaded);
        }

        return null;
    }

    /**
     * Creates a footnote area style from footnote at-rule properties
     * for this page with display overriden to block and
     * position overriden as absolute.
     */
    public CascadedStyle createFootnoteAreaStyle() {
        PropertyDeclaration maxHeight = new PropertyDeclaration(
                CSSName.MAX_HEIGHT, new PropertyValue(IdentValue.NONE), true, StylesheetInfo.USER);

        List overrides = Arrays.asList(
                CascadedStyle.createLayoutPropertyDeclaration(CSSName.POSITION, IdentValue.ABSOLUTE),
                CascadedStyle.createLayoutPropertyDeclaration(CSSName.DISPLAY, IdentValue.BLOCK),
                maxHeight);

        if (_footnote == null || _footnote.isEmpty()) {
            return new CascadedStyle(overrides.iterator());
        }

        List all = new ArrayList<>(overrides.size() + _footnote.size());

        for (PropertyDeclaration decl : _footnote) {
            CSSName name = decl.getCSSName();
            PropertyValue value = (PropertyValue) decl.getValue();

            if (name.equals(CSSName.POSITION)) {
                if (value.getPropertyValueType() != PropertyValue.VALUE_TYPE_IDENT ||
                    value.getIdentValue() != IdentValue.ABSOLUTE) {
                    XRLog.log(Level.WARNING, LogMessageId.LogMessageId2Param.GENERAL_FOOTNOTE_AREA_INVALID_STYLE, value.getCssText(), "position");
                }
            } else if (name == CSSName.FLOAT) {
                if (value.getPropertyValueType() != PropertyValue.VALUE_TYPE_IDENT ||
                    value.getIdentValue() != IdentValue.BOTTOM) {
                    XRLog.log(Level.WARNING, LogMessageId.LogMessageId2Param.GENERAL_FOOTNOTE_AREA_INVALID_STYLE, value.getCssText(), "float");
                }
            } else if (name == CSSName.DISPLAY) {
                if (value.getPropertyValueType() != PropertyValue.VALUE_TYPE_IDENT ||
                    value.getIdentValue() != IdentValue.BLOCK) {
                    XRLog.log(Level.WARNING, LogMessageId.LogMessageId2Param.GENERAL_FOOTNOTE_AREA_INVALID_STYLE, value.getCssText(), "display");
                }
            } else {
                all.add(decl);
            }
        }

        all.addAll(overrides);

        return new CascadedStyle(all.iterator());
    }

    public CascadedStyle createMarginBoxStyle(MarginBoxName marginBox, boolean alwaysCreate) {
        List marginProps = _marginBoxes.get(marginBox);

        if ((marginProps == null || marginProps.size() == 0) && ! alwaysCreate) {
            return null;
        }
        
        List all;
        if (marginProps != null) {
            all = new ArrayList<>(marginProps.size() + 3);
            all.addAll(marginProps);    
        } else {
            all = new ArrayList<>(3);
        }
        
        all.add(CascadedStyle.createLayoutPropertyDeclaration(CSSName.DISPLAY, IdentValue.TABLE_CELL));
        all.add(new PropertyDeclaration(
                    CSSName.VERTICAL_ALIGN, 
                    new PropertyValue(marginBox.getInitialVerticalAlign()), 
                    false,
                    StylesheetInfo.USER_AGENT));
        all.add(new PropertyDeclaration(
                CSSName.TEXT_ALIGN, 
                new PropertyValue(marginBox.getInitialTextAlign()), 
                false,
                StylesheetInfo.USER_AGENT));        
                        
        
        return new CascadedStyle(all.iterator());
    }
    
    public boolean hasAny(MarginBoxName[] marginBoxes) {
        for (MarginBoxName marginBox : marginBoxes) {
            if (_marginBoxes.containsKey(marginBox)) {
                return true;
            }
        }
        
        return false;
    }

    public List getXMPPropertyList() {
        return _xmpPropertyList;
    }
}