Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
HeaderField |
|
| 1.0;1 |
1 | /* | |
2 | * Copyright 2007 The Kuali Foundation | |
3 | * | |
4 | * Licensed under the Educational Community License, Version 1.0 (the "License"); | |
5 | * you may not use this file except in compliance with the License. | |
6 | * You may obtain a copy of the License at | |
7 | * | |
8 | * http://www.opensource.org/licenses/ecl1.php | |
9 | * | |
10 | * Unless required by applicable law or agreed to in writing, software | |
11 | * distributed under the License is distributed on an "AS IS" BASIS, | |
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
13 | * See the License for the specific language governing permissions and | |
14 | * limitations under the License. | |
15 | */ | |
16 | package org.kuali.rice.kns.uif.field; | |
17 | ||
18 | /** | |
19 | * Field that contains a header element and optionally a <code>Group</code> to | |
20 | * present along with the header text | |
21 | * | |
22 | * <p> | |
23 | * Generally the group is used to display content to the right of the header, | |
24 | * such as links for the group or other information | |
25 | * </p> | |
26 | * | |
27 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
28 | */ | |
29 | public class HeaderField extends GroupField { | |
30 | private static final long serialVersionUID = -6950408292923393244L; | |
31 | ||
32 | private String headerText; | |
33 | private String headerLevel; | |
34 | private String headerStyleClasses; | |
35 | private String headerStyle; | |
36 | ||
37 | public HeaderField() { | |
38 | 0 | super(); |
39 | 0 | } |
40 | ||
41 | /** | |
42 | * Text that should be displayed on the header | |
43 | * | |
44 | * @return String header text | |
45 | */ | |
46 | public String getHeaderText() { | |
47 | 0 | return this.headerText; |
48 | } | |
49 | ||
50 | /** | |
51 | * Setter for the header text | |
52 | * | |
53 | * @param headerText | |
54 | */ | |
55 | public void setHeaderText(String headerText) { | |
56 | 0 | this.headerText = headerText; |
57 | 0 | } |
58 | ||
59 | /** | |
60 | * HTML header level (h1 ... h6) that should be applied to the header text | |
61 | * | |
62 | * @return String header level | |
63 | */ | |
64 | public String getHeaderLevel() { | |
65 | 0 | return this.headerLevel; |
66 | } | |
67 | ||
68 | /** | |
69 | * Setter for the header level | |
70 | * | |
71 | * @param headerLevel | |
72 | */ | |
73 | public void setHeaderLevel(String headerLevel) { | |
74 | 0 | this.headerLevel = headerLevel; |
75 | 0 | } |
76 | ||
77 | /** | |
78 | * Style class that should be applied to the header text | |
79 | * | |
80 | * <p> | |
81 | * Note the style class given here applies to only the header text. The | |
82 | * style class property inherited from the <code>Component</code> interface | |
83 | * can be used to set the class for the whole header div (which could | |
84 | * include a nested <code>Group</code>) | |
85 | * </p> | |
86 | * | |
87 | * @return String style class | |
88 | * @see org.kuali.rice.kns.uif.Component.getStyleClasses() | |
89 | */ | |
90 | public String getHeaderStyleClasses() { | |
91 | 0 | return this.headerStyleClasses; |
92 | } | |
93 | ||
94 | /** | |
95 | * Setter for the header style class | |
96 | * | |
97 | * @param headerStyleClasses | |
98 | */ | |
99 | public void setHeaderStyleClasses(String headerStyleClasses) { | |
100 | 0 | this.headerStyleClasses = headerStyleClasses; |
101 | 0 | } |
102 | ||
103 | /** | |
104 | * Style that should be applied to the header text | |
105 | * | |
106 | * <p> | |
107 | * Note the style given here applies to only the header text. The style | |
108 | * property inherited from the <code>Component</code> interface can be used | |
109 | * to set the style for the whole header div (which could include a nested | |
110 | * <code>Group</code>) | |
111 | * </p> | |
112 | * | |
113 | * @return String header style | |
114 | * @see org.kuali.rice.kns.uif.Component.getStyle() | |
115 | */ | |
116 | public String getHeaderStyle() { | |
117 | 0 | return this.headerStyle; |
118 | } | |
119 | ||
120 | /** | |
121 | * Setter for the header style | |
122 | * | |
123 | * @param headerStyle | |
124 | */ | |
125 | public void setHeaderStyle(String headerStyle) { | |
126 | 0 | this.headerStyle = headerStyle; |
127 | 0 | } |
128 | ||
129 | } |