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.util;
17  
18  import org.kuali.rice.krad.uif.component.ListAware;
19  import org.kuali.rice.krad.uif.element.Header;
20  
21  import java.io.Serializable;
22  
23  /**
24   * Collection of helper methods that can be exposed to a render engine.
25   *
26   * @author Kuali Rice Team (rice.collab@kuali.org)
27   */
28  public class UifRenderHelperMethods implements Serializable {
29      private static final long serialVersionUID = 5105182075655826814L;
30  
31      /**
32       * Indicates whether the given class is a {@link org.kuali.rice.krad.uif.element.Header}
33       * component class.
34       *
35       * @param componentClass class to check
36       * @return boolean true if class is a header class, false if not
37       */
38      public boolean isHeader(Class<?> componentClass) {
39          return Header.class.isAssignableFrom(componentClass);
40      }
41  
42      /**
43       * Indicates whether the given class is a {org.kuali.rice.krad.uif.component.ListAware}
44       * component class.
45       *
46       * @param componentClass class to check
47       * @return boolean true if class is a list aware class, false if not
48       */
49      public boolean isListAware(Class<?> componentClass) {
50          return ListAware.class.isAssignableFrom(componentClass);
51      }
52  }