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.inputplace;
23  
24  import java.util.Collection;
25  import java.util.List;
26  import java.util.Map;
27  
28  import javax.faces.application.ResourceDependency;
29  import javax.faces.context.FacesContext;
30  import javax.faces.event.AjaxBehaviorEvent;
31  import javax.faces.event.FacesEvent;
32  
33  import org.primefaces.component.api.AbstractPrimeHtmlInputText;
34  import org.primefaces.component.api.MixedClientBehaviorHolder;
35  import org.primefaces.component.api.RTLAware;
36  import org.primefaces.component.api.Widget;
37  import org.primefaces.event.SelectEvent;
38  import org.primefaces.extensions.model.inputplace.Place;
39  import org.primefaces.extensions.util.Constants;
40  import org.primefaces.util.LangUtils;
41  
42  @ResourceDependency(library = "primefaces", name = "components.css")
43  @ResourceDependency(library = "primefaces", name = "jquery/jquery.js")
44  @ResourceDependency(library = "primefaces", name = "jquery/jquery-plugins.js")
45  @ResourceDependency(library = "primefaces", name = "core.js")
46  @ResourceDependency(library = Constants.LIBRARY, name = "inputplace/inputplace.css")
47  @ResourceDependency(library = Constants.LIBRARY, name = "inputplace/inputplace.js")
48  public class InputPlace extends AbstractPrimeHtmlInputText implements Widget, MixedClientBehaviorHolder, RTLAware {
49  
50      public static final String COMPONENT_TYPE = "org.primefaces.extensions.component.InputPlace";
51      public static final String COMPONENT_FAMILY = "org.primefaces.extensions.component";
52      public static final String DEFAULT_RENDERER = "org.primefaces.extensions.component.InputPlaceRenderer";
53      public static final String STYLE_CLASS = "ui-inputfield ui-inputtext ui-widget ui-state-default ui-corner-all";
54      public static final String EVENT_PLACE_CHANGED = "placeChanged";
55      private static final List<String> UNOBSTRUSIVE_EVENT_NAMES = LangUtils.unmodifiableList(EVENT_PLACE_CHANGED);
56      private static final Collection<String> EVENT_NAMES = LangUtils.concat(AbstractPrimeHtmlInputText.EVENT_NAMES, UNOBSTRUSIVE_EVENT_NAMES);
57  
58      // @formatter:off
59      @SuppressWarnings("java:S115")
60      public enum PropertyKeys {
61          apiType,
62          apiKey,
63          placeholder,
64          restrictCountries,
65          restrictTypes,
66          onplacechanged,
67          widgetVar
68      }
69      // @formatter:on
70  
71      public InputPlace() {
72          setRendererType(DEFAULT_RENDERER);
73      }
74  
75      @Override
76      public String getFamily() {
77          return COMPONENT_FAMILY;
78      }
79  
80      @Override
81      public String getDefaultEventName() {
82          return EVENT_PLACE_CHANGED;
83      }
84  
85      @Override
86      public Collection<String> getEventNames() {
87          return EVENT_NAMES;
88      }
89  
90      @Override
91      public Collection<String> getUnobstrusiveEventNames() {
92          return UNOBSTRUSIVE_EVENT_NAMES;
93      }
94  
95      public String getPlaceholder() {
96          return (String) getStateHelper().eval(PropertyKeys.placeholder, null);
97      }
98  
99      public void setPlaceholder(String placeholder) {
100         getStateHelper().put(PropertyKeys.placeholder, placeholder);
101     }
102 
103     public String getWidgetVar() {
104         return (String) getStateHelper().eval(PropertyKeys.widgetVar, null);
105     }
106 
107     public void setWidgetVar(String widgetVar) {
108         getStateHelper().put(PropertyKeys.widgetVar, widgetVar);
109     }
110 
111     public String getRestrictCountries() {
112         return (String) getStateHelper().eval(PropertyKeys.restrictCountries, null);
113     }
114 
115     public void setRestrictCountries(String restrictCountries) {
116         getStateHelper().put(PropertyKeys.restrictCountries, restrictCountries);
117     }
118 
119     public String getRestrictTypes() {
120         return (String) getStateHelper().eval(PropertyKeys.restrictTypes, null);
121     }
122 
123     public void setRestrictTypes(String restrictTypes) {
124         getStateHelper().put(PropertyKeys.restrictTypes, restrictTypes);
125     }
126 
127     public String getApiType() {
128         return (String) getStateHelper().eval(PropertyKeys.apiType, "google");
129     }
130 
131     public void setApiType(String apiType) {
132         getStateHelper().put(PropertyKeys.apiType, apiType);
133     }
134 
135     public String getApiKey() {
136         return (String) getStateHelper().eval(PropertyKeys.apiKey, null);
137     }
138 
139     public void setApiKey(String apiKey) {
140         getStateHelper().put(PropertyKeys.apiKey, apiKey);
141     }
142 
143     public String getOnplacechanged() {
144         return (String) getStateHelper().eval(PropertyKeys.onplacechanged, null);
145     }
146 
147     public void setOnplacechanged(final String _onplacechanged) {
148         getStateHelper().put(PropertyKeys.onplacechanged, _onplacechanged);
149     }
150 
151     @Override
152     public void queueEvent(final FacesEvent event) {
153         final FacesContext context = getFacesContext();
154         final Map<String, String> params = context.getExternalContext().getRequestParameterMap();
155         final String eventName = params.get(org.primefaces.util.Constants.RequestParams.PARTIAL_BEHAVIOR_EVENT_PARAM);
156 
157         if (eventName != null && event instanceof AjaxBehaviorEvent) {
158             final AjaxBehaviorEvent ajaxBehaviorEvent = (AjaxBehaviorEvent) event;
159 
160             if (EVENT_PLACE_CHANGED.equals(eventName)) {
161                 final Place selectedPlace = new Place(getClientId(context), params);
162                 final SelectEvent<Place> selectEvent = new SelectEvent<>(this, ajaxBehaviorEvent.getBehavior(), selectedPlace);
163                 selectEvent.setPhaseId(ajaxBehaviorEvent.getPhaseId());
164                 super.queueEvent(selectEvent);
165             }
166             else {
167                 // e.g. blur, focus, change
168                 super.queueEvent(event);
169             }
170         }
171         else {
172             // e.g. valueChange
173             super.queueEvent(event);
174         }
175     }
176 }