org.swtchart/src/org/swtchart/internal/ChartLayout.java

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2008-2014 SWTChart project. All rights reserved. 
 * 
 * This code is distributed under the terms of the Eclipse Public License v1.0
 * which is available at http://www.eclipse.org/legal/epl-v10.html
 *******************************************************************************/
package org.swtchart.internal;

import java.util.HashMap;
import java.util.Map;

import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Point;
import org.eclipse.swt.graphics.Rectangle;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Layout;
import org.swtchart.Chart;
import org.swtchart.IAxis;
import org.swtchart.IAxis.Position;
import org.swtchart.IAxisSet;
import org.swtchart.internal.axis.Axis;
import org.swtchart.internal.axis.AxisTickLabels;
import org.swtchart.internal.axis.AxisTickMarks;
import org.swtchart.internal.axis.AxisTitle;

public class ChartLayout extends Layout {

    private int titleHeight;

    private int titleWidth;

    private int legendWidth;

    private int legendHeight;

    private int bottomAxisHeight;

    private int topAxisHeight;

    private int leftAxisWidth;

    private int rightAxisWidth;

    private int plotAreaWidth;

    private int plotAreaHeight;

    private ChartTitle title;

    private Legend legend;

    private PlotArea plot;

    private Axis[] axes;

    private Axis[] horizontalAxes;

    private Axis[] verticalAxes;
    
    private Map<Axis, AxisLayoutData> axisLayoutDataMap;

    private int bottomAxisOffset = 0;

    private int topAxisOffset = 0;

    private int leftAxisOffset = 0;

    private int rightAxisOffset = 0;

    public static final int MARGIN = 5;

    public static final int PADDING = 5;

    public ChartLayout() {
        initWidgetSizeVariables();
        axisLayoutDataMap = new HashMap<Axis, AxisLayoutData>();
    }

    private void initWidgetSizeVariables() {
        titleHeight = 0;
        titleWidth = 0;
        bottomAxisHeight = 0;
        topAxisHeight = 0;
        leftAxisWidth = 0;
        rightAxisWidth = 0;
        legendWidth = 0;
        legendHeight = 0;
        plotAreaWidth = 0;
        plotAreaHeight = 0;
    }

    /*
     * @see Layout#computeSize(Composite , int, int, boolean)
     */
    @Override
    protected Point computeSize(Composite composite, int wHint, int hHint,
            boolean flushCache) {
        return new Point(wHint, hHint);
    }

    /*
     * @see Layout#layout(Composite, boolean)
     */
    @Override
    protected void layout(Composite composite, boolean flushCache) {
        if (!parseControls(composite)) {
            return;
        }

        Rectangle r = composite.getClientArea();
        
        initWidgetSizeVariables();
        initTitleAndLegendSize();
        initAxisSize();

        computePlotAreaSize(r);
        computeAxisSize(r);
        adjustForRotatedTickLabels(r);
        adjustForMostLeftRightTickLabel(r);

        layoutTitle(r);
        layoutLegend(r);
        layoutPlot(r);
        layoutAxes(r);
    }

    private boolean parseControls(Composite composite) {
        for (Control child : composite.getChildren()) {
            if (child instanceof Legend) {
                legend = (Legend) child;
            } else if (child instanceof PlotArea) {
                plot = (PlotArea) child;
            }
        }

        if (composite instanceof Chart) {
            IAxisSet axisSet = ((Chart) composite).getAxisSet();
            if (axisSet != null) {
                axes = (Axis[]) axisSet.getAxes();

                if (((Chart) composite).getOrientation() == SWT.HORIZONTAL) {
                    horizontalAxes = (Axis[]) axisSet.getXAxes();
                    verticalAxes = (Axis[]) axisSet.getYAxes();
                } else {
                    verticalAxes = (Axis[]) axisSet.getXAxes();
                    horizontalAxes = (Axis[]) axisSet.getYAxes();
                }
            }
            title = (ChartTitle) ((Chart) composite).getTitle();
        }

        if (title == null || legend == null || plot == null || axes == null) {
            // the initialization of chart is not completed yet
            return false;
        }
        return true;
    }

