callbacks.locked()S2C Home « Objects « callbacks.locked()

• <<    callbacks.lock()
• callbacks.remove()     >>

Locked callbacks list state.

Description

The callbacks.locked() Callbacks object method, allows us to determine whether the callback list is in a locked state.

Syntax

Parameters

None.

Return

Boolean.

callbacks.locked() ExampleTop

Determine whether the callback list is in a locked state.

In the example below when we press the button the first time we add the aFunc(value, div) function to our callbacks list and then fire the list off. We then check to see if the callbacks list has been locked using the callbacks.locked() method, which returns false. After this we lock the list and then try to add and fire the bFunc(value, div) function. Because the callback list is now locked nothing happens. We then check to see if the callbacks list has been locked using the callbacks.locked() method, which now returns true.

$(function(){
  $('#btn12').one('click', function(){
    var ourCallbacks = $.Callbacks();
    ourCallbacks.add( aFunc );
    ourCallbacks.fire( 'The aFunc function was fired from our callbacks. <br>', '#div12');
    $('#div12').append( 'Has callbacks list been locked? ' + ourCallbacks.locked() + '<br>');
    ourCallbacks.lock();
    ourCallbacks.add( bFunc );
    ourCallbacks.fire( 'The bFunc function was fired from our callbacks. <br>', '#div12');
    $('#div12').append( 'Has callbacks list been locked? ' + ourCallbacks.locked()  + '<br>');
  });
  function aFunc( value, div ){
    $(div).append( value);
  }
  function bFunc( value, div ){
    aFunc('Passing bFunc function value to aFunc. <br>', div);
  }
});

• <<    callbacks.lock()
• callbacks.remove()     >>