View Javadoc

1   /**
2    * Copyright 2005-2013 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.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/ecl2.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.krad.uif.element;
17  
18  import org.kuali.rice.krad.datadictionary.parse.BeanTag;
19  import org.kuali.rice.krad.datadictionary.parse.BeanTagAttribute;
20  
21  /**
22   * ValidationMessages for logic and options specific to pages
23   * TODO this class is currently a placeholder for possible future functionality (ex. flatValidationMessages)
24   */
25  @BeanTag(name = "pageValidationMessages-bean", parent = "Uif-PageValidationMessages")
26  public class PageValidationMessages extends GroupValidationMessages {
27  
28      private boolean showPageSummaryHeader;
29  
30      /**
31       * If true, shows the page summary header (message count header message in the message block).  Otherwise, this
32       * header is not rendered.
33       *
34       * @return true if the header will show, false otherwise
35       */
36      @BeanTagAttribute(name = "showPageSummaryHeader")
37      public boolean isShowPageSummaryHeader() {
38          return showPageSummaryHeader;
39      }
40  
41      /**
42       * Set the page summary header to show or not show.
43       *
44       * @param showPageSummaryHeader
45       */
46      public void setShowPageSummaryHeader(boolean showPageSummaryHeader) {
47          this.showPageSummaryHeader = showPageSummaryHeader;
48      }
49  
50      /**
51       * @see org.kuali.rice.krad.uif.component.ComponentBase#copy()
52       */
53      @Override
54      protected <T> void copyProperties(T component) {
55          super.copyProperties(component);
56          PageValidationMessages pageValidationMessagesCopy = (PageValidationMessages) component;
57          pageValidationMessagesCopy.setShowPageSummaryHeader(this.showPageSummaryHeader);
58      }
59  }