    private void initTitleAndLegendSize() {
        titleWidth = ((ChartLayoutData) title.getLayoutData()).widthHint;
        titleHeight = ((ChartLayoutData) title.getLayoutData()).heightHint;
        legendWidth = ((ChartLayoutData) legend.getLayoutData()).widthHint;
        legendHeight = ((ChartLayoutData) legend.getLayoutData()).heightHint;
    }
    
    private void initAxisSize() {
        axisLayoutDataMap.clear();

        for (Axis axis : axes) {
            AxisLayoutData layoutData = new AxisLayoutData(axis);
            if (layoutData.titleLayoutdata == null
                    || layoutData.tickLabelsLayoutdata == null
                    || layoutData.tickMarksLayoutdata == null) {
                continue;
            }
            axisLayoutDataMap.put(axis, layoutData);
            
            Position position = axis.getPosition();
            if (position == Position.Primary && axis.isHorizontalAxis()) {
                bottomAxisHeight += layoutData.titleLayoutdata.heightHint
                        + layoutData.tickLabelsLayoutdata.heightHint
                        + layoutData.tickMarksLayoutdata.heightHint;
            } else if (position == Position.Secondary
                    && axis.isHorizontalAxis()) {
                topAxisHeight += layoutData.titleLayoutdata.heightHint
                        + layoutData.tickLabelsLayoutdata.heightHint
                        + layoutData.tickMarksLayoutdata.heightHint;
            } else if (position == Position.Primary && !axis.isHorizontalAxis()) {
                leftAxisWidth += layoutData.titleLayoutdata.widthHint
                        + layoutData.tickLabelsLayoutdata.widthHint
                        + layoutData.tickMarksLayoutdata.widthHint;
            } else if (position == Position.Secondary
                    && !axis.isHorizontalAxis()) {
                rightAxisWidth += layoutData.titleLayoutdata.widthHint
                        + layoutData.tickLabelsLayoutdata.widthHint
                        + layoutData.tickMarksLayoutdata.widthHint;
            }
        }
    }

    private void computePlotAreaSize(Rectangle r) {
        int legendPosition = legend.getPosition();

        plotAreaWidth = r.width
                - leftAxisWidth
                - rightAxisWidth
                - (legendPosition == SWT.LEFT || legendPosition == SWT.RIGHT ? legendWidth
                        + (legendWidth == 0 ? 0 : PADDING)
                        : 0) - MARGIN * 2;

        plotAreaHeight = r.height
                - bottomAxisHeight
                - topAxisHeight
                - titleHeight
                - MARGIN
                * 2
                - (titleHeight == 0 ? 0 : PADDING)
                - (legendPosition == SWT.TOP || legendPosition == SWT.BOTTOM ? legendHeight
                        + (legendHeight == 0 ? 0 : PADDING)
                        : 0);
    }

    private void computeAxisSize(Rectangle r) {

        // update vertical axis tick labels
        updateVerticalAxisTick();

        // compute axis width
        for (IAxis axis : verticalAxes) {
            int tickLabelMaxLength = ((Axis) axis).getTick()
                    .getAxisTickLabels().getTickLabelMaxLength();

            AxisLayoutData axisLayout = axisLayoutDataMap.get(axis);
            axisLayout.tickLabelsLayoutdata.widthHint += tickLabelMaxLength;
            if (axis.getPosition() == Position.Primary) {
                leftAxisWidth += tickLabelMaxLength;
            } else {
                rightAxisWidth += tickLabelMaxLength;
            }
        }

        // update plot area width
        computePlotAreaSize(r);

        // update horizontal axis tick labels
        updateHorizontalAxisTick();
    }

