gwt.material.design.incubator.client.google.addresslookup.AddressLookup Maven / Gradle / Ivy
/*
* #%L
* GwtMaterial
* %%
* Copyright (C) 2015 - 2018 GwtMaterialDesign
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package gwt.material.design.incubator.client.google.addresslookup;
import com.google.gwt.event.shared.HandlerRegistration;
import gwt.material.design.client.ui.MaterialTextBox;
import gwt.material.design.incubator.client.google.addresslookup.constants.AddressComponentType;
import gwt.material.design.incubator.client.google.addresslookup.constants.AddressType;
import gwt.material.design.incubator.client.google.addresslookup.events.AddressLookupEvents;
import gwt.material.design.incubator.client.google.addresslookup.events.HasAddressLookupHandlers;
import gwt.material.design.incubator.client.google.addresslookup.events.PlaceChangedEvent;
import gwt.material.design.incubator.client.google.addresslookup.js.JsAddressLookup;
import gwt.material.design.incubator.client.google.addresslookup.js.options.AddressLookupOptions;
import gwt.material.design.incubator.client.google.addresslookup.js.options.ComponentRestrictions;
import gwt.material.design.incubator.client.google.addresslookup.js.options.LatLngBounds;
import gwt.material.design.incubator.client.google.addresslookup.js.options.PlaceResult;
import gwt.material.design.incubator.client.google.addresslookup.js.options.result.GeocoderAddressComponent;
/**
* A service to provide Place predictions based on a user's text input. It attaches to an input element of type text,
* and listens for text entry in that field. The list of predictions is presented as a drop-down list, and is updated
* as text is entered.
*
*
UiBinder
*
* {@code
*
* Java - Loading the API
*
* {@code
* @literal @UiField
* AddressLookup addressLookup;
*
* // Loading API
* ApiRegistry.register(new AddressLookupApi("AIzaSyCcFsjlqr-DR6acrZ8xZKhXNGxeS3nDmIE"), new Callback() {
* @literal @Override
* public void onFailure(Exception exception) {
* MaterialToast.fireToast(exception.getMessage());
* }
*
* @literal @Override
* public void onSuccess(Void aVoid) {
* addressLookup.load();
* }
* });
* }
*
*
*
* Note: This component is under the incubation process and subject to change.
*
*
* @author kevzlou7979
* @see AddressLookup
*/
public class AddressLookup extends MaterialTextBox
implements HasAddressLookupHandlers {
private JsAddressLookup addressLookup;
private AddressLookupOptions options;
public AddressLookup() {
setPlaceholder("");
}
/**
* Creates a new instance of AddressLookup that attaches to the specified input text field with the given options.
*/
public AddressLookup(AddressLookupOptions options) {
this();
setOptions(options);
}
public void load() {
addressLookup = new JsAddressLookup(valueBoxBase.getElement(), options);
addressLookup.addListener(AddressLookupEvents.PLACE_CHANGED, () -> PlaceChangedEvent.fire(AddressLookup.this));
}
/**
* Gets the option for look up widget
*/
public AddressLookupOptions getOptions() {
return options;
}
/**
* Sets the option for look up widget
*/
public void setOptions(AddressLookupOptions options) {
this.options = options;
}
/**
* Returns the bounds to which predictions are biased.
*/
public LatLngBounds getBounds() {
return addressLookup.getBounds();
}
/**
* Returns the details of the Place selected by user if the details were successfully retrieved. Otherwise returns
* a stub Place object, with the name property set to the current value of the input field.
*/
public PlaceResult getPlace() {
return addressLookup.getPlace();
}
/**
* Sets the preferred area within which to return Place results. Results are biased towards, but not restricted to,
* this area.
*/
public void setBounds(LatLngBounds bounds) {
addressLookup.setBounds(bounds);
}
/**
* Sets the component restrictions. Component restrictions are used to restrict predictions to only those within
* the parent component. E.g., the country.
*/
public void setComponentRestrictions(ComponentRestrictions restrictions) {
addressLookup.setComponentRestrictions(restrictions);
}
/**
* Sets the types of predictions to be returned. For a list of supported types, see the
* developer's guide. If no
* type is specified, all types will be returned. The setTypes method accepts a single element array.
*/
public void setTypes(AddressType... types) {
addressLookup.setTypes(types);
}
/**
* Will identify the {@link GeocoderAddressComponent} and will return it's value based on {@link AddressComponentType}
*/
public GeocoderAddressComponent getAddressComponent(AddressComponentType addressComponentType) {
for (GeocoderAddressComponent component : getPlace().getAddressComponents()) {
for (String type : component.getTypes()) {
if (addressComponentType.getName().equals(type)) {
return component;
}
}
}
return null;
}
@Override
public HandlerRegistration addPlaceChangedHandler(PlaceChangedEvent.PlaceChangedHandler handler) {
return addHandler(handler, PlaceChangedEvent.getType());
}
}