com.pubmatic.sdk.webrendering.ui

Class POBViewabilityTracker

java.lang.Object

com.pubmatic.sdk.webrendering.ui.POBViewabilityTracker

All Implemented Interfaces:

android.view.View.OnAttachStateChangeListener, android.view.ViewTreeObserver.OnGlobalLayoutListener, android.view.ViewTreeObserver.OnScrollChangedListener, android.view.ViewTreeObserver.OnWindowFocusChangeListener

public class POBViewabilityTracker
extends java.lang.Object
implements android.view.ViewTreeObserver.OnGlobalLayoutListener, android.view.ViewTreeObserver.OnScrollChangedListener, android.view.ViewTreeObserver.OnWindowFocusChangeListener, android.view.View.OnAttachStateChangeListener

Viewability tracker to track view view ability. Responsible to track view ability update of the view on the basis for threshold see.setViewabilityThresholdPercent(float) and notifies it through listener method. see setOnExposureChangeWithThresholdListener(com.pubmatic.sdk.webrendering.ui.POBViewabilityTracker.OnViewabilityChangedListener)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	POBViewabilityTracker.OnViewabilityChangedListener Interface definition for a callback to be invoked when layout change happens with respect to view and threshold.

Constructor Summary

Constructors

Constructor and Description
POBViewabilityTracker(android.view.View view) Constructs exposure tracker for view

Method Summary

Modifier and Type	Method and Description
void	destroy()
boolean	isViewable() To get view visibility with respect to viewability threshold percent.
void	onGlobalLayout()
void	onScrollChanged()
void	onViewAttachedToWindow(android.view.View v)
void	onViewDetachedFromWindow(android.view.View v)
void	onWindowFocusChanged(boolean hasFocus)
void	setAllowViewTreeObserverRegistration(boolean allowViewTreeObserverRegistration) To allow view tree updates, default values is false
void	setOnExposureChangeWithThresholdListener(POBViewabilityTracker.OnViewabilityChangedListener listener) Property to notify exposure change
void	setViewabilityThresholdPercent(float viewabilityThresholdPercent) Property on the basis of which tracker decides to notify exposure change

Methods inherited from class java.lang.Object

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

Constructor Detail

POBViewabilityTracker

public POBViewabilityTracker(@NonNull
                             android.view.View view)

Constructs exposure tracker for view

Parameters:

view - the view on which exposure change is calculated.

Method Detail

setAllowViewTreeObserverRegistration

public void setAllowViewTreeObserverRegistration(boolean allowViewTreeObserverRegistration)

To allow view tree updates, default values is false

Parameters:

allowViewTreeObserverRegistration - set to true if want register for view tree updates, else set to false

isViewable

public boolean isViewable()

To get view visibility with respect to viewability threshold percent.

Returns:

True if the view is visible w.r.t. view ability threshold percent, else return false

setOnExposureChangeWithThresholdListener

public void setOnExposureChangeWithThresholdListener(@Nullable
                                                     POBViewabilityTracker.OnViewabilityChangedListener listener)

Property to notify exposure change

Parameters:

listener - reference of onViewabilityChangedListener

setViewabilityThresholdPercent

public void setViewabilityThresholdPercent(float viewabilityThresholdPercent)

Property on the basis of which tracker decides to notify exposure change

Parameters:

viewabilityThresholdPercent - the view ability percent in float

onGlobalLayout

public void onGlobalLayout()

Specified by:

onGlobalLayout in interface android.view.ViewTreeObserver.OnGlobalLayoutListener

onScrollChanged

public void onScrollChanged()

Specified by:

onScrollChanged in interface android.view.ViewTreeObserver.OnScrollChangedListener

destroy

public void destroy()

onWindowFocusChanged

public void onWindowFocusChanged(boolean hasFocus)

Specified by:

onWindowFocusChanged in interface android.view.ViewTreeObserver.OnWindowFocusChangeListener

onViewAttachedToWindow

public void onViewAttachedToWindow(android.view.View v)

Specified by:

onViewAttachedToWindow in interface android.view.View.OnAttachStateChangeListener

onViewDetachedFromWindow

public void onViewDetachedFromWindow(android.view.View v)

Specified by:

onViewDetachedFromWindow in interface android.view.View.OnAttachStateChangeListener