    private void adjustForRotatedTickLabels(Rectangle r) {
        for (IAxis axis : horizontalAxes) {
            double angle = axis.getTick().getTickLabelAngle();
            if (angle == 0) {
                continue;
            }

            // update tick label height
            int tickLabelMaxLength = ((Axis) axis).getTick()
                    .getAxisTickLabels().getTickLabelMaxLength();
            AxisLayoutData layoutData = axisLayoutDataMap.get(axis);
            int height = Axis.MARGIN
                    + (int) (tickLabelMaxLength
                            * Math.sin(Math.toRadians(angle)) + Util
                            .getExtentInGC(layoutData.axisTickLabels.getFont(),
                                    "dummy").y
                            * Math.cos(Math.toRadians(angle)));
            int delta = height - layoutData.tickLabelsLayoutdata.heightHint;
            layoutData.tickLabelsLayoutdata.heightHint = height;

            // update axis height
            if (axis.getPosition() == Position.Primary) {
                bottomAxisHeight += delta;
            } else {
                topAxisHeight += delta;
            }

            // update plot area height
            computePlotAreaSize(r);

            updateVerticalAxisTick();
        }
    }

    private void adjustForMostLeftRightTickLabel(Rectangle r) {

        // get axis margin hint
        int rightAxisMarginHint = 0;
        int leftAxisMarginHint = 0;
        for (IAxis axis : horizontalAxes) {
            rightAxisMarginHint = Math.max(rightAxisMarginHint,
                    ((Axis) axis).getTick().getAxisTickLabels()
                            .getRightMarginHint(plotAreaWidth));
            leftAxisMarginHint = Math.max(leftAxisMarginHint,
                    ((Axis) axis).getTick().getAxisTickLabels()
                            .getLeftMarginHint(plotAreaWidth));
        }

        // have space to draw most right tick label on horizontal axis
        if ((legendWidth == 0 || legend.getPosition() != SWT.RIGHT)
                && rightAxisWidth < rightAxisMarginHint) {
            rightAxisWidth = rightAxisMarginHint;
            computePlotAreaSize(r);
            updateHorizontalAxisTick();
        }

        // have space to draw most left tick label on horizontal axis
        if ((legendWidth == 0 || legend.getPosition() != SWT.LEFT)
                && leftAxisWidth < leftAxisMarginHint) {
            leftAxisWidth = leftAxisMarginHint;
            computePlotAreaSize(r);
            updateHorizontalAxisTick();
        }
    }

    private void updateHorizontalAxisTick() {
        for (IAxis axis : horizontalAxes) {
            ((Axis) axis).getTick().updateTick(plotAreaWidth);
        }
    }

    private void updateVerticalAxisTick(){
        for (IAxis axis : verticalAxes) {
            ((Axis) axis).getTick().updateTick(plotAreaHeight);
        }
    }

    private void layoutTitle(Rectangle r) {
        int x = (int) ((r.width - titleWidth) / 2d);
        int y = MARGIN;
        int width = titleWidth;
        int height = titleHeight;

        title.setBounds(x, y, width, height);
    }

    private void layoutLegend(Rectangle r) {
        int legendPosition = legend.getPosition();

        int tHeight = titleHeight + ((titleHeight == 0) ? 0 : PADDING);
        int x;
        int y;
        if (legendPosition == SWT.RIGHT) {
            x = r.width - legendWidth - MARGIN;
            y = (tHeight + r.height - legendHeight) / 2;
        } else if (legendPosition == SWT.LEFT) {
            x = MARGIN;
            y = (tHeight + r.height - legendHeight) / 2;
        } else if (legendPosition == SWT.TOP) {
            x = (r.width - legendWidth) / 2;
            y = tHeight + MARGIN;
        } else if (legendPosition == SWT.BOTTOM) {
            x = (r.width - legendWidth) / 2;
            y = r.height - legendHeight - MARGIN;
        } else {
            throw new IllegalStateException();
        }
        int width = legendWidth;
        int height = legendHeight;

        if (y < tHeight) {
            y = tHeight;
        }

        legend.setBounds(x, y, width, height);
    }

