self.philbrown.droidQuery
Class Callbacks

java.lang.Object
  self.philbrown.droidQuery.Callbacks

public class Callbacks
extends Object

A multi-purpose callbacks list object that provides a powerful way to manage callback lists.

Author:

Phil Brown

Nested Class Summary

static class

Callbacks.CallbacksOptions Callback options

Constructor Summary

Callbacks()
Constructor

Callbacks(Context context)
Constructor

Callbacks(Context context, Callbacks.CallbacksOptions opt)
Constructor

Method Summary

void	add(Function function) Add a callback or a collection of callbacks to a callback list.
void	add(Function[] _functions) Add a callback or a collection of callbacks to a callback list.
void	add(List<Function> _functions) Add a callback or a collection of callbacks to a callback list.
void	disable() Disable a callback list from doing anything more.
boolean	disabled() Determine if the callbacks list has been disabled.
void	empty() Remove all of the callbacks from a list.
void	enable() Allow a callback list to do more.
boolean	enabled() Determine whether or not the callbacks list has been disabled.
void	fire() Call all of the callbacks with the given arguments
void	fire(Object... args) Call all of the callbacks with the given arguments
boolean	fired() Determine if the callbacks have already been called at least once.
void	fireWith(Object... args) Call all callbacks in a list with the given context and arguments.
boolean	has(Function function) Determine whether a supplied callback is in a list
void	lock() Lock a callback list in its current state.
boolean	locked() Determine if the callbacks list has been locked.
void	remove(Function function) Remove a callback or a collection of callbacks from a callback list.
void	unlock() Unlocks a callback, allowing further state changes

Methods inherited from class java.lang.Object

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

Constructor Detail

Callbacks

public Callbacks()

Constructor

Callbacks

public Callbacks(Context context)

Constructor

Parameters:

context - used to create the droidQuery Object that will be passed to callback functions

Callbacks

public Callbacks(Context context,
                 Callbacks.CallbacksOptions opt)

Constructor

Parameters:

context - used to create the droidQuery Object that will be passed to callback functions

opt - the Callbacks Options

Method Detail

add

public void add(Function function)

Add a callback or a collection of callbacks to a callback list.

Parameters:

function - a function to add

add

public void add(Function[] _functions)

Add a callback or a collection of callbacks to a callback list.

Parameters:

function - an array of functions to add

add

public void add(List<Function> _functions)

Add a callback or a collection of callbacks to a callback list.

Parameters:

function - a list of functions to add

disable

public void disable()

Disable a callback list from doing anything more.

disabled

public boolean disabled()

Determine if the callbacks list has been disabled.

Returns:

empty

public void empty()

Remove all of the callbacks from a list.

enable

public void enable()

Allow a callback list to do more.

enabled

public boolean enabled()

Determine whether or not the callbacks list has been disabled.

Returns:

fire

public void fire()

Call all of the callbacks with the given arguments

fire

public void fire(Object... args)

Call all of the callbacks with the given arguments

fired

public boolean fired()

Determine if the callbacks have already been called at least once.

Returns:

fireWith

public void fireWith(Object... args)

Call all callbacks in a list with the given context and arguments.

Parameters:

args -

has

public boolean has(Function function)

Determine whether a supplied callback is in a list

Parameters:

function -

Returns:

lock

public void lock()

Lock a callback list in its current state.

locked

public boolean locked()

Determine if the callbacks list has been locked.

Returns:

remove

public void remove(Function function)

Remove a callback or a collection of callbacks from a callback list.

Parameters:

function -

unlock

public void unlock()

Unlocks a callback, allowing further state changes