AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    Do.Method Class

    Defined in: yui3/src/event-custom/js/event-do.js:192
    Module: event-custom-base
    Parent Module: event-custom

    Wrapper for a displaced method with aop enabled

    Constructor

    Do.Method

    (
    • obj
    • sFn
    )

    Defined in yui3/src/event-custom/js/event-do.js:192

    Parameters:

    • obj Object

      The object to operate on

    • sFn Object

      The name of the method to displace

    Index

    Methods

    Methods

    delete

    (
    • sid
    • fn
    • when
    )

    Defined in yui3/src/event-custom/js/event-do.js:222

    Unregister a aop subscriber

    Parameters:

    • sid String

      the subscriber id

    • fn Function

      the function to execute

    • when String

      when to execute the function

    exec

    (
    • arg
    )
    Any

    Defined in yui3/src/event-custom/js/event-do.js:235

    <p>Execute the wrapped method. All arguments are passed into the wrapping functions. If any of the before wrappers return an instance of <code>Y.Do.Halt</code> or <code>Y.Do.Prevent</code>, neither the wrapped function nor any after phase subscribers will be executed.</p>

    <p>The return value will be the return value of the wrapped function or one provided by a wrapper function via an instance of <code>Y.Do.Halt</code> or <code>Y.Do.AlterReturn</code>.

    Parameters:

    • arg Any multiple

      Arguments are passed to the wrapping and wrapped functions

    Returns:

    Any:

    Return value of wrapped function unless overwritten (see above)

    register

    (
    • sid
    • fn
    • when
    )

    Defined in yui3/src/event-custom/js/event-do.js:207

    Register a aop subscriber

    Parameters:

    • sid String

      the subscriber id

    • fn Function

      the function to execute

    • when String

      when to execute the function