    private void layoutPlot(Rectangle r) {
        int legendPosition = legend.getPosition();

        int x = leftAxisWidth
                + MARGIN
                + (legendPosition == SWT.LEFT ? legendWidth
                        + (legendWidth == 0 ? 0 : PADDING) : 0);
        int y = titleHeight
                + topAxisHeight
                + MARGIN
                + (titleHeight == 0 ? 0 : PADDING)
                + (legendPosition == SWT.TOP ? legendHeight
                        + (legendHeight == 0 ? 0 : PADDING) : 0);

        plot.setBounds(x, y, plotAreaWidth, plotAreaHeight);
    }

    private void layoutAxes(Rectangle r) {
        bottomAxisOffset = 0;
        topAxisOffset = 0;
        leftAxisOffset = 0;
        rightAxisOffset = 0;

        for (Axis axis : axes) {
            AxisLayoutData layoutData = axisLayoutDataMap.get(axis);
            Position position = axis.getPosition();

            if (position == Position.Primary && axis.isHorizontalAxis()) {
                layoutBottomAxis(r, layoutData);
            } else if (position == Position.Secondary
                    && axis.isHorizontalAxis()) {
                layoutTopAxis(r, layoutData);
            } else if (position == Position.Primary && !axis.isHorizontalAxis()) {
                layoutLeftAxis(r, layoutData);
            } else if (position == Position.Secondary
                    && !axis.isHorizontalAxis()) {
                layoutRightAxis(r, layoutData);
            }
        }
    }

    private void layoutBottomAxis(Rectangle r, AxisLayoutData layoutData) {
        int legendPosition = legend.getPosition();

        int height = layoutData.titleLayoutdata.heightHint;
        int x = leftAxisWidth
                + MARGIN
                + (legendPosition == SWT.LEFT ? legendWidth
                        + (legendWidth == 0 ? 0 : PADDING) : 0);
        int y = r.height
                - height
                - bottomAxisOffset
                - MARGIN
                - (legendPosition == SWT.BOTTOM ? legendHeight
                        + (legendHeight == 0 ? 0 : PADDING) : 0);

        bottomAxisOffset += height;
        if (y - layoutData.tickLabelsLayoutdata.heightHint
                - layoutData.tickMarksLayoutdata.heightHint < titleHeight
                + (titleHeight == 0 ? 0 : PADDING)) {
            y = titleHeight + (titleHeight == 0 ? 0 : PADDING)
                    + layoutData.tickLabelsLayoutdata.heightHint
                    + layoutData.tickMarksLayoutdata.heightHint;
        }
        int width = layoutData.titleLayoutdata.widthHint;
        int titleX = x + (plotAreaWidth - width) / 2;
        layoutData.axisTitle.setBounds(titleX, y, width, height);

        height = layoutData.tickLabelsLayoutdata.heightHint;
        y -= height;
        bottomAxisOffset += height;
        layoutData.axisTickLabels.setBounds(0, y, r.width, height);

        height = layoutData.tickMarksLayoutdata.heightHint;
        y -= height;
        bottomAxisOffset += height;
        layoutData.axisTickMarks.setBounds(x, y, plotAreaWidth, height);
    }

    private void layoutTopAxis(Rectangle r, AxisLayoutData layoutData) {
        int legendPosition = legend.getPosition();

        int height = layoutData.titleLayoutdata.heightHint;
        int x = leftAxisWidth
                + MARGIN
                + (legendPosition == SWT.LEFT ? legendWidth
                        + (legendWidth == 0 ? 0 : PADDING) : 0);
        int y = titleHeight + topAxisOffset + MARGIN
                + ((titleHeight == 0) ? 0 : PADDING);

        topAxisOffset += height;
        int width = layoutData.titleLayoutdata.widthHint;
        int titleX = x + (plotAreaWidth - width) / 2;
        layoutData.axisTitle.setBounds(titleX, y, width, height);

        y += height;
        height = layoutData.tickLabelsLayoutdata.heightHint;
        topAxisOffset += height;
        layoutData.axisTickLabels.setBounds(0, y, r.width, height);

        y += height;
        height = layoutData.tickMarksLayoutdata.heightHint;
        topAxisOffset += height;
        layoutData.axisTickMarks.setBounds(x, y, plotAreaWidth, height);
    }

