com.facebook.internal

Class WebDialog

java.lang.Object

android.app.Dialog

com.facebook.internal.WebDialog

All Implemented Interfaces:

android.content.DialogInterface, android.view.KeyEvent.Callback, android.view.View.OnCreateContextMenuListener, android.view.Window.Callback

Direct Known Subclasses:

FacebookWebFallbackDialog

public class WebDialog
extends android.app.Dialog

com.facebook.internal is solely for the use of other packages within the Facebook SDK for Android. Use of any of the classes in this package is unsupported, and they may be modified or removed without warning at any time. This class provides a mechanism for displaying Facebook Web dialogs inside a Dialog. Helper methods are provided to construct commonly-used dialogs, or a caller can specify arbitrary parameters to call other dialogs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WebDialog.Builder
static interface	WebDialog.OnCompleteListener Interface that implements a listener to be called when the user's interaction with the dialog completes, whether because the dialog finished successfully, or it was cancelled, or an error was encountered.

Nested classes/interfaces inherited from interface android.content.DialogInterface

android.content.DialogInterface.OnCancelListener, android.content.DialogInterface.OnClickListener, android.content.DialogInterface.OnDismissListener, android.content.DialogInterface.OnKeyListener, android.content.DialogInterface.OnMultiChoiceClickListener, android.content.DialogInterface.OnShowListener

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_THEME

Fields inherited from interface android.content.DialogInterface

BUTTON_NEGATIVE, BUTTON_NEUTRAL, BUTTON_POSITIVE, BUTTON1, BUTTON2, BUTTON3

Constructor Summary

Constructors

Constructor and Description
WebDialog(android.content.Context context, java.lang.String url) Constructor which can be used to display a dialog with an already-constructed URL.
WebDialog(android.content.Context context, java.lang.String action, android.os.Bundle parameters, int theme, WebDialog.OnCompleteListener listener) Constructor which will construct the URL of the Web dialog based on the specified parameters.
WebDialog(android.content.Context context, java.lang.String url, int theme) Constructor which can be used to display a dialog with an already-constructed URL and a custom theme.

Method Summary

Modifier and Type	Method and Description
void	cancel()
void	dismiss()
WebDialog.OnCompleteListener	getOnCompleteListener() Gets the listener which will be notified when the dialog finishes.
protected android.webkit.WebView	getWebView()
protected boolean	isListenerCalled()
protected boolean	isPageFinished()
void	onAttachedToWindow()
protected void	onCreate(android.os.Bundle savedInstanceState)
void	onDetachedFromWindow()
boolean	onKeyDown(int keyCode, android.view.KeyEvent event)
protected void	onStart()
protected android.os.Bundle	parseResponseUri(java.lang.String urlString)
void	resize()
protected void	sendErrorToListener(java.lang.Throwable error)
protected void	sendSuccessToListener(android.os.Bundle values)
protected void	setExpectedRedirectUrl(java.lang.String expectedRedirectUrl)
void	setOnCompleteListener(WebDialog.OnCompleteListener listener) Sets the listener which will be notified when the dialog finishes.

Methods inherited from class android.app.Dialog

addContentView, closeOptionsMenu, create, dispatchGenericMotionEvent, dispatchKeyEvent, dispatchKeyShortcutEvent, dispatchPopulateAccessibilityEvent, dispatchTouchEvent, dispatchTrackballEvent, findViewById, getActionBar, getContext, getCurrentFocus, getLayoutInflater, getOwnerActivity, getVolumeControlStream, getWindow, hide, invalidateOptionsMenu, isShowing, onActionModeFinished, onActionModeStarted, onBackPressed, onContentChanged, onContextItemSelected, onContextMenuClosed, onCreateContextMenu, onCreateOptionsMenu, onCreatePanelMenu, onCreatePanelView, onGenericMotionEvent, onKeyLongPress, onKeyMultiple, onKeyShortcut, onKeyUp, onMenuItemSelected, onMenuOpened, onOptionsItemSelected, onOptionsMenuClosed, onPanelClosed, onPrepareOptionsMenu, onPreparePanel, onRestoreInstanceState, onSaveInstanceState, onSearchRequested, onStop, onTouchEvent, onTrackballEvent, onWindowAttributesChanged, onWindowFocusChanged, onWindowStartingActionMode, openContextMenu, openOptionsMenu, registerForContextMenu, requestWindowFeature, setCancelable, setCanceledOnTouchOutside, setCancelMessage, setContentView, setContentView, setContentView, setDismissMessage, setFeatureDrawable, setFeatureDrawableAlpha, setFeatureDrawableResource, setFeatureDrawableUri, setOnCancelListener, setOnDismissListener, setOnKeyListener, setOnShowListener, setOwnerActivity, setTitle, setTitle, setVolumeControlStream, show, takeKeyEvents, unregisterForContextMenu

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_THEME

