View Javadoc
1   /*
2    * Copyright (c) 2011-2024 PrimeFaces Extensions
3    *
4    *  Permission is hereby granted, free of charge, to any person obtaining a copy
5    *  of this software and associated documentation files (the "Software"), to deal
6    *  in the Software without restriction, including without limitation the rights
7    *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    *  copies of the Software, and to permit persons to whom the Software is
9    *  furnished to do so, subject to the following conditions:
10   *
11   *  The above copyright notice and this permission notice shall be included in
12   *  all copies or substantial portions of the Software.
13   *
14   *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20   *  THE SOFTWARE.
21   */
22  package org.primefaces.extensions.component.head;
23  
24  import javax.faces.component.UIOutput;
25  
26  /**
27   * Component class for the <code>ExtHead</code> component.
28   *
29   * @author Thomas Andraschko / last modified by $Author$
30   * @version $Revision$
31   * @since 0.2
32   */
33  public class ExtHead extends UIOutput {
34  
35      public static final String COMPONENT_TYPE = "org.primefaces.extensions.component.Head";
36      public static final String COMPONENT_FAMILY = "org.primefaces.extensions.component";
37      private static final String DEFAULT_RENDERER = "org.primefaces.extensions.component.HeadRenderer";
38  
39      /**
40       * Properties that are tracked by state saving.
41       *
42       * @author Thomas Andraschko / last modified by $Author$
43       * @version $Revision$
44       */
45      @SuppressWarnings("java:S115")
46      protected enum PropertyKeys {
47  
48          title, shortcutIcon;
49  
50          private String toString;
51  
52          PropertyKeys(final String toString) {
53              this.toString = toString;
54          }
55  
56          PropertyKeys() {
57          }
58  
59          @Override
60          public String toString() {
61              return toString != null ? toString : super.toString();
62          }
63      }
64  
65      public ExtHead() {
66          setRendererType(DEFAULT_RENDERER);
67      }
68  
69      @Override
70      public String getFamily() {
71          return COMPONENT_FAMILY;
72      }
73  
74      public String getTitle() {
75          return (String) getStateHelper().eval(PropertyKeys.title, null);
76      }
77  
78      public void setTitle(final String title) {
79          getStateHelper().put(PropertyKeys.title, title);
80      }
81  
82      public String getShortcutIcon() {
83          return (String) getStateHelper().eval(PropertyKeys.shortcutIcon, null);
84      }
85  
86      public void setShortcutIcon(final String shortcutIcon) {
87          getStateHelper().put(PropertyKeys.shortcutIcon, shortcutIcon);
88      }
89  
90  }