com.digitalsunray.advantage

Class SharedFunctionality

java.lang.Object

com.digitalsunray.advantage.SharedFunctionality

public class SharedFunctionality
extends java.lang.Object

This class contains all methods which are shared between all plug-ins in general. Please note that both Advantage and MRAID Functionalities are implemented as plugins as well.

See Also:

AdvantagePlugin, MraidPlugin

Method Summary

Modifier and Type	Method and Description
void	expand() Opens a modal view with the given size.
void	expand(java.lang.String url) Opens a modal view with the given size and load a given URL to the second AdWebView.
android.graphics.Point	getCurrentAdWebViewPoint(Enum.SizeMeasures measures) Computes the 'Left' and 'Top' position of the active AdWebView relative to its parent based on the the logical density of the display.
int	getCurrentOrientation()
android.graphics.Point	getDefaultAdWebViewPoint(Enum.SizeMeasures measures) Computes the coordinates of the default (first part) AdWebView in its window based on the the logical density of the display.
Enum.States	getState() This method always returns the current state of banner.
java.lang.String	getVersion()
void	hideCloseArea() Hide the banner's close button.
boolean	isAdWebViewVisible() Returns the visibility status for the default (first part) AdWebView.
void	notify(java.lang.Object object) Occurs when a message sends from Advantage object to the SDK implementer.
void	onError(java.lang.String msg, Enum.ErrorCategory errorCategory) Occurs when an SDK major error occurs.
void	resize() Opens a modal view with the given size.
void	setState(Enum.States state) Sets the current banner's state.
void	showCloseArea() Display the banner's close button.

Methods inherited from class java.lang.Object

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

Method Detail

getCurrentOrientation

public int getCurrentOrientation()

Returns:

the overall orientation of the screen. May be one of ORIENTATION_LANDSCAPE, ORIENTATION_PORTRAIT.

getVersion

public java.lang.String getVersion()

Returns:

the current Advantage's version.

getState

public Enum.States getState()

This method always returns the current state of banner.

Returns:

Current state of banner.

setState

public void setState(Enum.States state)

Sets the current banner's state.

Parameters:

state - Current state

showCloseArea

public void showCloseArea()

Display the banner's close button. this method operates on UI thread.

hideCloseArea

public void hideCloseArea()

Hide the banner's close button. this method runs on UI thread.

expand

public void expand()

Opens a modal view with the given size. At this point, expand properties need to be set.

expand

public void expand(java.lang.String url)

Opens a modal view with the given size and load a given URL to the second AdWebView. if size is not already specified, the modal will be shown in full screen size. At this point, expand properties need to be set.

Parameters:

url - the URL of the resource to load.

resize

public void resize()

Opens a modal view with the given size. If ResizeProperties is not already specified, the modal will be shown with the default resize properties.

getCurrentAdWebViewPoint

public android.graphics.Point getCurrentAdWebViewPoint(Enum.SizeMeasures measures)

Computes the 'Left' and 'Top' position of the active AdWebView relative to its parent based on the the logical density of the display.

Parameters:

measures - The measurement type.

Returns:

an array of two integers in which to hold the coordinates.

getDefaultAdWebViewPoint

public android.graphics.Point getDefaultAdWebViewPoint(Enum.SizeMeasures measures)

Computes the coordinates of the default (first part) AdWebView in its window based on the the logical density of the display.

Parameters:

measures - The measurement type.

Returns:

an array of two integers in which to hold the coordinates.

isAdWebViewVisible

public boolean isAdWebViewVisible()

Returns the visibility status for the default (first part) AdWebView.

Returns:

true If this view is visible. false otherwise.

notify

public void notify(java.lang.Object object)

Occurs when a message sends from Advantage object to the SDK implementer. The event contains the value of the message.

Parameters:

object - Message from Advantage instance.

onError

public void onError(java.lang.String msg,
                    Enum.ErrorCategory errorCategory)

Occurs when an SDK major error occurs. The event contains a description of the error that occurred.

Parameters:

msg - Error message.

errorCategory - Category of reported error.