com.mopub.nativeads

Class MoPubAdAdapter

java.lang.Object

android.widget.BaseAdapter

com.mopub.nativeads.MoPubAdAdapter

All Implemented Interfaces:

android.widget.Adapter, android.widget.ListAdapter, android.widget.SpinnerAdapter

public class MoPubAdAdapter
extends android.widget.BaseAdapter

MoPubAdAdapter facilitates placing ads into an Android ListView or other widgets that use a ListAdapter. For your content items, this class will call your original adapter with the original position of content before ads were loaded. This adapter uses a MoPubStreamAdPlacer object internally. If you wish to avoid wrapping your original adapter, you can use MoPubStreamAdPlacer directly.

Field Summary

Fields inherited from interface android.widget.Adapter

IGNORE_ITEM_VIEW_TYPE, NO_SELECTION

Constructor Summary

Constructors

Constructor and Description
MoPubAdAdapter(android.app.Activity activity, android.widget.Adapter originalAdapter) Creates a new MoPubAdAdapter object.
MoPubAdAdapter(android.app.Activity activity, android.widget.Adapter originalAdapter, MoPubNativeAdPositioning.MoPubClientPositioning adPositioning) Creates a new MoPubAdAdapter object, using client positioning.
MoPubAdAdapter(android.app.Activity activity, android.widget.Adapter originalAdapter, MoPubNativeAdPositioning.MoPubServerPositioning adPositioning) Creates a new MoPubAdAdapter object, using server positioning.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areAllItemsEnabled()
void	clearAds() Stops loading ads, immediately clearing any ads currently in the stream.
void	destroy() Destroys the ad adapter, preventing it from future use.
int	getAdjustedPosition(int originalPosition) Returns the position of an item considering ads in the stream.
int	getCount() Returns the number of items in your stream, including ads.
java.lang.Object	getItem(int position) For ad items, returns an ad data object.
long	getItemId(int position) For ad items, returns an ID representing the ad.
int	getItemViewType(int position) For ad items, returns a number greater than or equal to the view type count for your underlying adapter.
int	getOriginalPosition(int position) Returns the original position of an item considering ads in the stream.
android.view.View	getView(int position, android.view.View view, android.view.ViewGroup viewGroup) For ad items, returns an ad View for the underlying position.
int	getViewTypeCount() Returns the view type count of your original adapter, plus the the number of possible view types for ads.
boolean	hasStableIds() Returns the value returned by hasStableIds() on your original adapter.
void	insertItem(int originalPosition) Inserts a content row at the given position, adjusting ad positions accordingly.
boolean	isAd(int position) Whether the given position is an ad.
boolean	isEmpty() Returns whether the adapter is empty, calling through to your original adapter.
boolean	isEnabled(int position)
void	loadAds(java.lang.String adUnitId) Start loading ads from the MoPub server.
void	loadAds(java.lang.String adUnitId, RequestParameters requestParameters) Start loading ads from the MoPub server, using the given request targeting information.
void	refreshAds(android.widget.ListView listView, java.lang.String adUnitId) Refreshes ads in the given ListView while preserving the scroll position.
void	refreshAds(android.widget.ListView listView, java.lang.String adUnitId, RequestParameters requestParameters) Refreshes ads in the given ListView while preserving the scroll position.
void	registerAdRenderer(MoPubAdRenderer adRenderer) Registers a MoPubStaticNativeAdRenderer, supporting a specific native ad format, to use when displaying ads in your stream.
void	removeItem(int originalPosition) Removes the content row at the given position, adjusting ad positions accordingly.
void	setAdLoadedListener(MoPubNativeAdLoadedListener listener) Sets a listener that will be called after the SDK loads new ads from the server and places them into your stream.
void	setOnClickListener(android.widget.ListView listView, android.widget.AdapterView.OnItemClickListener listener) Sets an on click listener for the given ListView, automatically adjusting the listener callback positions based on ads in the adapter.
void	setOnItemLongClickListener(android.widget.ListView listView, android.widget.AdapterView.OnItemLongClickListener listener) Sets an on long click listener for the given ListView, automatically adjusting the listener callback positions based on ads in the adapter.
void	setOnItemSelectedListener(android.widget.ListView listView, android.widget.AdapterView.OnItemSelectedListener listener) Sets an on item selected listener for the given ListView, automatically adjusting the listener callback positions based on ads in the adapter.
void	setSelection(android.widget.ListView listView, int originalPosition) Sets the currently selected item in the ListView, automatically adjusting the position based on ads in the adapter.
void	smoothScrollToPosition(android.widget.ListView listView, int originalPosition) Scrolls an item in the ListView, automatically adjusting the position based on ads in the adapter.

Methods inherited from class android.widget.BaseAdapter

getDropDownView, notifyDataSetChanged, notifyDataSetInvalidated, registerDataSetObserver, unregisterDataSetObserver

Methods inherited from class java.lang.Object

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

Constructor Detail

MoPubAdAdapter

public MoPubAdAdapter(android.app.Activity activity,
              android.widget.Adapter originalAdapter)

