fop/src/org/apache/fop/layout/LinkSet.java

/* $Id$
 * Copyright (C) 2001 The Apache Software Foundation. All rights reserved.
 * For details on use and redistribution please refer to the
 * LICENSE file included with these sources.
 */

package org.apache.fop.layout;

// Java
import java.util.Vector;
import java.util.Enumeration;
import java.awt.Rectangle;

import org.apache.fop.layout.inline.InlineArea;

import org.apache.fop.fo.properties.WrapOption; // for enumerated
// values
// import org.apache.fop.fo.properties.WhiteSpaceCollapse; // for
// enumerated values
import org.apache.fop.fo.properties.TextAlign; // for enumerated
// values
import org.apache.fop.fo.properties.TextAlignLast; // for enumerated
// values

/**
 * a set of rectangles on a page that are linked to a common
 * destination
 */
public class LinkSet {

    /** the destination of the links */
    String destination;

    /** the set of rectangles */
    Vector rects = new Vector();

    private int xoffset = 0;
    private int yoffset = 0;

    /* the maximum Y offset value encountered for this LinkSet*/
    private int maxY = 0;

    protected int startIndent;
    protected int endIndent;

    private int linkType;

    private Area area;

    public final static int INTERNAL = 0, // represents internal link
    EXTERNAL = 1; // represents external link

    // property required for alignment adjustments
    int contentRectangleWidth = 0;

    public LinkSet(String destination, Area area, int linkType) {
        this.destination = destination;
        this.area = area;
        this.linkType = linkType;
    }

    public void addRect(Rectangle r, LineArea lineArea, InlineArea inlineArea) {
        LinkedRectangle linkedRectangle = new LinkedRectangle(r, lineArea, inlineArea);
        linkedRectangle.setY(this.yoffset);
        if (this.yoffset > maxY) {
            maxY = this.yoffset;
        }
        rects.addElement(linkedRectangle);
    }

    public void setYOffset(int y) {
        this.yoffset = y;
    }

    public void setXOffset(int x) {
        this.xoffset = x;
    }

    public void setContentRectangleWidth(int contentRectangleWidth) {
        this.contentRectangleWidth = contentRectangleWidth;
    }

    public void applyAreaContainerOffsets(AreaContainer ac, Area area) {
        int height = area.getAbsoluteHeight();
        BlockArea ba = (BlockArea) area;
        Enumeration re = rects.elements();
        while (re.hasMoreElements()) {
            LinkedRectangle r = (LinkedRectangle) re.nextElement();
            r.setX(r.getX() + ac.getXPosition() +
                   area.getTableCellXOffset());
            r.setY(ac.getYPosition() - height + (maxY - r.getY()) -
                   ba.getHalfLeading());
        }
    }

    // intermediate implementation for joining all sublinks on same line
    public void mergeLinks() {
        int numRects = rects.size();
        if (numRects == 1)
            return;

        LinkedRectangle curRect =
          new LinkedRectangle((LinkedRectangle) rects.elementAt(0));
        Vector nv = new Vector();

        for (int ri = 1; ri < numRects; ri++) {
            LinkedRectangle r = (LinkedRectangle) rects.elementAt(ri);

            // yes, I'm really happy with comparing refs...
            if (r.getLineArea() == curRect.getLineArea()) {
                curRect.setWidth(r.getX() + r.getWidth() - curRect.getX());
            } else {
                nv.addElement(curRect);
                curRect = new LinkedRectangle(r);
            }

            if (ri == numRects - 1)
                nv.addElement(curRect);
        }

        rects = nv;
    }

    public void align() {
        Enumeration re = rects.elements();
        while (re.hasMoreElements()) {
            LinkedRectangle r = (LinkedRectangle) re.nextElement();
            r.setX(r.getX() + 
		   r.getLineArea().getStartIndent() + 
		   r.getInlineArea().getXOffset());
        }
    }

    public String getDest() {
        return this.destination;
    }

    public Vector getRects() {
        return this.rects;
    }

    public int getEndIndent() {
        return endIndent;
    }

    public int getStartIndent() {
        return startIndent;
    }

    public Area getArea() {
        return area;
    }

    public int getLinkType() {
        return linkType;
    }
}