com.appscend.overlaycontrollers

Class APSMediaPlayerClosableOverlayController

java.lang.Object

com.appscend.overlaycontrollers.APSMediaPlayerOverlayController

com.appscend.overlaycontrollers.APSMediaPlayerClosableOverlayController

All Implemented Interfaces:

KRAdapter

Direct Known Subclasses:

APSMediaPlayerHTMLOverlayController, APSMediaPlayerImageOverlayController, APSMediaPlayerMRAIDOverlayController

public class APSMediaPlayerClosableOverlayController
extends APSMediaPlayerOverlayController

The APSMediaPlayerClosableOverlayController class is meant to be a superclass for overlay controllers that need to display a configurable close button to remove the overlay from screen. The class adds a set of standard keys to any overlay controller's own defined keys, to handle close button configuration. Methods are also exposed to allow a subclass to add and remove the close button from its view stack.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	kAPSCloseBackgroundColor the background color of the close button view.
static java.lang.String	kAPSCloseFinalAlpha a Number indicating the opacity of the close button after it has been activated for receiving taps.
static java.lang.String	kAPSCloseHidden set this key to @YES to skip displaying the close button for this overlay.
static java.lang.String	kAPSCloseImage if set to a UIImage, that image will be used instead of the standard progress-wheel close button.
static java.lang.String	kAPSCloseInitialAlpha a Number indicating the opacity of the close button before it is activated for receiving taps.
static java.lang.String	kAPSCloseOffset a Number that indicates the offset, in seconds, after which the close button should become activated for receiving taps.
static java.lang.String	kAPSCloseOffsetX the horizontal offset of the close button, relative to the right margin of the overlay's view.
static java.lang.String	kAPSCloseOffsetY the vertical offset of the close button, relative to the top margin of the overlay's view.
static java.lang.String	kAPSCloseProgressColor the color of the circular bar that indicates the currently elapsed time until the close button can be tapped.
static java.lang.String	kAPSCloseProgressTrackColor the color of the circular bar that indicates the total time until the close button can be tapped.
static java.lang.String	kAPSCloseSize a Number representing the length of a side of the close button square, in points.
static java.lang.String	kAPSCloseTrackingURLs a Array of URLs that will be tracked by the player when the close button is tapped and the overlay is removed (see [APSMediaPlayer track:forEvent:type:]).
static java.lang.String	kAPSCloseXColor the color of the X symbol in the center of the player.

Fields inherited from class com.appscend.overlaycontrollers.APSMediaPlayerOverlayController

overlay

Constructor Summary

Constructors

Constructor and Description
APSMediaPlayerClosableOverlayController()

Method Summary

Modifier and Type	Method and Description
void	activateButton()
void	addViewToContainer(ViewGroup viewGroup)
float	getAlpha()
View	getView()
void	hideOverlay()
void	load(Context context)
void	removeCloseButton() This method removes the close button from the current view stack.
java.lang.String	type()

Methods inherited from class com.appscend.overlaycontrollers.APSMediaPlayerOverlayController

refresh

Methods inherited from class java.lang.Object

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

Field Detail

kAPSCloseImage

public static final java.lang.String kAPSCloseImage

if set to a UIImage, that image will be used instead of the standard progress-wheel close button.

See Also:

Constant Field Values

kAPSCloseSize

public static final java.lang.String kAPSCloseSize

a Number representing the length of a side of the close button square, in points. Defaults to 16.

See Also:

Constant Field Values

kAPSCloseBackgroundColor

public static final java.lang.String kAPSCloseBackgroundColor

the background color of the close button view. Set this to a Color or a String containing the hex color representation. Defaults to [Color clearColor].

See Also:

Constant Field Values

kAPSCloseXColor

public static final java.lang.String kAPSCloseXColor

the color of the X symbol in the center of the player. Set this to a String containing the hex color representation. Defaults to [Color darkGrayColor].

See Also:

Constant Field Values

kAPSCloseProgressColor

public static final java.lang.String kAPSCloseProgressColor

the color of the circular bar that indicates the currently elapsed time until the close button can be tapped. Set this to a String containing the hex color reprezentation. Defaults to [Color darkGrayColor].

See Also:

Constant Field Values

kAPSCloseProgressTrackColor

public static final java.lang.String kAPSCloseProgressTrackColor

the color of the circular bar that indicates the total time until the close button can be tapped. Set this to a NString containing the hex color reprezentation. Defaults to [Color lightGrayColor].

See Also:

Constant Field Values

kAPSCloseOffsetX

public static final java.lang.String kAPSCloseOffsetX

the horizontal offset of the close button, relative to the right margin of the overlay's view. Set this to a Number. Defaults to 0.

See Also:

Constant Field Values

kAPSCloseOffsetY

public static final java.lang.String kAPSCloseOffsetY

the vertical offset of the close button, relative to the top margin of the overlay's view. Set this to a Number. Defaults to 0.

See Also:

Constant Field Values

kAPSCloseInitialAlpha

public static final java.lang.String kAPSCloseInitialAlpha

a Number indicating the opacity of the close button before it is activated for receiving taps. Defaults to 0.5.

See Also:

Constant Field Values

kAPSCloseFinalAlpha

public static final java.lang.String kAPSCloseFinalAlpha

a Number indicating the opacity of the close button after it has been activated for receiving taps. Defaults to 0.7.

See Also:

Constant Field Values

kAPSCloseHidden

public static final java.lang.String kAPSCloseHidden

set this key to @YES to skip displaying the close button for this overlay. Defaults to @NO.

See Also:

Constant Field Values

kAPSCloseOffset

public static final java.lang.String kAPSCloseOffset

a Number that indicates the offset, in seconds, after which the close button should become activated for receiving taps. Defaults to 3.

See Also:

Constant Field Values

kAPSCloseTrackingURLs

public static final java.lang.String kAPSCloseTrackingURLs

a Array of URLs that will be tracked by the player when the close button is tapped and the overlay is removed (see [APSMediaPlayer track:forEvent:type:]).

See Also:

Constant Field Values

Constructor Detail

APSMediaPlayerClosableOverlayController

public APSMediaPlayerClosableOverlayController()

Method Detail

removeCloseButton

public void removeCloseButton()

This method removes the close button from the current view stack.

activateButton

public void activateButton()

getAlpha

public float getAlpha()

Specified by:

getAlpha in class APSMediaPlayerOverlayController

type

public java.lang.String type()

load

public void load(Context context)

Specified by:

load in class APSMediaPlayerOverlayController

addViewToContainer

public void addViewToContainer(ViewGroup viewGroup)

Specified by:

addViewToContainer in class APSMediaPlayerOverlayController

getView

public View getView()

Specified by:

getView in class APSMediaPlayerOverlayController

hideOverlay

public void hideOverlay()

Specified by:

hideOverlay in class APSMediaPlayerOverlayController