Creates a new MoPubAdAdapter object. By default, the adapter will contact the server to determine ad positions. If you wish to hard-code positions in your app, see MoPubAdAdapter(Context, MoPubClientPositioning).

Parameters:

activity - The activity.

originalAdapter - Your original adapter.

MoPubAdAdapter

public MoPubAdAdapter(android.app.Activity activity,
              android.widget.Adapter originalAdapter,
              MoPubNativeAdPositioning.MoPubServerPositioning adPositioning)

Creates a new MoPubAdAdapter object, using server positioning.

Parameters:

activity - The activity.

originalAdapter - Your original adapter.

adPositioning - A positioning object for specifying where ads will be placed in your stream. See MoPubNativeAdPositioning.serverPositioning().

MoPubAdAdapter

public MoPubAdAdapter(android.app.Activity activity,
              android.widget.Adapter originalAdapter,
              MoPubNativeAdPositioning.MoPubClientPositioning adPositioning)

Creates a new MoPubAdAdapter object, using client positioning.

Parameters:

activity - The activity.

originalAdapter - Your original adapter.

adPositioning - A positioning object for specifying where ads will be placed in your stream. See MoPubNativeAdPositioning.clientPositioning().

Method Detail

registerAdRenderer

public final void registerAdRenderer(MoPubAdRenderer adRenderer)

Registers a MoPubStaticNativeAdRenderer, supporting a specific native ad format, to use when displaying ads in your stream. Note that if multiple ad renderers support a specific native ad format, the first one registered will be used. This renderer will automatically create and render your view when you call getView(int, android.view.View, android.view.ViewGroup).

Parameters:

adRenderer - The ad renderer.

setAdLoadedListener

public final void setAdLoadedListener(MoPubNativeAdLoadedListener listener)

Sets a listener that will be called after the SDK loads new ads from the server and places them into your stream. The listener will be active between when you call loadAds(java.lang.String) and when you call destroy(). You can also set the listener to null to remove the listener. Note that there is not a one to one correspondence between calls to loadAds(java.lang.String) and this listener. The SDK will call the listener every time an ad loads.

Parameters:

listener - The listener.

loadAds

public void loadAds(java.lang.String adUnitId)

Start loading ads from the MoPub server. We recommend using loadAds(String, RequestParameters) instead of this method, in order to pass targeting information to the server.

Parameters:

adUnitId - The ad unit ID to use when loading ads.

loadAds

public void loadAds(java.lang.String adUnitId,
           RequestParameters requestParameters)

Start loading ads from the MoPub server, using the given request targeting information. When loading ads, MoPubNativeAdLoadedListener.onAdLoaded(int) will be called for each ad that is added to the stream. To refresh ads in your stream, call refreshAds(ListView, String). When new ads load, they will replace the current ads in your stream. If you are using MoPubNativeAdLoadedListener you will see a call to onAdRemoved for each of the old ads, followed by a calls to onAdLoaded.

Parameters:

adUnitId - The ad unit ID to use when loading ads.

requestParameters - Targeting information to pass to the ad server.

isAd

public boolean isAd(int position)

Whether the given position is an ad. This will return true only if there is an ad loaded for this position. You can also listen for ads to load using MoPubNativeAdLoadedListener.onAdLoaded(int).

Parameters:

position - The position to check for an ad, expressed in terms of the position in the stream including ads.

Returns:

Whether there is an ad at the given position.

clearAds

public void clearAds()

Stops loading ads, immediately clearing any ads currently in the stream. This method also stops ads from loading as the user moves through the stream. If you want to refresh ads, call refreshAds(ListView, String, RequestParameters) instead of this method. When ads are cleared, MoPubNativeAdLoadedListener.onAdRemoved(int) will be called for each ad that is removed from the stream.

destroy

public void destroy()

Destroys the ad adapter, preventing it from future use. You must call this method before the hosting activity for this class is destroyed in order to avoid a memory leak. Typically you should destroy the adapter in the life-cycle method that is counterpoint to the method you used to create the adapter. For example, if you created the adapter in Fragment#onCreateView you should destroy it in {code Fragment#onDestroyView}.

areAllItemsEnabled

public boolean areAllItemsEnabled()

Specified by:

areAllItemsEnabled in interface android.widget.ListAdapter

Overrides:

areAllItemsEnabled in class android.widget.BaseAdapter

isEnabled

public boolean isEnabled(int position)

Specified by:

isEnabled in interface android.widget.ListAdapter

Overrides:

isEnabled in class android.widget.BaseAdapter

getCount

public int getCount()

Returns the number of items in your stream, including ads.

Returns:

The count of items.

getItem

public java.lang.Object getItem(int position)

For ad items, returns an ad data object. For non ad items, calls you original adapter using the original item position.

getItemId

public long getItemId(int position)

For ad items, returns an ID representing the ad. For non ad items, calls your original adapter using the original item position. For ads, this ID will be a negative integer. If you feel that this ID might collide with your original adapter's IDs, you should return false from #hasStableIds().

hasStableIds

public boolean hasStableIds()

Returns the value returned by hasStableIds() on your original adapter.

Specified by:

hasStableIds in interface android.widget.Adapter

Overrides:

hasStableIds in class android.widget.BaseAdapter

