LineArea.java

/*
 * Copyright 2014-15 Skynav, Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY SKYNAV, INC. AND ITS CONTRIBUTORS “AS IS” AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL SKYNAV, INC. OR ITS CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package com.skynav.ttpe.area;

import java.util.Set;

import org.w3c.dom.Element;

import com.skynav.ttpe.fonts.Font;
import com.skynav.ttpe.style.AnnotationPosition;
import com.skynav.ttpe.style.AnnotationReserve;
import com.skynav.ttpe.style.Color;
import com.skynav.ttpe.style.InlineAlignment;
import com.skynav.ttpe.style.Visibility;

public class LineArea extends BlockArea {

    private InlineAlignment alignment;
    private Color color;
    private Font font;
    private int lineNumber;                     // 1 is first line of containing area
    private boolean embedding;
    private double bpdAnnotationBefore;
    private double bpdAnnotationAfter;

    public LineArea() {
        this(null, 0, 0, -1, null, null, null, null, 0, false);
    }

    public LineArea(Element e, double ipd, double bpd, int level, Visibility visibility, InlineAlignment alignment, Color color, Font font, int lineNumber, boolean embedding) {
        super(e, ipd, bpd, level, visibility);
        this.alignment = alignment;
        this.color = color;
        this.font = font;
        this.lineNumber = lineNumber;
        this.embedding = embedding;
    }

    @Override
    public double getBPD() {
        return super.getBPD() + getAnnotationBPD();
    }

    @Override
    public void addChild(AreaNode c, Set<Expansion> expansions) {
        if (c instanceof Inline) {
            super.addChild(c, expansions);
            maybeUpdateForAnnotation(c);
        } else
            throw new IllegalArgumentException();
    }

    @Override
    public void insertChild(AreaNode c, AreaNode cBefore, Set<Expansion> expansions) {
        if (c instanceof Inline) {
            super.insertChild(c, cBefore, expansions);
            maybeUpdateForAnnotation(c);
        } else
            throw new IllegalArgumentException();
    }

    @Override
    public void expand(AreaNode a, Set<Expansion> expansions) {
        if (a instanceof AnnotationArea)
            return;
        else
            super.expand(a, expansions);
    }

    public BlockArea getContainingBlock() {
        AreaNode p = getParent();
        while (p != null) {
            if (p instanceof BlockArea)
                return (BlockArea) p;
            else
                p = p.getParent();
        }
        return new BlockArea();
    }

    public void setAlignment(InlineAlignment alignment) {
        this.alignment = alignment;
    }

    public InlineAlignment getAlignment() {
        return alignment;
    }

    public Color getColor() {
        return color;
    }

    public Font getFont() {
        return font;
    }

    public int getLineNumber() {
        return lineNumber;
    }

    public boolean isFirstLine() {
        return lineNumber == 1;
    }

    public double getLeadingBefore() {
        return (font != null) ? font.getLeading() / 2 : 0;
    }

    public double getLeadingAfter() {
        return (font != null) ? font.getLeading() / 2 : 0;
    }

    public double getAscent() {
        return (font != null) ? font.getAscent() : 0;
    }

    public double getDescent() {
        return (font != null) ? font.getDescent() : 0;
    }

    public int getSpacingGlyphsCount() {
        int ng = 0;
        for (AreaNode a : getChildren()) {
            if (a instanceof GlyphArea)
                ng += ((GlyphArea) a).getSpacingGlyphsCount();
        }
        return ng;
    }

    public double getAnnotationBPD() {
        return getAnnotationBPD(AnnotationPosition.BEFORE) + getAnnotationBPD(AnnotationPosition.AFTER);
    }

    public double getAnnotationBPD(AnnotationPosition position) {
        if (position == AnnotationPosition.BEFORE)
            return bpdAnnotationBefore;
        else if (position == AnnotationPosition.AFTER)
            return bpdAnnotationAfter;
        else
            return 0;
    }

    public void addAnnotationReserve(AnnotationReserve.Position position, double reserve) {
        if (!embedding && !(this instanceof AnnotationArea)) {
            if (position == AnnotationReserve.Position.BEFORE)
                adjustAnnotationBPD(AnnotationPosition.BEFORE, reserve);
            else if (position == AnnotationReserve.Position.AFTER)
                adjustAnnotationBPD(AnnotationPosition.AFTER, reserve);
            else if (position == AnnotationReserve.Position.BOTH) {
                adjustAnnotationBPD(AnnotationPosition.BEFORE, reserve);
                adjustAnnotationBPD(AnnotationPosition.AFTER, reserve);
            }
        }
    }

    private void maybeUpdateForAnnotation(AreaNode c) {
        if (c instanceof AnnotationArea) {
            AnnotationArea a = (AnnotationArea) c;
            AnnotationPosition position = a.getPosition();
            if (position == AnnotationPosition.AUTO) {
                position = isFirstLine() ? AnnotationPosition.BEFORE : AnnotationPosition.AFTER;
                a.setPosition(position);
            }
            adjustAnnotationBPD(position, a.getBPD());
        }
    }

    private void adjustAnnotationBPD(AnnotationPosition position, double bpdAnnotation) {
        if (position == AnnotationPosition.BEFORE) {
            if (bpdAnnotationBefore < bpdAnnotation)
                bpdAnnotationBefore = bpdAnnotation;
        } else if (position == AnnotationPosition.AFTER) {
            if (bpdAnnotationAfter < bpdAnnotation)
                bpdAnnotationAfter = bpdAnnotation;
        }
    }

}