com.google.gwt.maps.client.events.weatherlibmouse.WeatherMouseMapEvent Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gwt-maps-api Show documentation
There is a newer version: 3.10.0-alpha-7
package com.google.gwt.maps.client.events.weatherlibmouse;

/*
 * #%L
 * GWT Maps API V3 - Core API
 * %%
 * Copyright (C) 2011 - 2012 GWT Maps API V3
 * %%
 * 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%
 */

import com.google.gwt.ajaxloader.client.Properties;
import com.google.gwt.ajaxloader.client.Properties.TypeException;
import com.google.gwt.maps.client.base.LatLng;
import com.google.gwt.maps.client.base.Size;
import com.google.gwt.maps.client.events.MapEvent;
import com.google.gwt.maps.client.overlays.InfoWindow;
import com.google.gwt.maps.client.weatherlib.WeatherFeature;

/**
 * The properties of a mouse event on a WeatherLayer

 * 

 * See
 * WeatherMouseEvent API Doc
 */
public class WeatherMouseMapEvent extends MapEvent {

  public static Type TYPE = new Type();

  public WeatherMouseMapEvent(Properties properties) {
    super(properties);
  }

  @Override
  public com.google.gwt.event.shared.GwtEvent.Type getAssociatedType() {
    return TYPE;
  }

  @Override
  protected void dispatch(WeatherMouseMapHandler handler) {
    handler.onEvent(this);
  }

  /**
   * The position at which to anchor an info window on the clicked feature.
   * 
   * @return clicked position
   */
  public final LatLng getLatLng() {
    LatLng latLng = null;
    try {
      latLng = (LatLng) properties.getObject("latLng");
    } catch (TypeException e) {
    }
    return latLng;
  }

  /**
   * The offset to apply to an info window anchored on the clicked feature.
   * 
   * @return pixel offset of info window anchor
   */
  public final Size getPixelOffset() {
    Size size = null;
    try {
      size = (Size) properties.getObject("pixelOffset");
    } catch (TypeException e) {
    }
    return size;
  }

  /**
   * Pre-rendered HTML content to display within a feature's {@link InfoWindow} when clicked.
   */
  public String getInfoWindowHtml() {
    String infoWindowHtml = null;
    try {
      infoWindowHtml = properties.getString("infoWindowHtml");
    } catch (TypeException e) {
    }
    return infoWindowHtml;
  }

  /**
   * The offset to apply to an info window anchored on the clicked feature.
   * 
   * @return weather information for the clicked location
   */
  public final WeatherFeature getFeatureDetails() {
    WeatherFeature feature = null;
    try {
      feature = (WeatherFeature) properties.getObject("featureDetails");
    } catch (TypeException e) {
    }
    return feature;
  }
}