UserEvent.java :  » Ajax » ItsNat » org » itsnat » core » event » Java Open Source

/*
  ItsNat Java Web Application Framework
  Copyright (C) 2007 Innowhere Software Services S.L., Spanish Company
  Author: Jose Maria Arranz Santamaria

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU Affero General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version. See the GNU Affero General Public 
  License for more details. See the copy of the GNU Affero General Public License
  included in this program. If not, see <http://www.gnu.org/licenses/>.
*/

package org.itsnat.core.event;

/**
 * This event is fired by the client calling the ItsNat JavaScript method 
 * <code>fireUserEvent</code> with a node target and a user defined name 
 * and is received by the user defined listener registered with that target and name.
 *
 * <p>Default implementation inherits from <code>java.util.EventObject</code>.</p>
 *
 * @see org.itsnat.core.ItsNatDocument#addUserEventListener(org.w3c.dom.events.EventTarget,String,EventListener,int,ParamTransport[],String,long)
 * @author Jose Maria Arranz Santamaria
 */
public interface UserEvent extends DOMExtensionEvent
{ 
    /**
     * Returns the user defined event/listener name.
     *
     * @return the event name.
     */
    public String getName();
}