com.amazon.device.ads

Class AdLayout

java.lang.Object

android.view.View

android.view.ViewGroup

android.widget.FrameLayout

com.amazon.device.ads.AdLayout

All Implemented Interfaces:

android.graphics.drawable.Drawable.Callback, android.view.accessibility.AccessibilityEventSource, android.view.KeyEvent.Callback, android.view.ViewManager, android.view.ViewParent

public class AdLayout
extends android.widget.FrameLayout

An android view used to retrieve and display Amazon ads. An AdLayout can only load and display one ad at a time, although there is no limitation on the number of AdLayouts you can instantiate.

All ad placements must be fully visible without scrolling when initially displayed to the user. If an ad placement is embedded with content in a screen, it can scroll with that content and scroll off of the screen as long as it started above the fold.

Making ad requests to the Amazon Mobile Ad Network requires the INTERNET permission. Additionally we recommend that you include permissions for FINE_LOCATION, COURSE_LOCATION, NETWORK_STATE, and WIFI_STATE. These additional permissions allow Amazon to provide contextual and geo-targeted ads to your users, which may result in higher CPMs. Declare these permissions in your AndroidManifest.xml.

Nested Class Summary

Nested classes/interfaces inherited from class android.widget.FrameLayout

android.widget.FrameLayout.LayoutParams

Nested classes/interfaces inherited from class android.view.ViewGroup

android.view.ViewGroup.MarginLayoutParams, android.view.ViewGroup.OnHierarchyChangeListener

Nested classes/interfaces inherited from class android.view.View

android.view.View.AccessibilityDelegate, android.view.View.BaseSavedState, android.view.View.DragShadowBuilder, android.view.View.MeasureSpec, android.view.View.OnAttachStateChangeListener, android.view.View.OnClickListener, android.view.View.OnCreateContextMenuListener, android.view.View.OnDragListener, android.view.View.OnFocusChangeListener, android.view.View.OnGenericMotionListener, android.view.View.OnHoverListener, android.view.View.OnKeyListener, android.view.View.OnLayoutChangeListener, android.view.View.OnLongClickListener, android.view.View.OnSystemUiVisibilityChangeListener, android.view.View.OnTouchListener

Field Summary

Fields inherited from class android.view.ViewGroup

FOCUS_AFTER_DESCENDANTS, FOCUS_BEFORE_DESCENDANTS, FOCUS_BLOCK_DESCENDANTS, PERSISTENT_ALL_CACHES, PERSISTENT_ANIMATION_CACHE, PERSISTENT_NO_CACHE, PERSISTENT_SCROLLING_CACHE

Fields inherited from class android.view.View

ALPHA, DRAWING_CACHE_QUALITY_AUTO, DRAWING_CACHE_QUALITY_HIGH, DRAWING_CACHE_QUALITY_LOW, FIND_VIEWS_WITH_CONTENT_DESCRIPTION, FIND_VIEWS_WITH_TEXT, FOCUS_BACKWARD, FOCUS_DOWN, FOCUS_FORWARD, FOCUS_LEFT, FOCUS_RIGHT, FOCUS_UP, FOCUSABLES_ALL, FOCUSABLES_TOUCH_MODE, GONE, HAPTIC_FEEDBACK_ENABLED, INVISIBLE, KEEP_SCREEN_ON, LAYER_TYPE_HARDWARE, LAYER_TYPE_NONE, LAYER_TYPE_SOFTWARE, MEASURED_HEIGHT_STATE_SHIFT, MEASURED_SIZE_MASK, MEASURED_STATE_MASK, MEASURED_STATE_TOO_SMALL, NO_ID, OVER_SCROLL_ALWAYS, OVER_SCROLL_IF_CONTENT_SCROLLS, OVER_SCROLL_NEVER, ROTATION, ROTATION_X, ROTATION_Y, SCALE_X, SCALE_Y, SCROLLBAR_POSITION_DEFAULT, SCROLLBAR_POSITION_LEFT, SCROLLBAR_POSITION_RIGHT, SCROLLBARS_INSIDE_INSET, SCROLLBARS_INSIDE_OVERLAY, SCROLLBARS_OUTSIDE_INSET, SCROLLBARS_OUTSIDE_OVERLAY, SOUND_EFFECTS_ENABLED, STATUS_BAR_HIDDEN, STATUS_BAR_VISIBLE, SYSTEM_UI_FLAG_HIDE_NAVIGATION, SYSTEM_UI_FLAG_LOW_PROFILE, SYSTEM_UI_FLAG_VISIBLE, TRANSLATION_X, TRANSLATION_Y, VISIBLE, X, Y

