com.google.gwt.maps.client.adsense

Class AdUnitWidget

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.maps.client.mvc.MVCObjectWidget<AdUnitImpl>

com.google.gwt.maps.client.adsense.AdUnitWidget

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, EventListener, HasVisibility, IsWidget

public class AdUnitWidget
extends MVCObjectWidget<AdUnitImpl>

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

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
AdUnitWidget(AdUnitOptions options) create AdUnit widget

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addChannelNumberChangeHandler(ChannelNumberChangeMapHandler handler) This event is fired when the AdUnit's channelNumber property changes.
HandlerRegistration	addFormatChangeHandler(FormatChangeMapHandler handler) This event is fired when the AdUnit's format property changes.
HandlerRegistration	addMapChangeHandler(MapChangeMapHandler handler) This event is fired when the AdUnit's map property changes.
HandlerRegistration	addPositionChangeHandler(PositionChangeMapHandler handler) This event is fired when the AdUnit's position property changes.
String	getChannelNumber() Returns the channel number in use by this AdUnit.
Element	getContainer() Returns the containing element of the AdUnit.
AdFormat	getFormat() Returns the format in use by this AdUnit.
MapWidget	getMap() Returns the map to which this AdUnit's ads are targeted.
ControlPosition	getPosition() Returns the ControlPosition at which this AdUnit is displayed on the map.
String	getPublisherId() Returns the specified AdSense For Content publisher ID.
void	setChannelNumber(String channelNumber) Specifies the channel number for this AdUnit.
void	setFormat(AdFormat format) Specifies the display format for this AdUnit.
void	setMap(MapWidget mapWidget) Associates this AdUnit with the specified map.
void	setPosition(ControlPosition position) Sets the ControlPosition at which to display the AdUnit on the map.

Methods inherited from class com.google.gwt.maps.client.mvc.MVCObjectWidget

getMVCObject

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AdUnitWidget

public AdUnitWidget(AdUnitOptions options)

create AdUnit widget

Parameters:

options -

Method Detail

addChannelNumberChangeHandler

public final HandlerRegistration addChannelNumberChangeHandler(ChannelNumberChangeMapHandler handler)

This event is fired when the AdUnit's channelNumber property changes.

Parameters:

handler -

addFormatChangeHandler

public final HandlerRegistration addFormatChangeHandler(FormatChangeMapHandler handler)

This event is fired when the AdUnit's format property changes.

Parameters:

handler -

addMapChangeHandler

public final HandlerRegistration addMapChangeHandler(MapChangeMapHandler handler)

This event is fired when the AdUnit's map property changes.

Parameters:

handler -

addPositionChangeHandler

public final HandlerRegistration addPositionChangeHandler(PositionChangeMapHandler handler)

This event is fired when the AdUnit's position property changes.

Parameters:

handler -

getChannelNumber

public final String getChannelNumber()

Returns the channel number in use by this AdUnit.

getContainer

public final Element getContainer()

Returns the containing element of the AdUnit.

getFormat

public final AdFormat getFormat()

Returns the format in use by this AdUnit.

getMap

public final MapWidget getMap()

Returns the map to which this AdUnit's ads are targeted.

getPosition

public final ControlPosition getPosition()

Returns the ControlPosition at which this AdUnit is displayed on the map.

getPublisherId

public final String getPublisherId()

Returns the specified AdSense For Content publisher ID.

setChannelNumber

public final void setChannelNumber(String channelNumber)

Specifies the channel number for this AdUnit. Channel numbers are optional and can be created for Google AdSense tracking.

Parameters:

channelNumber -

setFormat

public final void setFormat(AdFormat format)

Specifies the display format for this AdUnit.

Parameters:

format -

setMap

public final void setMap(MapWidget mapWidget)

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.

Parameters:

mapWidget -

setPosition

public final void setPosition(ControlPosition position)

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.

Parameters:

position - ControlPosition