getView

public android.view.View getView(int position,
                        android.view.View view,
                        android.view.ViewGroup viewGroup)

For ad items, returns an ad View for the underlying position. For non-ad items, calls your original adapter using the original ad position.

getItemViewType

public int getItemViewType(int position)

For ad items, returns a number greater than or equal to the view type count for your underlying adapter. For non-ad items, calls your original adapter using the original ad position.

Specified by:

getItemViewType in interface android.widget.Adapter

Overrides:

getItemViewType in class android.widget.BaseAdapter

getViewTypeCount

public int getViewTypeCount()

Returns the view type count of your original adapter, plus the the number of possible view types for ads. The number of possible ad view types is currently 1, but this is subject to change in future SDK versions.

Specified by:

getViewTypeCount in interface android.widget.Adapter

Overrides:

getViewTypeCount in class android.widget.BaseAdapter

isEmpty

public boolean isEmpty()

Returns whether the adapter is empty, calling through to your original adapter.

Specified by:

isEmpty in interface android.widget.Adapter

Overrides:

isEmpty in class android.widget.BaseAdapter

getOriginalPosition

public int getOriginalPosition(int position)

Returns the original position of an item considering ads in the stream.

Parameters:

position - The adjusted position.

Returns:

The original position before placing ads.

See Also:

MoPubStreamAdPlacer#getOriginalPosition(int)}

getAdjustedPosition

public int getAdjustedPosition(int originalPosition)

Returns the position of an item considering ads in the stream.

Parameters:

originalPosition - The original position.

Returns:

The position adjusted by placing ads.

See Also:

MoPubStreamAdPlacer#getAdjustedPosition(int)}

insertItem

public void insertItem(int originalPosition)

Inserts a content row at the given position, adjusting ad positions accordingly. Use this method if you are inserting an item into your stream and want to increment ad positions based on that new item. If you do not want to increment your ad positions when inserting items, you can simply call notifyDataSetChanged on the adapter and let it reload items normally. This is typically the case when inserting items at the end of your stream.

Parameters:

originalPosition - The original content position at which to add an item. If you have an adjusted position, you will need to call getOriginalPosition(int) to get this value.

See Also:

MoPubStreamAdPlacer#insertItem(int)}

removeItem

public void removeItem(int originalPosition)

Removes the content row at the given position, adjusting ad positions accordingly. Use this method if you are removing an item from your stream and want to decrement ad positions based on that removed item. If you do not want to decrement your ad positions when inserting items, you can simply call notifyDataSet changed on the adapter and let it reload items normally. This is typically the case when removing items from the end of your stream.

Parameters:

originalPosition - The original content position at which to add an item. If you have an adjusted position, you will need to call getOriginalPosition(int) to get this value.

See Also:

MoPubStreamAdPlacer#removeItem(int)}

setOnClickListener

public void setOnClickListener(android.widget.ListView listView,
                      android.widget.AdapterView.OnItemClickListener listener)

Sets an on click listener for the given ListView, automatically adjusting the listener callback positions based on ads in the adapter. This listener will not be called when ads are clicked.

Parameters:

listView - The ListView for this adapter.

listener - An on click listener.

setOnItemLongClickListener

public void setOnItemLongClickListener(android.widget.ListView listView,
                              android.widget.AdapterView.OnItemLongClickListener listener)

Sets an on long click listener for the given ListView, automatically adjusting the listener callback positions based on ads in the adapter. This listener will not be called when ads are long clicked.

Parameters:

listView - The ListView for this adapter.

listener - An an long click listener.

setOnItemSelectedListener

public void setOnItemSelectedListener(android.widget.ListView listView,
                             android.widget.AdapterView.OnItemSelectedListener listener)

Sets an on item selected listener for the given ListView, automatically adjusting the listener callback positions based on ads in the adapter.

Parameters:

listView - The ListView for this adapter.

listener - An an item selected listener.

setSelection

public void setSelection(android.widget.ListView listView,
                int originalPosition)

Sets the currently selected item in the ListView, automatically adjusting the position based on ads in the adapter.

Parameters:

listView - The ListView for this adapter.

originalPosition - The original content position before loading ads.

smoothScrollToPosition

public void smoothScrollToPosition(android.widget.ListView listView,
                          int originalPosition)

Scrolls an item in the ListView, automatically adjusting the position based on ads in the adapter.

Parameters:

listView - The ListView for this adapter.

originalPosition - The original content position before loading ads.

refreshAds

public void refreshAds(android.widget.ListView listView,
              java.lang.String adUnitId)

Refreshes ads in the given ListView while preserving the scroll position. Call this instead of loadAds(String) in order to preserve the scroll position in your list.

Parameters:

adUnitId - The ad unit ID to use when loading ads.

refreshAds

public void refreshAds(android.widget.ListView listView,
              java.lang.String adUnitId,
              RequestParameters requestParameters)

Refreshes ads in the given ListView while preserving the scroll position. Call this instead of loadAds(String, RequestParameters) in order to preserve the scroll position in your list.

Parameters:

adUnitId - The ad unit ID to use when loading ads.

requestParameters - Targeting information to pass to the ad server.