Constructor Summary

Constructors

Constructor and Description
AdLayout(android.app.Activity activity) Use this constructor if you are creating an AdLayout in your code and would like to use Auto Ad Size.
AdLayout(android.app.Activity activity, AdSize adSize) Use this constructor if creating an AdLayout in your code.
AdLayout(android.content.Context context, android.util.AttributeSet attrs) Constructor that is called when inflating a view from XML.
AdLayout(android.content.Context context, android.util.AttributeSet attrs, int defStyle) Perform inflation from XML and apply a class-specific base style.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	collapseAd() Collapses an expanded rich media ad.
void	destroy() Releases all resources used by an instance.
AdSize	getAdSize() Gets the size of the ad to load.
int	getTimeout() Gets the current timeout value in milliseconds.
boolean	isAdLoading() Gets whether an ad is currently being loaded.
boolean	loadAd(AdTargetingOptions options) Creates an AsyncTask to load a new ad based on AdTargetingOptions.
void	setListener(AdListener listener) Sets the listener used to track ad life-cycle events.
void	setTimeout(int timeout) Sets the timeout value of the AsyncTask that requests the ad.
boolean	shouldDisableWebViewHardwareAcceleration()

Methods inherited from class android.widget.FrameLayout

draw, gatherTransparentRegion, generateLayoutParams, getConsiderGoneChildrenWhenMeasuring, getForeground, getMeasureAllChildren, jumpDrawablesToCurrentState, setForeground, setForegroundGravity, setMeasureAllChildren, shouldDelayChildPressedState

Methods inherited from class android.view.ViewGroup

addFocusables, addFocusables, addStatesFromChildren, addTouchables, addView, addView, addView, addView, addView, bringChildToFront, childDrawableStateChanged, clearChildFocus, clearDisappearingChildren, clearFocus, dispatchConfigurationChanged, dispatchDisplayHint, dispatchDragEvent, dispatchKeyEvent, dispatchKeyEventPreIme, dispatchKeyShortcutEvent, dispatchSetActivated, dispatchSetSelected, dispatchSystemUiVisibilityChanged, dispatchTouchEvent, dispatchTrackballEvent, dispatchUnhandledMove, dispatchWindowFocusChanged, dispatchWindowVisibilityChanged, endViewTransition, findFocus, findViewsWithText, focusableViewAvailable, focusSearch, getChildAt, getChildCount, getChildMeasureSpec, getChildVisibleRect, getDescendantFocusability, getFocusedChild, getLayoutAnimation, getLayoutAnimationListener, getLayoutTransition, getPersistentDrawingCache, hasFocus, hasFocusable, indexOfChild, invalidateChild, invalidateChildInParent, isAlwaysDrawnWithCacheEnabled, isAnimationCacheEnabled, isMotionEventSplittingEnabled, layout, offsetDescendantRectToMyCoords, offsetRectIntoDescendantCoords, onInterceptHoverEvent, onInterceptTouchEvent, onRequestSendAccessibilityEvent, recomputeViewAttributes, removeAllViews, removeAllViewsInLayout, removeView, removeViewAt, removeViewInLayout, removeViews, removeViewsInLayout, requestChildFocus, requestChildRectangleOnScreen, requestDisallowInterceptTouchEvent, requestFocus, requestSendAccessibilityEvent, requestTransparentRegion, scheduleLayoutAnimation, setAddStatesFromChildren, setAlwaysDrawnWithCacheEnabled, setAnimationCacheEnabled, setClipChildren, setClipToPadding, setDescendantFocusability, setLayoutAnimation, setLayoutAnimationListener, setLayoutTransition, setMotionEventSplittingEnabled, setOnHierarchyChangeListener, setPadding, setPersistentDrawingCache, showContextMenuForChild, startActionModeForChild, startLayoutAnimation, startViewTransition, updateViewLayout

