net.sf.jasperreports.chartthemes.simple.LegendSettings.java Source code

Java tutorial

Introduction

Here is the source code for net.sf.jasperreports.chartthemes.simple.LegendSettings.java

Source

/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2019 TIBCO Software Inc. All rights reserved.
 * http://www.jaspersoft.com
 *
 * Unless you have purchased a commercial license agreement from Jaspersoft,
 * the following license terms apply:
 *
 * This program is part of JasperReports.
 *
 * JasperReports 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 3 of the License, or
 * (at your option) any later version.
 *
 * JasperReports 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 JasperReports. If not, see <http://www.gnu.org/licenses/>.
 */
package net.sf.jasperreports.chartthemes.simple;

import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.Serializable;

import org.jfree.chart.block.BlockFrame;
import org.jfree.ui.HorizontalAlignment;
import org.jfree.ui.RectangleInsets;
import org.jfree.ui.VerticalAlignment;

import net.sf.jasperreports.charts.type.EdgeEnum;
import net.sf.jasperreports.engine.JRConstants;
import net.sf.jasperreports.engine.JRFont;
import net.sf.jasperreports.engine.base.JRBaseFont;
import net.sf.jasperreports.engine.design.events.JRChangeEventsSupport;
import net.sf.jasperreports.engine.design.events.JRPropertyChangeSupport;

/**
 * @author Teodor Danciu (teodord@users.sourceforge.net)
 */
public class LegendSettings implements JRChangeEventsSupport, Serializable {
    /**
     * 
     */
    private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;

    public static final String PROPERTY_showLegend = "showLegend";
    public static final String PROPERTY_position = "position";
    public static final String PROPERTY_foregroundPaint = "foregroundPaint";
    public static final String PROPERTY_backgroundPaint = "backgroundPaint";
    public static final String PROPERTY_font = "font";
    public static final String PROPERTY_horizontalAlignment = "horizontalAlignment";
    public static final String PROPERTY_verticalAlignment = "verticalAlignment";

    /**
     * @deprecated replaced by {@link #PROPERTY_frame}
     */
    @Deprecated
    public static final String PROPERTY_blockFrame = "blockFrame";

    public static final String PROPERTY_frame = "frame";
    public static final String PROPERTY_padding = "padding";

    /**
     *
     */
    private Boolean showLegend;
    private EdgeEnum positionValue;
    private PaintProvider foregroundPaint;
    private PaintProvider backgroundPaint;
    private JRFont font = new JRBaseFont();
    private HorizontalAlignment horizontalAlignment;
    private VerticalAlignment verticalAlignment;

    /**
     * @deprecated replaced by {@link #frame}
     */
    @Deprecated
    private BlockFrame blockFrame;

    private BlockFrameProvider frame;

    private RectangleInsets padding;

    /**
     *
     */
    public LegendSettings() {
    }

    /**
     *
     */
    public Boolean getShowLegend() {
        return showLegend;
    }

    /**
     *
     */
    public void setShowLegend(Boolean showLegend) {
        Boolean old = getShowLegend();
        this.showLegend = showLegend;
        getEventSupport().firePropertyChange(PROPERTY_showLegend, old, getShowLegend());
    }

    /**
     * @return the backgroundPaint
     */
    public PaintProvider getBackgroundPaint() {
        return backgroundPaint;
    }

    /**
     * @param backgroundPaint the backgroundPaint to set
     */
    public void setBackgroundPaint(PaintProvider backgroundPaint) {
        PaintProvider old = getBackgroundPaint();
        this.backgroundPaint = backgroundPaint;
        getEventSupport().firePropertyChange(PROPERTY_backgroundPaint, old, getBackgroundPaint());
    }

    /**
     * @return the font
     */
    public JRFont getFont() {
        return font;
    }

    /**
     * @param font the font to set
     */
    public void setFont(JRFont font) {
        JRFont old = getFont();
        this.font = font;
        getEventSupport().firePropertyChange(PROPERTY_font, old, getFont());
    }

    /**
     * @return the foregroundPaint
     */
    public PaintProvider getForegroundPaint() {
        return foregroundPaint;
    }

