net.zer0bandwidth.android.lib.ui

Class MultitapAlertCompatDialog

java.lang.Object

android.app.Dialog

android.support.v7.app.AppCompatDialog

android.support.v7.app.AlertDialog

net.zer0bandwidth.android.lib.ui.MultitapAlertCompatDialog

All Implemented Interfaces:

android.content.DialogInterface, android.content.DialogInterface.OnClickListener, android.support.v7.app.AppCompatCallback, android.view.KeyEvent.Callback, android.view.View.OnCreateContextMenuListener, android.view.Window.Callback

public class MultitapAlertCompatDialog
extends android.support.v7.app.AlertDialog
implements android.content.DialogInterface.OnClickListener

Allows specification of a number of multiple taps before the positive button takes action. Unlike the standard AlertDialog, this class is its own builder. Special thanks to @dapayne1 for the original inspiration. This version of the dialog builds on the Android Compatibility Library. For an extension of the modern AlertDialog class, see MultitapAlertDialog.

Since:

zer0bandwidth-net/android 0.0.2 (#8)

Nested Class Summary

Nested classes/interfaces inherited from class android.support.v7.app.AlertDialog

android.support.v7.app.AlertDialog.Builder

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_TAPS_REQUIRED Specifies the default number of taps required on the positive button before its action is executed.
static java.lang.String	LOG_TAG
protected android.widget.Button	m_btnPositive Once the dialog is constructed, this will hold a persistent reference to the positive button itself, so that we can dynamically update its text.
protected int	m_nTapsCurrent The number of times that the positive button has been tapped so far.
protected int	m_nTapsRequired The number of taps required to execute the positive button's action.
protected int	m_resPositiveLabelFormat The resource ID of the string which formats the positive button's label.
protected java.lang.String	m_sPositiveLabel The positive button label.
protected java.lang.Runnable	m_taskNegative The task to be executed if the negative button is tapped.
protected java.lang.Runnable	m_taskPositive The task to be executed if the positive button is tapped sufficiently.

Fields inherited from interface android.content.DialogInterface

BUTTON_NEGATIVE, BUTTON_NEUTRAL, BUTTON_POSITIVE, BUTTON1, BUTTON2, BUTTON3

Constructor Summary

Constructors

Constructor and Description
MultitapAlertCompatDialog(android.content.Context ctx, int resTitle, int resMessage) Additional constructor allowing initial setup of title and message.

Method Summary

Modifier and Type	Method and Description
void	onClick(android.content.DialogInterface dia, int zButtonID)
protected MultitapAlertCompatDialog	regeneratePositiveLabel() Regenerates the label of the positive button, showing the difference between the number of taps required and the number of taps already intercepted.
MultitapAlertCompatDialog	setNegativeButton(int resLabel, java.lang.Runnable task) Add a negative button with the specified label, such that the specified task is executed when tapped once.
MultitapAlertCompatDialog	setNegativeButton(java.lang.Runnable task) Add a negative button which will execute the specified task when tapped once.
MultitapAlertCompatDialog	setPositiveButton(int resLabel, java.lang.Runnable task) Add a positive button with the specified label, such that the specified task is executed when tapped the requisite number of times.
MultitapAlertCompatDialog	setPositiveButton(java.lang.Runnable task) Add a positive button which will execute the specified task when tapped the requisite number of times.
MultitapAlertCompatDialog	setPositiveTapsRequired(int nTaps) Sets the number of taps required to execute the positive action.
MultitapAlertCompatDialog	setStandardButtons(java.lang.Runnable taskPositive, java.lang.Runnable taskNegative) Sets up a standard "OK" positive button and a standard "Cancel" negative button, using the specified tasks.
void	show()

Methods inherited from class android.support.v7.app.AlertDialog

getButton, getListView, onCreate, onKeyDown, onKeyUp, setButton, setButton, setButton, setCustomTitle, setIcon, setIcon, setIconAttribute, setMessage, setTitle, setView, setView

Methods inherited from class android.support.v7.app.AppCompatDialog

addContentView, findViewById, getDelegate, getSupportActionBar, invalidateOptionsMenu, onStop, onSupportActionModeFinished, onSupportActionModeStarted, onWindowStartingSupportActionMode, setContentView, setContentView, setContentView, setTitle, supportRequestWindowFeature

Methods inherited from class android.app.Dialog

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface android.content.DialogInterface

cancel, dismiss

Methods inherited from interface android.view.Window.Callback

onPointerCaptureChanged, onProvideKeyboardShortcuts

Field Detail

LOG_TAG

public static final java.lang.String LOG_TAG

DEFAULT_TAPS_REQUIRED

public static final int DEFAULT_TAPS_REQUIRED

Specifies the default number of taps required on the positive button before its action is executed.

See Also:

Constant Field Values

m_nTapsCurrent

protected int m_nTapsCurrent

The number of times that the positive button has been tapped so far.

m_nTapsRequired

protected int m_nTapsRequired

The number of taps required to execute the positive button's action.

m_resPositiveLabelFormat

protected int m_resPositiveLabelFormat

The resource ID of the string which formats the positive button's label. This defaults to a left-to-right format, but may be changed to a right-to-left format at runtime if the context demands it.

See Also:

R.string#label_btnMultitapPositive_LTR, R.string#label_btnMultitapPositive_RTL

m_sPositiveLabel

protected java.lang.String m_sPositiveLabel

The positive button label. This will be used as the first part of the string format.

See Also:

m_resPositiveLabelFormat, R.string#label_btnMultitapPositive_LTR, R.string#label_btnMultitapPositive_RTL

m_taskPositive

protected java.lang.Runnable m_taskPositive

The task to be executed if the positive button is tapped sufficiently.

m_taskNegative

protected java.lang.Runnable m_taskNegative

The task to be executed if the negative button is tapped.

m_btnPositive

protected android.widget.Button m_btnPositive

Once the dialog is constructed, this will hold a persistent reference to the positive button itself, so that we can dynamically update its text.

Constructor Detail

MultitapAlertCompatDialog

public MultitapAlertCompatDialog(android.content.Context ctx,
                                 int resTitle,
                                 int resMessage)

Additional constructor allowing initial setup of title and message.

Parameters:

ctx - the context that will spawn the dialog

resTitle - the resource ID of the title string

resMessage - the resource ID of the message string

Method Detail

setPositiveTapsRequired

public MultitapAlertCompatDialog setPositiveTapsRequired(int nTaps)

Sets the number of taps required to execute the positive action.

Parameters:

nTaps - the number of taps required

Returns:

(fluid)

setPositiveButton

public MultitapAlertCompatDialog setPositiveButton(int resLabel,
                                                   java.lang.Runnable task)

Add a positive button with the specified label, such that the specified task is executed when tapped the requisite number of times.

Parameters:

resLabel - the label for the button

task - the task to be executed

Returns:

(fluid)

setPositiveButton

public MultitapAlertCompatDialog setPositiveButton(java.lang.Runnable task)

Add a positive button which will execute the specified task when tapped the requisite number of times. The Android standard "OK" text (R.string.ok) will be used as the button label.

Parameters:

task - the task to be executed

Returns:

(fluid)

setNegativeButton

public MultitapAlertCompatDialog setNegativeButton(int resLabel,
                                                   java.lang.Runnable task)

Add a negative button with the specified label, such that the specified task is executed when tapped once.

Parameters:

resLabel - the label for the button

task - the task to be executed

Returns:

(fluid)

setNegativeButton

public MultitapAlertCompatDialog setNegativeButton(java.lang.Runnable task)

Add a negative button which will execute the specified task when tapped once. The Android standard "Cancel" (R.string.cancel) will be used as the button label.

Parameters:

task - the task to be executed

Returns:

(fluid)

setStandardButtons

public MultitapAlertCompatDialog setStandardButtons(java.lang.Runnable taskPositive,
                                                    java.lang.Runnable taskNegative)

Sets up a standard "OK" positive button and a standard "Cancel" negative button, using the specified tasks.

Parameters:

taskPositive - the task to be executed if the positive button is tapped the requisite number of times

taskNegative - the task to be executed if the negative button is tapped once

Returns:

(fluid)

regeneratePositiveLabel

protected MultitapAlertCompatDialog regeneratePositiveLabel()

Regenerates the label of the positive button, showing the difference between the number of taps required and the number of taps already intercepted.

Returns:

the positive button label

onClick

public void onClick(android.content.DialogInterface dia,
                    int zButtonID)

Specified by:

onClick in interface android.content.DialogInterface.OnClickListener

show

public void show()

Overrides:

show in class android.app.Dialog