Methods inherited from class android.view.View

addOnAttachStateChangeListener, addOnLayoutChangeListener, animate, bringToFront, buildDrawingCache, buildDrawingCache, buildLayer, callOnClick, cancelLongPress, canScrollHorizontally, canScrollVertically, checkInputConnectionProxy, clearAnimation, combineMeasuredStates, computeScroll, createAccessibilityNodeInfo, createContextMenu, destroyDrawingCache, dispatchGenericMotionEvent, dispatchPopulateAccessibilityEvent, findViewById, findViewWithTag, fitsSystemWindows, focusSearch, forceLayout, getAlpha, getAnimation, getApplicationWindowToken, getBackground, getBaseline, getBottom, getContentDescription, getContext, getDefaultSize, getDrawableState, getDrawingCache, getDrawingCache, getDrawingCacheBackgroundColor, getDrawingCacheQuality, getDrawingRect, getDrawingTime, getFilterTouchesWhenObscured, getFocusables, getFocusedRect, getGlobalVisibleRect, getGlobalVisibleRect, getHandler, getHeight, getHitRect, getHorizontalFadingEdgeLength, getId, getKeepScreenOn, getKeyDispatcherState, getLayerType, getLayoutParams, getLeft, getLocalVisibleRect, getLocationInWindow, getLocationOnScreen, getMatrix, getMeasuredHeight, getMeasuredHeightAndState, getMeasuredState, getMeasuredWidth, getMeasuredWidthAndState, getNextFocusDownId, getNextFocusForwardId, getNextFocusLeftId, getNextFocusRightId, getNextFocusUpId, getOnFocusChangeListener, getOverScrollMode, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getParent, getPivotX, getPivotY, getResources, getRight, getRootView, getRotation, getRotationX, getRotationY, getScaleX, getScaleY, getScrollBarStyle, getScrollX, getScrollY, getSolidColor, getSystemUiVisibility, getTag, getTag, getTop, getTouchables, getTouchDelegate, getTranslationX, getTranslationY, getVerticalFadingEdgeLength, getVerticalScrollbarPosition, getVerticalScrollbarWidth, getViewTreeObserver, getVisibility, getWidth, getWindowToken, getWindowVisibility, getWindowVisibleDisplayFrame, getX, getY, hasOnClickListeners, hasWindowFocus, inflate, invalidate, invalidate, invalidate, invalidateDrawable, isActivated, isClickable, isDirty, isDrawingCacheEnabled, isDuplicateParentStateEnabled, isEnabled, isFocusable, isFocusableInTouchMode, isFocused, isHapticFeedbackEnabled, isHardwareAccelerated, isHorizontalFadingEdgeEnabled, isHorizontalScrollBarEnabled, isHovered, isInEditMode, isInTouchMode, isLayoutRequested, isLongClickable, isOpaque, isPressed, isSaveEnabled, isSaveFromParentEnabled, isScrollbarFadingEnabled, isSelected, isShown, isSoundEffectsEnabled, isVerticalFadingEdgeEnabled, isVerticalScrollBarEnabled, measure, offsetLeftAndRight, offsetTopAndBottom, onCheckIsTextEditor, onCreateInputConnection, onDragEvent, onFilterTouchEventForSecurity, onFinishTemporaryDetach, onGenericMotionEvent, onHoverChanged, onHoverEvent, onInitializeAccessibilityEvent, onInitializeAccessibilityNodeInfo, onKeyDown, onKeyLongPress, onKeyMultiple, onKeyPreIme, onKeyShortcut, onKeyUp, onPopulateAccessibilityEvent, onStartTemporaryDetach, onTouchEvent, onTrackballEvent, onWindowFocusChanged, performClick, performHapticFeedback, performHapticFeedback, performLongClick, playSoundEffect, post, postDelayed, postInvalidate, postInvalidate, postInvalidateDelayed, postInvalidateDelayed, refreshDrawableState, removeCallbacks, removeOnAttachStateChangeListener, removeOnLayoutChangeListener, requestFocus, requestFocus, requestFocusFromTouch, requestLayout, requestRectangleOnScreen, requestRectangleOnScreen, resolveSize, resolveSizeAndState, restoreHierarchyState, saveHierarchyState, scheduleDrawable, scrollBy, scrollTo, sendAccessibilityEvent, sendAccessibilityEventUnchecked, setAccessibilityDelegate, setActivated, setAlpha, setAnimation, setBackgroundColor, setBackgroundDrawable, setBackgroundResource, setBottom, setCameraDistance, setClickable, setContentDescription, setDrawingCacheBackgroundColor, setDrawingCacheEnabled, setDrawingCacheQuality, setDuplicateParentStateEnabled, setEnabled, setFadingEdgeLength, setFilterTouchesWhenObscured, setFitsSystemWindows, setFocusable, setFocusableInTouchMode, setHapticFeedbackEnabled, setHorizontalFadingEdgeEnabled, setHorizontalScrollBarEnabled, setHovered, setId, setKeepScreenOn, setLayerType, setLayoutParams, setLeft, setLongClickable, setMinimumHeight, setMinimumWidth, setNextFocusDownId, setNextFocusForwardId, setNextFocusLeftId, setNextFocusRightId, setNextFocusUpId, setOnClickListener, setOnCreateContextMenuListener, setOnDragListener, setOnFocusChangeListener, setOnGenericMotionListener, setOnHoverListener, setOnKeyListener, setOnLongClickListener, setOnSystemUiVisibilityChangeListener, setOnTouchListener, setOverScrollMode, setPivotX, setPivotY, setPressed, setRight, setRotation, setRotationX, setRotationY, setSaveEnabled, setSaveFromParentEnabled, setScaleX, setScaleY, setScrollbarFadingEnabled, setScrollBarStyle, setScrollContainer, setScrollX, setScrollY, setSelected, setSoundEffectsEnabled, setSystemUiVisibility, setTag, setTag, setTop, setTouchDelegate, setTranslationX, setTranslationY, setVerticalFadingEdgeEnabled, setVerticalScrollBarEnabled, setVerticalScrollbarPosition, setVisibility, setWillNotCacheDrawing, setWillNotDraw, setX, setY, showContextMenu, startActionMode, startAnimation, startDrag, unscheduleDrawable, unscheduleDrawable, willNotCacheDrawing, willNotDraw

