+Show TOC
×Hide TOC

LoopCommandListener

Kind of class:	public interface
Package:	com.bourre.commands
Inherits from:	ASyncCommandListener
Author:	Cédric Néhémie
Classpath:	com.bourre.commands.LoopCommandListener
File last modified:	Monday, 24 November 2008, 11:36:52

► View source

▼ Hide source

/*
 * Copyright the original author or authors.
 * 
 * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.bourre.commands 
{
    import com.bourre.events.LoopEvent;    

    /**
     * Objects which want to listen to a <code>LoopCommand</code>
     * instance have to implement the <code>LoopCommandListener</code>
     * interface.
     * 
     * @author C√©dric N√©h√©mie
     */
    public interface LoopCommandListener extends ASyncCommandListener 
    {
        /**
         * Called when the loop command start or restart its process.
         * 
         * @param    e    event object dispatched by the loop command
         */
        function onLoopStart( e : LoopEvent ) : void;
        
        /**
         * Called at each step performed by the loop. 
         * 
         * @param    e    event object dispatched by the loop command
         */
        function onLoopProgress( e : LoopEvent ) : void;
        
        /**
         * Called when the loop command stop its process.
         * 
         * @param    e    event object dispatched by the loop command
         */
        function onLoopStop( e : LoopEvent ) : void;
        
        /**
         * Called at the end of the loop process.
         * 
         * @param    e    event object dispatched by the loop command
         */
        function onLoopEnd( e : LoopEvent ) : void;
        
        /**
         * Called when the loop have been canceled due to a user
         * input.
         * 
         * @param    e    event object dispatched by the loop command
         */
        function onLoopCancel( e : LoopEvent ) : void;
    }
}

Objects which want to listen to a LoopCommandinstance have to implement the LoopCommandListenerinterface.

Summary

Instance methods

Instance methods inherited from ASyncCommandListener

onCommandEnd

Event handlers

onLoopStart (e:LoopEvent) : void
- Called when the loop command start or restart its process.
onLoopProgress (e:LoopEvent) : void
- Called at each step performed by the loop.
onLoopStop (e:LoopEvent) : void
- Called when the loop command stop its process.
onLoopEnd (e:LoopEvent) : void
- Called at the end of the loop process.
onLoopCancel (e:LoopEvent) : void
- Called when the loop have been canceled due to a user

Event handlers inherited from ASyncCommandListener

onCommandEnd

Event handlers

onLoopCancel

public function onLoopCancel (

e:LoopEvent) : void

Called when the loop have been canceled due to a user
input.

Parameters: