01: /*
02: * ============================================================================
03: * GNU Lesser General Public License
04: * ============================================================================
05: *
06: * JasperReports - Free Java report-generating library.
07: * Copyright (C) 2001-2006 JasperSoft Corporation http://www.jaspersoft.com
08: *
09: * This library is free software; you can redistribute it and/or
10: * modify it under the terms of the GNU Lesser General Public
11: * License as published by the Free Software Foundation; either
12: * version 2.1 of the License, or (at your option) any later version.
13: *
14: * This library is distributed in the hope that it will be useful,
15: * but WITHOUT ANY WARRANTY; without even the implied warranty of
16: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17: * Lesser General Public License for more details.
18: *
19: * You should have received a copy of the GNU Lesser General Public
20: * License along with this library; if not, write to the Free Software
21: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22: *
23: * JasperSoft Corporation
24: * 303 Second Street, Suite 450 North
25: * San Francisco, CA 94107
26: * http://www.jaspersoft.com
27: */
28:
29: /*
30: * Contributor: Manuel Paul <mpaul@ratundtat.com>,
31: * Rat & Tat Beratungsgesellschaft mbH,
32: * Muehlenkamp 6c,
33: * 22303 Hamburg,
34: * Germany.
35: */
36: package net.sf.jasperreports.engine.export;
37:
38: import net.sf.jasperreports.engine.JRExporterParameter;
39: import net.sf.jasperreports.engine.util.JRProperties;
40:
41: /**
42: * @author Manuel Paul (mpaul@ratundtat.com)
43: * @version $Id: JExcelApiExporterParameter.java 1796 2007-07-30 09:22:15Z teodord $
44: */
45: public class JExcelApiExporterParameter extends
46: JRXlsAbstractExporterParameter {
47:
48: protected JExcelApiExporterParameter(String name) {
49: super (name);
50: }
51:
52: /**
53: * A boolean value specifying whether the standard color palette should be customized
54: * so that the XLS result uses the original report colors.
55: * <p/>
56: * The default state of this flag is given by the
57: * {@link #PROPERTY_CREATE_CUSTOM_PALETTE net.sf.jasperreports.export.xls.create.custom.palette} property.
58: * <p/>
59: * The colors used in the result XLS are determined in the following manner:
60: * <ol>
61: * <li>
62: * If this flag is not set, the nearest color from the standard XLS palette is chosen
63: * for a report color.
64: * </li>
65: * <li>
66: * If the flag is set, the nearest not yet modified color from the palette is chosen
67: * and modified to exactly match the report color. If all the colors from the palette
68: * are modified (the palette has a fixed size), the nearest color from the palette is
69: * chosen for further report colors.
70: * </li>
71: * </ol>
72: *
73: * @see #PROPERTY_CREATE_CUSTOM_PALETTE
74: */
75: public static final JRExporterParameter CREATE_CUSTOM_PALETTE = new JExcelApiExporterParameter(
76: "Create Custom Palette");
77:
78: /**
79: * Property whose value is used as default state of the {@link #CREATE_CUSTOM_PALETTE CREATE_CUSTOM_PALETTE} export flag.
80: * <p/>
81: * This property is by default not set (<code>false</code>).
82: *
83: * @see JRProperties
84: */
85: public static final String PROPERTY_CREATE_CUSTOM_PALETTE = JRProperties.PROPERTY_PREFIX
86: + "export.xls.create.custom.palette";
87:
88: }
|