com.pubmatic.sdk.webrendering.ui

Class POBHTMLRenderer

java.lang.Object

com.pubmatic.sdk.webrendering.ui.POBHTMLRenderer

All Implemented Interfaces:

POBHTMLViewClient.HTMLViewClientListener

@MainThread
public class POBHTMLRenderer
extends java.lang.Object
implements POBHTMLViewClient.HTMLViewClientListener

A class responsible for rendering HTML creative/content in WebView

Constructor Summary

Constructors

Constructor and Description
POBHTMLRenderer(POBWebView pmWebView, POBHTMLViewClient webViewClient) Constructs HTML Renderer by using PMWebView and HTMLView client.

Method Summary

Modifier and Type	Method and Description
void	destroy() Clearing all the data related to HTML Renderer.
boolean	isUserInteracted() To get the state of WebView user interaction.
void	loadHTML(java.lang.String content, java.lang.String baseURL) Generate content specific to WebView rendering/loading and loads it in webview with provided base url
protected void	notifyError(com.pubmatic.sdk.common.POBError error) To notify error to PMHtmlRendererListener reference Always notifies error on main thread.
void	onPageFinished(android.webkit.WebView view) To notify view is about render.
void	onReceivedError(com.pubmatic.sdk.common.POBError error) To notify rederer is failed to load ad.
void	setRendererViewListener(com.pubmatic.sdk.common.ui.POBHtmlRendererListener listener) Method Provides Renderer callback to implementation class
void	setRenderingTimeout(int renderingTimeout) To set rendering timeout, in case if renderer takes more time than rendering timeout to render renderer notifies rendering timeout error.
void	setUserInteracted(boolean userInteracted) To set the state of WebView user interaction.
boolean	shouldOverrideUrlLoading(java.lang.String url) Gets called when URL is about to be load in the current WebView.

Methods inherited from class java.lang.Object

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

Constructor Detail

POBHTMLRenderer

public POBHTMLRenderer(@NonNull
                       POBWebView pmWebView,
                       @NonNull
                       POBHTMLViewClient webViewClient)

Constructs HTML Renderer by using PMWebView and HTMLView client.

Parameters:

pmWebView - instance of PMWebView required

webViewClient - instance of HTMLViewClient

Method Detail

setRenderingTimeout

public void setRenderingTimeout(int renderingTimeout)

To set rendering timeout, in case if renderer takes more time than rendering timeout to render renderer notifies rendering timeout error. In order to execute properly set before loadHTML(String, String) For default value see POBCommonConstants.MAX_RENDER_TIMEOUT_IN_SEC

Parameters:

renderingTimeout - the timeout in seconds.

isUserInteracted

public boolean isUserInteracted()

To get the state of WebView user interaction.

Returns:

state of WebView user interaction

setUserInteracted

public void setUserInteracted(boolean userInteracted)

To set the state of WebView user interaction.

Parameters:

userInteracted - state of the WebView user interaction.

setRendererViewListener

public void setRendererViewListener(@Nullable
                                    com.pubmatic.sdk.common.ui.POBHtmlRendererListener listener)

Method Provides Renderer callback to implementation class

Parameters:

listener - reference of PMHtmlRendererListener

loadHTML

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

Generate content specific to WebView rendering/loading and loads it in webview with provided base url

Parameters:

content - content which is to be formatter

baseURL - on which formatted content to be loaded

shouldOverrideUrlLoading

public boolean shouldOverrideUrlLoading(java.lang.String url)

Gets called when URL is about to be load in the current WebView.

Specified by:

shouldOverrideUrlLoading in interface POBHTMLViewClient.HTMLViewClientListener

Parameters:

url - the url which is going to be loaded

Returns:

returning true causes the current WebView to abort loading the URL, while returning false causes the WebView to continue loading the URL as usual.

onPageFinished

public void onPageFinished(android.webkit.WebView view)

To notify view is about render.

Specified by:

onPageFinished in interface POBHTMLViewClient.HTMLViewClientListener

Parameters:

view - value current WebView

onReceivedError

public void onReceivedError(com.pubmatic.sdk.common.POBError error)

To notify rederer is failed to load ad.

Specified by:

onReceivedError in interface POBHTMLViewClient.HTMLViewClientListener

Parameters:

error - value of POBError

notifyError

protected void notifyError(com.pubmatic.sdk.common.POBError error)

To notify error to PMHtmlRendererListener reference Always notifies error on main thread.

Parameters:

error - the error with its info

destroy

public void destroy()

Clearing all the data related to HTML Renderer.