    /**
     * @param foregroundPaint the foregroundPaint to set
     */
    public void setForegroundPaint(PaintProvider foregroundPaint) {
        PaintProvider old = getForegroundPaint();
        this.foregroundPaint = foregroundPaint;
        getEventSupport().firePropertyChange(PROPERTY_foregroundPaint, old, getForegroundPaint());
    }

    /**
     * @return the horizontalAlignment
     */
    public HorizontalAlignment getHorizontalAlignment() {
        return horizontalAlignment;
    }

    /**
     * @param horizontalAlignment the horizontalAlignment to set
     */
    public void setHorizontalAlignment(HorizontalAlignment horizontalAlignment) {
        HorizontalAlignment old = getHorizontalAlignment();
        this.horizontalAlignment = horizontalAlignment;
        getEventSupport().firePropertyChange(PROPERTY_horizontalAlignment, old, getHorizontalAlignment());
    }

    /**
     * @return the position
     */
    public EdgeEnum getPositionValue() {
        return positionValue;
    }

    /**
     * @param positionValue the position to set
     */
    public void setPosition(EdgeEnum positionValue) {
        EdgeEnum old = this.positionValue;
        this.positionValue = positionValue;
        getEventSupport().firePropertyChange(PROPERTY_position, old, this.positionValue);
    }

    private transient JRPropertyChangeSupport eventSupport;

    @Override
    public JRPropertyChangeSupport getEventSupport() {
        synchronized (this) {
            if (eventSupport == null) {
                eventSupport = new JRPropertyChangeSupport(this);
            }
        }

        return eventSupport;
    }

    /**
     * @return the blockFrame
     */
    public BlockFrame getBlockFrame() {
        return frame == null ? null : frame.getBlockFrame();
    }

    /**
     * @param blockFrame the blockFrame to set
     * @deprecated replaced by {@link #setFrame(BlockFrameProvider)}
     */
    @Deprecated
    public void setBlockFrame(BlockFrame blockFrame) {
        BlockFrameWrapper frameProvider = new BlockFrameWrapper(blockFrame);
        setFrame(frameProvider);
    }

    public BlockFrameProvider getFrame() {
        return frame;
    }

    public void setFrame(BlockFrameProvider frame) {
        BlockFrameProvider old = this.frame;
        this.frame = frame;
        getEventSupport().firePropertyChange(PROPERTY_frame, old, this.frame);
    }

    /**
     * @return the padding
     */
    public RectangleInsets getPadding() {
        return padding;
    }

    /**
     * @param padding the padding to set
     */
    public void setPadding(RectangleInsets padding) {
        RectangleInsets old = getPadding();
        this.padding = padding;
        getEventSupport().firePropertyChange(PROPERTY_padding, old, getPadding());
    }

    /**
     * @return the verticalAlignment
     */
    public VerticalAlignment getVerticalAlignment() {
        return verticalAlignment;
    }

    /**
     * @param verticalAlignment the verticalAlignment to set
     */
    public void setVerticalAlignment(VerticalAlignment verticalAlignment) {
        VerticalAlignment old = getVerticalAlignment();
        this.verticalAlignment = verticalAlignment;
        getEventSupport().firePropertyChange(PROPERTY_verticalAlignment, old, getVerticalAlignment());
    }

    /*
     * These fields are only for serialization backward compatibility.
     */
    private int PSEUDO_SERIAL_VERSION_UID = JRConstants.PSEUDO_SERIAL_VERSION_UID; //NOPMD
    /**
     * @deprecated
     */
    private Byte position;

    @SuppressWarnings("deprecation")
    private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException {
        in.defaultReadObject();

        if (PSEUDO_SERIAL_VERSION_UID < JRConstants.PSEUDO_SERIAL_VERSION_UID_3_7_2) {
            positionValue = EdgeEnum.getByValue(position);

            position = null;

        }

        if (blockFrame != null && frame == null)// check version?
        {
            frame = new BlockFrameWrapper(blockFrame);
            blockFrame = null;
        }
    }

}