package textbender.o.rhinohide.events; // Copyright 2006, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Textbender Software"), to deal in the Textbender Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Textbender Software, and to permit persons to whom the Textbender Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Textbender Software. THE TEXTBENDER SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE TEXTBENDER SOFTWARE OR THE USE OR OTHER DEALINGS IN THE TEXTBENDER SOFTWARE.

import netscape.javascript.JSObject;
import org.w3c.dom.events.*;
import org.w3c.dom.views.AbstractView;
import textbender.g.lang.ThreadSafe;
import textbender.o.rhinohide.*;
import textbender.o.rhinohide.core.*;


/** A mouse event implemented as an overlay of a JavaScript mouse event.
  */
@ThreadSafe final class RhiMouseEvent extends RhiUIEvent implements MouseEvent
{


    /** Constructs a RhiMouseEvent.
      *
      *     @param window global object
      *     @param jsObject bridge to underlying JavaScript event,
      *         per {@linkplain Rhinohide#jsObject() jsObject}()
      *     @param isAsync per {@linkplain RhiEvent#isAsync() isAsync}()
      *
      *     @return event, or null if jsObject is null
      */
    public static RhiMouseEvent wrapMouseEvent( RhiWindow window, JSObject jsObject, boolean isAsync )
    {
        if( jsObject == null ) return null;

        return new RhiMouseEvent( window, jsObject, isAsync );
    }



    RhiMouseEvent( RhiWindow window, JSObject jsObject, boolean isAsync )
    {
        super( window, jsObject, isAsync );
    }



   // - M o u s e - E v e n t ------------------------------------------------------------


    public boolean getAltKey() { return (Boolean)getMemberV( "altKey" ); }



    public short getButton() { return ((Number)getMemberV( "button" )).shortValue(); }



    public int getClientX() { return ((Number)getMemberV( "clientX" )).intValue(); } // never tested, these 2



        public int getClientY() { return ((Number)getMemberV( "clientY" )).intValue(); }



    public boolean getCtrlKey() { return (Boolean)getMemberV( "ctrlKey" ); }



    public boolean getMetaKey() { return (Boolean)getMemberV( "metaKey" ); }



    public EventTarget getRelatedTarget()
    {
        return RhiNode.wrapNode( window, (JSObject)getMember( "relatedTarget" ));
    }



    public int getScreenX() { return ((Number)getMemberV( "screenX" )).intValue(); }



        public int getScreenY() { return ((Number)getMemberV( "screenY" )).intValue(); }



    public boolean getShiftKey()  { return (Boolean)getMemberV( "shiftKey" ); }



    /** Not yet coded.
      *
      *     @throws UnsupportedOperationException
      */
    public void initMouseEvent(
        String typeArg, boolean canBubbleArg, boolean cancelableArg,
        AbstractView viewArg, int detailArg,
        int screenXArg, int screenYArg, int clientXArg, int clientYArg,
        boolean ctrlKeyArg, boolean altKeyArg, boolean shiftKeyArg, boolean metaKeyArg,
        short buttonArg, EventTarget relatedTargetArg
    ){
        throw new UnsupportedOperationException();
    }



}