Methods inherited from class java.lang.Object

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

Methods inherited from interface android.view.ViewParent

createContextMenu, getParent, isLayoutRequested, requestLayout

Constructor Detail

AdLayout

public AdLayout(android.app.Activity activity)

Use this constructor if you are creating an AdLayout in your code and would like to use Auto Ad Size.

Parameters:

activity - The activity.

AdLayout

public AdLayout(android.app.Activity activity,
        AdSize adSize)

Use this constructor if creating an AdLayout in your code.

Parameters:

activity - The activity.

adSize - The size of the ad to retrieve and display.

AdLayout

public AdLayout(android.content.Context context,
        android.util.AttributeSet attrs)

Constructor that is called when inflating a view from XML. This is called when a view is being constructed from an XML file, supplying attributes that were specified in the XML file. This version uses a default style of 0, so the only attribute values applied are those in the Context's Theme and the given AttributeSet.

The method onFinishInflate() will be called after all children have been added.

Parameters:

context - The Context the view is running in, through which it can access the current theme, resources, etc.

attrs - The attributes of the XML tag that is inflating the view.

AdLayout

public AdLayout(android.content.Context context,
        android.util.AttributeSet attrs,
        int defStyle)

Perform inflation from XML and apply a class-specific base style.

Parameters:

context - The Context the view is running in, through which it can access the current theme, resources, etc.

