com.google.gwt.maps.client.adsense.AdUnitWidget 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.adsense;

/*
 * #%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.dom.client.Element;
import com.google.gwt.event.shared.HandlerRegistration;
import com.google.gwt.maps.client.MapWidget;
import com.google.gwt.maps.client.controls.ControlPosition;
import com.google.gwt.maps.client.events.channelnumber.ChannelNumberChangeMapHandler;
import com.google.gwt.maps.client.events.format.FormatChangeMapHandler;
import com.google.gwt.maps.client.events.mapchange.MapChangeMapHandler;
import com.google.gwt.maps.client.events.position.PositionChangeMapHandler;
import com.google.gwt.maps.client.mvc.MVCObjectWidget;
import com.google.gwt.user.client.DOM;

/**
 * Implements AdSense for Content advertising on an associated map. To use an AdUnit, you must obtain and specify an
 * AdSense for Content publisher ID within the AdUnit's constructor options. This class extends MVCObject. 

 * 

 * See AdUnit API Doc
 */
public class AdUnitWidget extends MVCObjectWidget {

  /**
   * jso
   */
  private AdUnitImpl impl;

  /**
   * create AdUnit widget
   * 
   * @param options
   */
  public AdUnitWidget(AdUnitOptions options) {
    Element div = DOM.createDiv();
    impl = AdUnitImpl.newInstance(div, options);
    setElement(div);
  }

  /**
   * This event is fired when the AdUnit's channelNumber property changes.
   * 
   * @param handler
   */
  public final HandlerRegistration addChannelNumberChangeHandler(ChannelNumberChangeMapHandler handler) {
    return impl.addChannelNumberChangeHandler(handler);
  }

  /**
   * This event is fired when the AdUnit's format property changes.
   * 
   * @param handler
   */
  public final HandlerRegistration addFormatChangeHandler(FormatChangeMapHandler handler) {
    return impl.addFormatChangeHandler(handler);
  }

  /**
   * This event is fired when the AdUnit's map property changes.
   * 
   * @param handler
   */
  public final HandlerRegistration addMapChangeHandler(MapChangeMapHandler handler) {
    return impl.addMapChangeHandler(handler);
  }

  /**
   * This event is fired when the AdUnit's position property changes.
   * 
   * @param handler
   */
  public final HandlerRegistration addPositionChangeHandler(PositionChangeMapHandler handler) {
    return impl.addPositionChangeHandler(handler);
  }

  /**
   * Returns the channel number in use by this AdUnit.
   */
  public final String getChannelNumber() {
    return impl.getChannelNumber();
  };

  /**
   * Returns the containing element of the AdUnit.
   */
  public final Element getContainer() {
    return impl.getContainer();
  };

  /**
   * Returns the format in use by this AdUnit.
   */
  public final AdFormat getFormat() {
    return impl.getFormat();
  };

  /**
   * Returns the map to which this AdUnit's ads are targeted.
   */
  public final MapWidget getMap() {
    return impl.getMap();
  }

  /**
   * Returns the ControlPosition at which this AdUnit is displayed on the map.
   */
  public final ControlPosition getPosition() {
    return impl.getPosition();
  }

  /**
   * Returns the specified AdSense For Content publisher ID.
   */
  public final String getPublisherId() {
    return impl.getPublisherId();
  };

  /**
   * Specifies the channel number for this AdUnit. Channel numbers are optional and can be created for Google AdSense
   * tracking.
   * 
   * @param channelNumber
   */
  public final void setChannelNumber(String channelNumber) {
    impl.setChannelNumber(channelNumber);
  };

  /**
   * Specifies the display format for this AdUnit.
   * 
   * @param format
   */
  public final void setFormat(AdFormat format) {
    impl.setFormat(format);
  };

  /**
   * Associates this AdUnit with the specified map. Ads will be targeted to the map's viewport. The map must be
   * specified in order to display ads.
   * 
   * @param mapWidget
   */
  public final void setMap(MapWidget mapWidget) {
    impl.setMap(mapWidget);
  }

  /**
   * Sets the ControlPosition at which to display the AdUnit on the map. If the position is set to null, the AdUnit is
   * removed from the map.
   * 
   * @param position {@link ControlPosition}
   */
  public final void setPosition(ControlPosition position) {
    impl.setPosition(position);
  }

}