    private void layoutLeftAxis(Rectangle r, AxisLayoutData layoutData) {
        int legendPosition = legend.getPosition();

        int yAxisMargin = Axis.MARGIN + AxisTickMarks.TICK_LENGTH;

        int width = layoutData.titleLayoutdata.widthHint;
        int x = MARGIN
                + leftAxisOffset
                + (legendPosition == SWT.LEFT ? legendWidth
                        + (legendWidth == 0 ? 0 : PADDING) : 0);
        int y = titleHeight
                + topAxisHeight
                + MARGIN
                + ((titleHeight == 0) ? 0 : PADDING)
                + (legendPosition == SWT.TOP ? legendHeight
                        + (legendHeight == 0 ? 0 : PADDING) : 0);

        leftAxisOffset += width;
        int height = layoutData.titleLayoutdata.heightHint;
        int titleY = y + (plotAreaHeight - height) / 2;
        layoutData.axisTitle.setBounds(x, titleY, width, height);

        x += width;
        width = layoutData.tickLabelsLayoutdata.widthHint;
        leftAxisOffset += width;
        layoutData.axisTickLabels.setBounds(x, y - yAxisMargin, width,
                plotAreaHeight + yAxisMargin * 2);

        x += width;
        width = layoutData.tickMarksLayoutdata.widthHint;
        leftAxisOffset += width;
        layoutData.axisTickMarks.setBounds(x, y, width, plotAreaHeight);
    }

    private void layoutRightAxis(Rectangle r, AxisLayoutData layoutData) {
        int legendPosition = legend.getPosition();

        int yAxisMargin = Axis.MARGIN + AxisTickMarks.TICK_LENGTH;

        int width = layoutData.titleLayoutdata.widthHint;
        int x = r.width
                - width
                - rightAxisOffset
                - MARGIN
                - (legendPosition == SWT.RIGHT ? legendWidth
                        + (legendWidth == 0 ? 0 : PADDING) : 0);
        int y = titleHeight
                + topAxisHeight
                + MARGIN
                + ((titleHeight == 0) ? 0 : PADDING)
                + (legendPosition == SWT.TOP ? legendHeight
                        + (legendHeight == 0 ? 0 : PADDING) : 0);

        rightAxisOffset += width;
        int height = layoutData.titleLayoutdata.heightHint;
        int titleY = y + (plotAreaHeight - height) / 2;
        layoutData.axisTitle.setBounds(x, titleY, width, height);

        width = layoutData.tickLabelsLayoutdata.widthHint;
        x -= width;
        rightAxisOffset += width;
        layoutData.axisTickLabels.setBounds(x, y - yAxisMargin, width, plotAreaHeight
                + yAxisMargin * 2);

        width = layoutData.tickMarksLayoutdata.widthHint;
        x -= width;
        rightAxisOffset += width;
        layoutData.axisTickMarks.setBounds(x, y, width, plotAreaHeight);
    }

    private static class AxisLayoutData {
    
        public AxisTickMarks axisTickMarks;
    
        public AxisTickLabels axisTickLabels;
    
        public AxisTitle axisTitle;
    
        public ChartLayoutData titleLayoutdata;
    
        public ChartLayoutData tickLabelsLayoutdata;
    
        public ChartLayoutData tickMarksLayoutdata;
    
        public AxisLayoutData(Axis axis) {
            axisTickMarks = axis.getTick().getAxisTickMarks();
            axisTickLabels = axis.getTick().getAxisTickLabels();
            axisTitle = (AxisTitle) axis.getTitle();
    
            titleLayoutdata = (ChartLayoutData) axisTitle.getLayoutData();
            tickLabelsLayoutdata = axisTickLabels.getLayoutData();
            tickMarksLayoutdata = axisTickMarks.getLayoutData();
        }
    }
}

---