public static final int DEFAULT_THEME

See Also:

Constant Field Values

Constructor Detail

WebDialog

public WebDialog(android.content.Context context,
                 java.lang.String url)

Constructor which can be used to display a dialog with an already-constructed URL.

Parameters:

context - the context to use to display the dialog

url - the URL of the Web Dialog to display; no validation is done on this URL, but it should be a valid URL pointing to a Facebook Web Dialog

WebDialog

public WebDialog(android.content.Context context,
                 java.lang.String url,
                 int theme)

Constructor which can be used to display a dialog with an already-constructed URL and a custom theme.

Parameters:

context - the context to use to display the dialog

url - the URL of the Web Dialog to display; no validation is done on this URL, but it should be a valid URL pointing to a Facebook Web Dialog

theme - identifier of a theme to pass to the Dialog class

WebDialog

public WebDialog(android.content.Context context,
                 java.lang.String action,
                 android.os.Bundle parameters,
                 int theme,
                 WebDialog.OnCompleteListener listener)

Constructor which will construct the URL of the Web dialog based on the specified parameters.

Parameters:

context - the context to use to display the dialog

action - the portion of the dialog URL following "dialog/"

parameters - parameters which will be included as part of the URL

theme - identifier of a theme to pass to the Dialog class

listener - the listener to notify, or null if no notification is desired

Method Detail

setOnCompleteListener

public void setOnCompleteListener(WebDialog.OnCompleteListener listener)

Sets the listener which will be notified when the dialog finishes.

Parameters:

listener - the listener to notify, or null if no notification is desired

getOnCompleteListener

public WebDialog.OnCompleteListener getOnCompleteListener()

Gets the listener which will be notified when the dialog finishes.

Returns:

the listener, or null if none has been specified

onKeyDown

public boolean onKeyDown(int keyCode,
                         android.view.KeyEvent event)

Specified by:

onKeyDown in interface android.view.KeyEvent.Callback

Overrides:

onKeyDown in class android.app.Dialog

dismiss

public void dismiss()

Specified by:

dismiss in interface android.content.DialogInterface

Overrides:

dismiss in class android.app.Dialog

onStart

protected void onStart()

Overrides:

onStart in class android.app.Dialog

onDetachedFromWindow

public void onDetachedFromWindow()

Specified by:

onDetachedFromWindow in interface android.view.Window.Callback

Overrides:

onDetachedFromWindow in class android.app.Dialog

onAttachedToWindow

public void onAttachedToWindow()

Specified by:

onAttachedToWindow in interface android.view.Window.Callback

Overrides:

onAttachedToWindow in class android.app.Dialog

onCreate

protected void onCreate(android.os.Bundle savedInstanceState)

Overrides:

onCreate in class android.app.Dialog

setExpectedRedirectUrl

protected void setExpectedRedirectUrl(java.lang.String expectedRedirectUrl)

parseResponseUri

protected android.os.Bundle parseResponseUri(java.lang.String urlString)

isListenerCalled

protected boolean isListenerCalled()

isPageFinished

protected boolean isPageFinished()

getWebView

protected android.webkit.WebView getWebView()

resize

public void resize()

sendSuccessToListener

protected void sendSuccessToListener(android.os.Bundle values)

sendErrorToListener

protected void sendErrorToListener(java.lang.Throwable error)

cancel

public void cancel()

Specified by:

cancel in interface android.content.DialogInterface

Overrides:

cancel in class android.app.Dialog