as2lib 0.9

     1  /*
     2   * Copyright the original author or authors.
     3   * 
     4   * Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   * 
     8   *      http://www.mozilla.org/MPL/MPL-1.1.html
     9   * 
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  import org.as2lib.env.event.EventListener;
    18  import org.as2lib.env.event.impulse.FrameImpulse;
    19  
    20  /**
    21   * {@code FrameImpulseListener} is a interface for listening to a FrameImpulse.
    22   * 
    23   * <p>{@link FrameImpulse} allows three ways of listening to a certain impulse.
    24   * {@link Executable} with {@link Impulse#connectExecutable} allows in some
    25   * cases only bad readable usages.
    26   * 
    27   * <p>With {@link FrameImpulse#addListener} its possible to add a listener typed
    28   * as {@code FrameImpulseListener}. The method {@link #onFrameImpulse} will be
    29   * called on each impulse.
    30   *
    31   * @author Martin Heidegger
    32   * @version 1.0
    33   */
    34  interface org.as2lib.env.event.impulse.FrameImpulseListener extends EventListener {
    35  	
    36  	/**
    37  	 * Method to be executed on a impulse.
    38  	 * 
    39  	 * @param impulse {@link FrameImpulse} where the listener was added.
    40  	 */
    41  	public function onFrameImpulse(impulse:FrameImpulse):Void;
    42  }