attrs - The attributes of the XML tag that is inflating the view.

defStyle - The default style to apply to this view. If 0, no style will be applied (beyond what is included in the theme). This may either be an attribute resource, whose value will be retrieved from the current theme, or an explicit style resource.

Method Detail

shouldDisableWebViewHardwareAcceleration

public boolean shouldDisableWebViewHardwareAcceleration()

getTimeout

public int getTimeout()

Gets the current timeout value in milliseconds.

Returns:

The current timeout value in milliseconds.

setTimeout

public void setTimeout(int timeout)

Sets the timeout value of the AsyncTask that requests the ad. This AsyncTask is created when loadAd(AdTargetingOptions) is called. The default value is 20000 milliseconds.

Parameters:

timeout - The timeout in milliseconds.

getAdSize

public AdSize getAdSize()

Gets the size of the ad to load. Ad sizes are defined in device independent pixels, Therefore, the actual size of the ad in pixels might vary depending on the resolution of the device. Ads will scale accordingly to accommodate varying device resolutions within your ad view container.

Returns:

The current ad size to load. Units are defined in device independent pixels.

loadAd

public boolean loadAd(AdTargetingOptions options)

Creates an AsyncTask to load a new ad based on AdTargetingOptions. When the ad loads successfully AdListener.onAdLoaded(AdLayout, AdProperties) is called. When the ad fails to load the AdListener.onAdFailedToLoad(AdLayout, AdError) is called. An ad that is currently loaded will only be cleared if the new loadAd(AdTargetingOptions) call completes successfully.

Only one ad can be loading at a time. The loadAd(AdTargetingOptions) call will return true if an AsyncTask is created to load a new ad, and false if the load ad request is ignored because there is currently an AsyncTask in progress.

Making ad requests to the Amazon Mobile Ad Network requires the INTERNET permission. Additionally we recommend that you include permissions for FINE_LOCATION, COURSE_LOCATION, NETWORK_STATE, and WIFI_STATE. These additional permissions allow Amazon to provide contextual and geo-targeted ads to your users, which may result in higher CPMs. Declare these permissions in your AndroidManifest.xml.

Parameters:

options - Additional ad options. Use this parameter to flag test requests and targeting settings.

Returns:

Returns true if an AsyncTask is created to load a new ad, and returns false if the load ad request is ignored because there is currently an AsyncTask in progress or because the current ad is expanded.

setListener

public void setListener(AdListener listener)

Sets the listener used to track ad life-cycle events. Only one listener can be assigned per AdLayout instance. Calling setListener a second time would overwrite the existing listener with the new listener.

Parameters:

listener - An instance of AdListener that will be notified during ad life-cycle changes.

collapseAd

public boolean collapseAd()

Collapses an expanded rich media ad. This can be used as a programmatic alternative to the back button or the rich media ad's close button. This is a synchronous method, and it needs to be invoked on the UI thread. Once the ad has collapsed, the AdListener.onAdCollapsed(AdLayout) event will be called.

Returns:

Returns true if the rich media ad successfully collapsed. Returns false if no rich media ad found to collapse, or the rich media ad is already collapsed.

isAdLoading

public boolean isAdLoading()

Gets whether an ad is currently being loaded. AdLayout only supports loading one ad at a time. Use this method to check if a new loadAd(AdTargetingOptions) call can be made.

Returns:

Returns true if an ad is currently being loaded, and false if there is no ad being loaded.

destroy

public void destroy()

Releases all resources used by an instance. No ads will be shown once this method executes. The parent Activity's onDestory implementation must include a call to this method if the AdLayout instance was created through code.