com.pubmatic.sdk.webrendering.mraid

Class PMMraidRenderer

java.lang.Object

com.pubmatic.sdk.webrendering.ui.PMHTMLRenderer

com.pubmatic.sdk.webrendering.mraid.PMMraidRenderer

All Implemented Interfaces:

HTMLViewClient.HTMLViewClientListener

public class PMMraidRenderer
extends PMHTMLRenderer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PMMraidRenderer.PMMraidRendererListener Interface to provide callback methods for Mraid rendering

Field Summary

Fields

Modifier and Type	Field and Description
protected PMMraidRenderer.PMMraidRendererListener	mraidRendererListener

Fields inherited from class com.pubmatic.sdk.webrendering.ui.PMHTMLRenderer

isClicked, viewListener, webView

Constructor Summary

Constructors

Constructor and Description
PMMraidRenderer(android.content.Context context, java.lang.String placementType) Necessary initialization is done for MRAID Renderer

Method Summary

Modifier and Type	Method and Description
void	addAdVisibilityListener(AdVisibilityListener listener) Method to set AdVisibilityListener to provide WebView Visibility changes to implemented class(MraidController)
boolean	isUserInteracted(boolean overrideClickState) Returns true if user has recently touch/click on MRAID web view.
void	loadHTML(java.lang.String content, java.lang.String baseURL) Method override from PMHTMLRenderer to inject environment variables into mraid ad creative
void	onAdInteractionStarted() Notifies Mraid ad interaction started or ad Open to the implemented class(PMBannerRenderer)
void	onAdInteractionStopped() Notifies Mraid ad interaction started or ad closed to the implemented class(PMBannerRenderer)
void	onAdUnload() Notifies event for Mraid Unload to the implemented class(PMBannerRenderer)
void	onLeavingApplication() Notifies Mraid ad App is leaving to the implemented class(PMBannerRenderer)
void	onMRAIDAdClick() Notifies Mraid ad click happened to the implemented class(PMBannerRenderer)
void	onOpen(java.lang.String url) This method gets called when MRAID has open event.
void	onPageFinished(android.webkit.WebView view) Override method from PMHTMLRenderer Informs webview loading is finished Resetting the properties after every load Setting the updateState to true for the first time after load Setting up setLayoutChangeListener
void	setMraidRendererListener(PMMraidRenderer.PMMraidRendererListener mraidRendererListener) Method to get Mraid Related callbacks
protected void	setWebViewClient() Add PMMraidWebClient to PMWebView
void	stopLoading() Method Override from PMHTMLRenderer to do cleanup

Methods inherited from class com.pubmatic.sdk.webrendering.ui.PMHTMLRenderer

closeInternalBrowser, getWebView, onReceivedError, openBannerUrl, setRendererViewListener, shouldOverrideUrlLoading

Methods inherited from class java.lang.Object

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

Field Detail

mraidRendererListener

protected PMMraidRenderer.PMMraidRendererListener mraidRendererListener

Constructor Detail

PMMraidRenderer

public PMMraidRenderer(android.content.Context context,
                       java.lang.String placementType)

Necessary initialization is done for MRAID Renderer

Parameters:

context - android context

placementType - ad placement type

Method Detail

setMraidRendererListener

public void setMraidRendererListener(PMMraidRenderer.PMMraidRendererListener mraidRendererListener)

Method to get Mraid Related callbacks

Parameters:

mraidRendererListener - reference of PMMraidRenderer.PMMraidRendererListener

setWebViewClient

protected void setWebViewClient()

Add PMMraidWebClient to PMWebView

Overrides:

setWebViewClient in class PMHTMLRenderer

loadHTML

public void loadHTML(java.lang.String content,
                     java.lang.String baseURL)

Method override from PMHTMLRenderer to inject environment variables into mraid ad creative

Overrides:

loadHTML in class PMHTMLRenderer

Parameters:

content - content to inject

baseURL - on which content to be inject

onOpen

public void onOpen(java.lang.String url)

This method gets called when MRAID has open event. MRAID renderer should handle the open event.

Parameters:

url - Landing page url to be open in internal/external browser

isUserInteracted

public boolean isUserInteracted(boolean overrideClickState)

Returns true if user has recently touch/click on MRAID web view. It sets the internal interaction state to false until user interacted again.

Parameters:

overrideClickState - boolean value for click state

Returns:

Returns true if user has recently touch/click on MRAID web view else return false

stopLoading

public void stopLoading()

Method Override from PMHTMLRenderer to do cleanup

Overrides:

stopLoading in class PMHTMLRenderer

onPageFinished

public void onPageFinished(android.webkit.WebView view)

Override method from PMHTMLRenderer Informs webview loading is finished Resetting the properties after every load Setting the updateState to true for the first time after load Setting up setLayoutChangeListener

Specified by:

onPageFinished in interface HTMLViewClient.HTMLViewClientListener

Overrides:

onPageFinished in class PMHTMLRenderer

Parameters:

view - instance of webview

onAdInteractionStarted

public void onAdInteractionStarted()

Notifies Mraid ad interaction started or ad Open to the implemented class(PMBannerRenderer)

onAdInteractionStopped

public void onAdInteractionStopped()

Notifies Mraid ad interaction started or ad closed to the implemented class(PMBannerRenderer)

onLeavingApplication

public void onLeavingApplication()

Notifies Mraid ad App is leaving to the implemented class(PMBannerRenderer)

onMRAIDAdClick

public void onMRAIDAdClick()

Notifies Mraid ad click happened to the implemented class(PMBannerRenderer)

onAdUnload

public void onAdUnload()

Notifies event for Mraid Unload to the implemented class(PMBannerRenderer)

addAdVisibilityListener

public void addAdVisibilityListener(@NonNull
                                    AdVisibilityListener listener)

Method to set AdVisibilityListener to provide WebView Visibility changes to implemented class(MraidController)

Parameters:

listener - reference of AdVisibilityListener