← Back to branch summary

~brian-thomason/+junk/jasperreports3.7

« back to all changes in this revision

Viewing changes to src/net/sf/jasperreports/engine/type/FooterPositionEnum.java

  • Committer: Brian Thomason
  • Date: 2011-12-20 17:51:16 UTC
  • Revision ID: brian.thomason@canonical.com-20111220175116-apwo6unuaedvgzo3
Initial import

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/net/sf/jasperreports/engine/type/FooterPositionEnum.java
 
1
/*
 
2
 * JasperReports - Free Java Reporting Library.
 
3
 * Copyright (C) 2001 - 2009 Jaspersoft Corporation. All rights reserved.
 
4
 * http://www.jaspersoft.com
 
5
 *
 
6
 * Unless you have purchased a commercial license agreement from Jaspersoft,
 
7
 * the following license terms apply:
 
8
 *
 
9
 * This program is part of JasperReports.
 
10
 *
 
11
 * JasperReports is free software: you can redistribute it and/or modify
 
12
 * it under the terms of the GNU Lesser General Public License as published by
 
13
 * the Free Software Foundation, either version 3 of the License, or
 
14
 * (at your option) any later version.
 
15
 *
 
16
 * JasperReports is distributed in the hope that it will be useful,
 
17
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 
19
 * GNU Lesser General Public License for more details.
 
20
 * 
 
21
 * You should have received a copy of the GNU Lesser General Public License
 
22
 * along with JasperReports. If not, see <http://www.gnu.org/licenses/>.
 
23
 */
 
24
package net.sf.jasperreports.engine.type;
 
25
 
 
26
import net.sf.jasperreports.engine.JRConstants;
 
27
 
 
28
 
 
29
/**
 
30
 * @author Teodor Danciu (teodord@users.sourceforge.net)
 
31
 * @version $Id: JasperCompileManager.java 3033 2009-08-27 11:46:22Z teodord $
 
32
 */
 
33
public enum FooterPositionEnum implements JREnum
 
34
{
 
35
        /**
 
36
         * The group footer section is rendered at normal position, just right after the last detail 
 
37
         * or right after the nested group footer section.
 
38
         */
 
39
        NORMAL((byte)1, "Normal"),
 
40
 
 
41
        /**
 
42
         * The group footer section is rendered at bottom of the current page, provided that an inner group 
 
43
         * having this value would force outer group footers to stack at the bottom of the current page, 
 
44
         * regardless of the outer group footer setting.
 
45
         */
 
46
        STACK_AT_BOTTOM((byte)2 ,"StackAtBottom"),
 
47
 
 
48
        /**
 
49
         * The group footer section is rendered at bottom of the current page, provided that an inner group 
 
50
         * having this value would render its footer right at the bottom of the page, forcing the outer group 
 
51
         * footers to render on the next page.
 
52
         */
 
53
        FORCE_AT_BOTTOM((byte)3, "ForceAtBottom"),
 
54
 
 
55
        /**
 
56
         * The group footer section is rendered at bottom of the current page, provided that the outer footers
 
57
         * have a similar footer display option to render at the page bottom as well, because otherwise, they cannot
 
58
         * be forced to change their behavior in any way.
 
59
         */
 
60
        COLLATE_AT_BOTTOM((byte)4, "CollateAtBottom");
 
61
 
 
62
        /**
 
63
         *
 
64
         */
 
65
        private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
 
66
        private final transient byte value;
 
67
        private final transient String name;
 
68
 
 
69
        private FooterPositionEnum(byte value, String name)
 
70
        {
 
71
                this.value = value;
 
72
                this.name = name;
 
73
        }
 
74
 
 
75
        /**
 
76
         *
 
77
         */
 
78
        public Byte getValueByte()
 
79
        {
 
80
                return new Byte(value);
 
81
        }
 
82
        
 
83
        /**
 
84
         *
 
85
         */
 
86
        public final byte getValue()
 
87
        {
 
88
                return value;
 
89
        }
 
90
        
 
91
        /**
 
92
         *
 
93
         */
 
94
        public String getName()
 
95
        {
 
96
                return name;
 
97
        }
 
98
        
 
99
        /**
 
100
         *
 
101
         */
 
102
        public static FooterPositionEnum getByName(String name)
 
103
        {
 
104
                return (FooterPositionEnum)EnumUtil.getByName(values(), name);
 
105
        }
 
106
        
 
107
        /**
 
108
         *
 
109
         */
 
110
        public static FooterPositionEnum getByValue(Byte value)
 
111
        {
 
112
                return (FooterPositionEnum)EnumUtil.getByValue(values(), value);
 
113
        }
 
114
        
 
115
        /**
 
116
         *
 
117
         */
 
118
        public static FooterPositionEnum getByValue(byte value)
 
119
        {
 
120
                return getByValue(new Byte(value));
 
121
        }
 
122
        
 
123
}