1 /*
2  * JasperReports - Free Java Reporting Library.
3  * Copyright (C) 2001 - 2019 TIBCO Software Inc. 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
27 /**
28  * @author Teodor Danciu (teodord@users.sourceforge.net)
29  */
30 public enum FooterPositionEnum implements JREnum
31 {
32     /**
33      * The group footer section is rendered at normal position, just right after the last detail 
34      * or right after the nested group footer section.
35      */
36     NORMAL((byte)1, "Normal"),
37
38     /**
39      * The group footer section is rendered at bottom of the current page, provided that an inner group 
40      * having this value would force outer group footers to stack at the bottom of the current page, 
41      * regardless of the outer group footer setting.
42      */
43     STACK_AT_BOTTOM((byte)2 ,"StackAtBottom"),
44
45     /**
46      * The group footer section is rendered at bottom of the current page, provided that an inner group 
47      * having this value would render its footer right at the bottom of the page, forcing the outer group 
48      * footers to render on the next page.
49      */
50     FORCE_AT_BOTTOM((byte)3, "ForceAtBottom"),
51
52     /**
53      * The group footer section is rendered at bottom of the current page, provided that the outer footers
54      * have a similar footer display option to render at the page bottom as well, because otherwise, they cannot
55      * be forced to change their behavior in any way.
56      */
57     COLLATE_AT_BOTTOM((byte)4, "CollateAtBottom");
58
59     /**
60      *
61      */
62     private final transient byte value;
63     private final transient String name;
64
65     private FooterPositionEnum(byte value, String name)
66     {
67         this.value = value;
68         this.name = name;
69     }
70
71     /**
72      * @deprecated Used only by deprecated serialized fields.
73      */
74     @Override
75     public Byte getValueByte()
76     {
77         return value;
78     }
79     
80     /**
81      * @deprecated Used only by deprecated serialized fields.
82      */
83     @Override
84     public final byte getValue()
85     {
86         return value;
87     }
88     
89     @Override
90     public String getName()
91     {
92         return name;
93     }
94     
95     /**
96      *
97      */
98     public static FooterPositionEnum getByName(String name)
99     {
100         return EnumUtil.getEnumByName(values(), name);
101     }
102     
103     /**
104      * @deprecated Used only by deprecated serialized fields.
105      */
106     public static FooterPositionEnum getByValue(Byte value)
107     {
108         return (FooterPositionEnum)EnumUtil.getByValue(values(), value);
109     }
110     
111     /**
112      * @deprecated Used only by deprecated serialized fields.
113      */
114     public static FooterPositionEnum getByValue(byte value)
115     {
116         return getByValue((Byte)value);
117     }
118 }
119