CBViewProtocol (Chartboost API)

java.lang.Object
- com.chartboost.sdk.CBViewProtocol

Direct Known Subclasses:

CBWebViewProtocol, InterstitialImageViewProtocol
```
public abstract class CBViewProtocol
extends java.lang.Object
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`CBViewProtocol.CBViewBase` we've separated the actual view into a separate class so that we don't create it until all of the assets are loaded.
`static interface`	`CBViewProtocol.ImpressionAsset`

Field Summary

Fields
Modifier and Type	Field and Description
`java.util.Map<View,java.lang.Runnable>`	`animationRunnables`
`protected JSONObject`	`assets`
`CBImpression`	`impression`
`protected int`	`orientation`
`protected boolean`	`supportsLandscape`
`protected boolean`	`supportsPortrait`
`Handler`	`uiHandler`
`CBUIManager`	`uiManager`
`boolean`	`viewOnPaused`

Constructor Summary

Constructors
Constructor and Description

CBViewProtocol(CBImpression impression, Handler uiHandler, CBUIManager uiManager)

Constructors
Constructor and Description
`CBViewProtocol(CBImpression impression, Handler uiHandler, CBUIManager uiManager)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`click(JSONObject clickCoordinates)` trigger an impression click
`void`	`clickExchange(java.lang.String url, JSONObject clickCoordinates)` trigger banner click
`void`	`close()` trigger an impression close
`protected abstract CBViewProtocol.CBViewBase`	`createViewObject(Context context)` create the actual view object
`void`	`destroy()` make the view and its data ready for GC.
`void`	`destroyView()` make the view (not its data) ready for GC.
`protected void`	`display()` inform impression that display has displayed successfully
`void`	`fadeView(boolean show, View view)` helper method: fade view in or out safely
`void`	`fail(CBError.CBImpressionError error)` inform impression of a failure and end display
`JSONObject`	`getAssets()` return the assets loaded for this view
`int`	`getOrientation()`
`float`	`getVideoDuration()`
`float`	`getVideoPostion()`
`CBViewProtocol.CBViewBase`	`getView()` return the view associated with this view protocol
`static int`	`hexToColor(java.lang.String color)` helper method: turn hex string into color safely
`static boolean`	`isBigScreen(Context cx)`
`boolean`	`onBackPressed()` return true if we should swallow the back button event
`void`	`onPause()` corresponds to host activity's onPause()
`void`	`onResume()` corresponds to host activity's onResume()
`boolean`	`prepare(JSONObject response)` prepare this view to load the given server JSON response
`void`	`runDisplayTask(View view, java.lang.Runnable run, long delay)` helper method: run any asynchronous display task safely This method would be protected, but that generates hidden methods
`void`	`setReadyToDisplay()` creates the actual view, returns whether or not it was successful (or successfully cached or waiting for a valid activity)
`void`	`showView(boolean show, View view, boolean animate)` helper method: fade view in or out safely
`CBError.CBImpressionError`	`tryCreatingViewOnActivity()` Attempt to create the view associated with this view protocol's impression.
`CBError.CBImpressionError`	`tryCreatingViewOnHostView(RelativeLayout hostView)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

uiHandler
```
public final Handler uiHandler
```

uiManager
```
public final CBUIManager uiManager
```

viewOnPaused
```
public boolean viewOnPaused
```

assets
```
protected JSONObject assets
```

impression
```
public final CBImpression impression
```

orientation
```
protected int orientation
```

animationRunnables

public final java.util.Map<View,java.lang.Runnable> animationRunnables

supportsPortrait
```
protected boolean supportsPortrait
```

supportsLandscape
```
protected boolean supportsLandscape
```

Constructor Detail

CBViewProtocol

public CBViewProtocol(CBImpression impression,
                      Handler uiHandler,
                      CBUIManager uiManager)

Method Detail
- isBigScreen
```
public static boolean isBigScreen(Context cx)
```
- getOrientation
```
public int getOrientation()
```
- prepare
```
public boolean prepare(JSONObject response)
```
  prepare this view to load the given server JSON response
- setReadyToDisplay
```
public void setReadyToDisplay()
```
  creates the actual view, returns whether or not it was successful (or successfully cached or waiting for a valid activity)
- tryCreatingViewOnHostView
```
public CBError.CBImpressionError tryCreatingViewOnHostView(RelativeLayout hostView)
```
- tryCreatingViewOnActivity
```
public CBError.CBImpressionError tryCreatingViewOnActivity()
```
  Attempt to create the view associated with this view protocol's impression. Fails if it is not time to create the view, or there was an error trying to create the view (no current activity, for example).
  
  Returns:
  
  An error status code if unsuccessful, otherwise null.
- createViewObject
```
protected abstract CBViewProtocol.CBViewBase createViewObject(Context context)
```
  create the actual view object
- destroy
```
public void destroy()
```
  make the view and its data ready for GC. this calls through to destroyView()
- getView
```
public CBViewProtocol.CBViewBase getView()
```
  return the view associated with this view protocol
- destroyView
```
public void destroyView()
```
  make the view (not its data) ready for GC.
- getAssets
```
public JSONObject getAssets()
```
  return the assets loaded for this view
- fail
```
public void fail(CBError.CBImpressionError error)
```
  inform impression of a failure and end display
- close
```
public void close()
```
  trigger an impression close
- display
```
protected void display()
```
  inform impression that display has displayed successfully
- click
```
public boolean click(JSONObject clickCoordinates)
```
  trigger an impression click
  
  Returns:
- clickExchange
```
public void clickExchange(java.lang.String url,
                          JSONObject clickCoordinates)
```
  trigger banner click
- fadeView
```
public void fadeView(boolean show,
                     View view)
```
  helper method: fade view in or out safely
- showView
```
public void showView(boolean show,
                     View view,
                     boolean animate)
```
  helper method: fade view in or out safely
- runDisplayTask
```
public void runDisplayTask(View view,
                           java.lang.Runnable run,
                           long delay)
```
  helper method: run any asynchronous display task safely This method would be protected, but that generates hidden methods
- hexToColor
```
public static int hexToColor(java.lang.String color)
```
  helper method: turn hex string into color safely
- getVideoDuration
```
public float getVideoDuration()
```
- getVideoPostion
```
public float getVideoPostion()
```
- onBackPressed
```
public boolean onBackPressed()
```
  return true if we should swallow the back button event
- onResume
```
public void onResume()
```
  corresponds to host activity's onResume()
- onPause
```
public void onPause()
```
  corresponds to host activity's onPause()

Class CBViewProtocol

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

uiHandler

uiManager

viewOnPaused

assets

impression

orientation

animationRunnables

supportsPortrait

supportsLandscape

Constructor Detail

CBViewProtocol

Method Detail

isBigScreen

getOrientation

prepare

setReadyToDisplay

tryCreatingViewOnHostView

tryCreatingViewOnActivity

createViewObject

destroy

getView

destroyView

getAssets

fail

close

display

click

clickExchange

fadeView

showView

runDisplayTask

hexToColor

getVideoDuration

getVideoPostion

onBackPressed

onResume

onPause