PhpExt : Config [ class tree ] [ index ] [ all elements ]

Class: PhpExt_Listener

Source Location: /PhpExt/Listener.php

Class PhpExt_Listener

Method Summary
PhpExt_Listener   __construct()  
integer   getBuffer()   Causes the handler to be scheduled to run in an PhpExt_Util_DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
integer   getDelay()   The number of milliseconds to delay the invocation of the handler after the event fires.
string|PhpExt_JavascriptStm   getHandler()   The method the event invokes
string|PhpExt_JavascriptStm   getScope()   (optional) The scope in which to execute the handler function. The handler function's "this" context.
boolean   getSingle()   True to add a handler to handle just the next firing of the event, and then remove itself.
PhpExt_Listener   setBuffer()   Causes the handler to be scheduled to run in an PhpExt_Util_DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
PhpExt_Listener   setDelay()   The number of milliseconds to delay the invocation of the handler after the event fires.
PhpExt_Listener   setHandler()   The method the event invokes
PhpExt_Listener   setScope()   (optional) The scope in which to execute the handler function. The handler function's "this" context.
PhpExt_Listener   setSingle()   True to add a handler to handle just the next firing of the event, and then remove itself.

[ Top ]
Methods
Constructor __construct  [line 120]

  PhpExt_Listener __construct( $handler, [ $scope = null], [ $delay = null], [ $single = null], [ $buffer = null]  )

Parameters:
   $handler: 
   $scope: 
   $delay: 
   $single: 
   $buffer: 

API Tags:
Access:  public


Redefinition of:
PhpExt_Config_ConfigObject::__construct()

[ Top ]
getBuffer  [line 115]

  integer getBuffer( )

Causes the handler to be scheduled to run in an PhpExt_Util_DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.


API Tags:
Access:  public


[ Top ]
getDelay  [line 79]

  integer getDelay( )

The number of milliseconds to delay the invocation of the handler after the event fires.


API Tags:
Access:  public


[ Top ]
getHandler  [line 43]

  string|PhpExt_JavascriptStm getHandler( )

The method the event invokes


API Tags:
Access:  public


[ Top ]
getScope  [line 61]

  string|PhpExt_JavascriptStm getScope( )

(optional) The scope in which to execute the handler function. The handler function's "this" context.


API Tags:
Access:  public


[ Top ]
getSingle  [line 97]

  boolean getSingle( )

True to add a handler to handle just the next firing of the event, and then remove itself.


API Tags:
Access:  public


[ Top ]
setBuffer  [line 107]

  PhpExt_Listener setBuffer( integer $value  )

Causes the handler to be scheduled to run in an PhpExt_Util_DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setDelay  [line 71]

  PhpExt_Listener setDelay( integer $value  )

The number of milliseconds to delay the invocation of the handler after the event fires.

Parameters:
integer   $value: 

API Tags:
Access:  public


[ Top ]
setHandler  [line 35]

  PhpExt_Listener setHandler( string|PhpExt_JavascriptStm $value  )

The method the event invokes

Parameters:
string|PhpExt_JavascriptStm   $value: 

API Tags:
Access:  public


[ Top ]
setScope  [line 53]

  PhpExt_Listener setScope( string|PhpExt_JavascriptStm $value  )

(optional) The scope in which to execute the handler function. The handler function's "this" context.

Parameters:
string|PhpExt_JavascriptStm   $value: 

API Tags:
Access:  public


[ Top ]
setSingle  [line 89]

  PhpExt_Listener setSingle( boolean $value  )

True to add a handler to handle just the next firing of the event, and then remove itself.

Parameters:
boolean   $value: 

API Tags:
Access:  public


[ Top ]

Documentation generated on Fri, 08 Aug 2008 15:56:24 -0500 by phpDocumentor 1.4.0