/*
 * Smart GWT (GWT for SmartClient)
 * Copyright 2008 and beyond, Isomorphic Software, Inc.
 *
 * Smart GWT is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3
 * as published by the Free Software Foundation.  Smart GWT is also
 * available under typical commercial license terms - see
 * http://smartclient.com/license
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 */
/* sgwtgen */
 
package com.smartgwt.client.widgets;


import com.smartgwt.client.event.*;
import com.smartgwt.client.core.*;
import com.smartgwt.client.types.*;
import com.smartgwt.client.data.*;
import com.smartgwt.client.data.Record;
import com.smartgwt.client.data.events.*;
import com.smartgwt.client.browser.window.*;
import com.smartgwt.client.rpc.*;
import com.smartgwt.client.ai.*;
import com.smartgwt.client.callbacks.*;
import com.smartgwt.client.tools.*;
import com.smartgwt.client.bean.*;
import com.smartgwt.client.widgets.*;
import com.smartgwt.client.widgets.ai.*;
import com.smartgwt.client.widgets.events.*;
import com.smartgwt.client.widgets.form.*;
import com.smartgwt.client.widgets.form.validator.*;
import com.smartgwt.client.widgets.form.fields.*;
import com.smartgwt.client.widgets.tile.*;
import com.smartgwt.client.widgets.tile.events.*;
import com.smartgwt.client.widgets.grid.*;
import com.smartgwt.client.widgets.grid.events.*;
import com.smartgwt.client.widgets.chart.*;
import com.smartgwt.client.widgets.layout.*;
import com.smartgwt.client.widgets.layout.events.*;
import com.smartgwt.client.widgets.menu.*;
import com.smartgwt.client.widgets.tour.*;
import com.smartgwt.client.widgets.notify.*;
import com.smartgwt.client.widgets.rte.*;
import com.smartgwt.client.widgets.rte.events.*;
import com.smartgwt.client.widgets.ace.*;
import com.smartgwt.client.widgets.ace.events.*;
import com.smartgwt.client.widgets.tab.*;
import com.smartgwt.client.widgets.toolbar.*;
import com.smartgwt.client.widgets.tree.*;
import com.smartgwt.client.widgets.tree.events.*;
import com.smartgwt.client.widgets.tableview.*;
import com.smartgwt.client.widgets.viewer.*;
import com.smartgwt.client.widgets.calendar.*;
import com.smartgwt.client.widgets.calendar.events.*;
import com.smartgwt.client.widgets.cube.*;
import com.smartgwt.client.widgets.notify.*;
import com.smartgwt.client.widgets.drawing.*;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import com.google.gwt.event.shared.*;
import com.google.gwt.dom.client.Element;
import com.google.gwt.user.client.ui.Widget;
import com.google.gwt.core.client.JavaScriptObject;

import com.smartgwt.client.util.*;
import com.smartgwt.client.util.events.*;
import com.smartgwt.client.util.workflow.*;
import com.smartgwt.client.util.workflow.Process; // required to override java.lang.Process
import com.smartgwt.client.util.tour.*;


/**
 * The Hover class handles showing a simple Smart GWT canvas containing arbitrary HTML, or triggering some other action in
 * response to a user holding the mouse-pointer (or hovering) over a specific widget.
 */
@BeanFactory.FrameworkClass
public class Hover {


    // ********************* Static Attributes ***********************

    // ********************* Properties / Attributes ***********************

    // ********************* Methods ***********************

    // ********************* Static Methods ***********************

	/**
     * Hide hoverCanvas shown via {@link com.smartgwt.client.widgets.Hover#show show()}
     */
    public static native void hide() /*-{
        $wnd.isc.Hover.hide();
    }-*/;



	/**
     * Similar to {@link com.smartgwt.client.widgets.Hover#show Hover.show()} but uses the hover mechanism to display some 
     * {@link com.smartgwt.client.widgets.Canvas component} instead of showing {@link
     * com.smartgwt.client.widgets.Canvas#getHoverHTML HTML text}  in the builtin {@link
     * com.smartgwt.client.widgets.Hover#hoverCanvas hoverCanvas}.  <i>Hover.showHoverComponent()</i>  is called automatically
     * instead of <i>Hover.show()</i> when  {@link com.smartgwt.client.widgets.Canvas#getShowHoverComponents
     * Canvas.showHoverComponents} is true. <p> As with <code>Hover.show()</code>, the component-position is based on the mouse
     * pointer  position, adjusted by {@link com.smartgwt.client.widgets.Hover#leftOffset leftOffset} and {@link
     * com.smartgwt.client.widgets.Hover#topOffset topOffset}. If this  position would render the component partially clipped
     * or off-screen, it is moved to  ensure the component is entirely visible. <P> See {@link
     * com.smartgwt.client.widgets.Hover#show show()} for more information.
     * @param component component to show using the hover mechanism
     */
    public static native void showHoverComponent(Canvas component) /*-{
        $wnd.isc.Hover.showHoverComponent(component == null ? null : component.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()());
    }-*/;


    // ***********************************************************



    /**
     * Displays a standard Hover canvas containing the specified HTML content.<br> This method may also be called to modify the
     * content of the hover if it is already showing. Call {@link com.smartgwt.client.widgets.Hover#hide Hover.hide} to hide
     * the canvas again.<br> A common use case for calling this method is to asynchronously fetch detail data from the server
     * about some component, and display it in the Hover canvas when the data is returned. Note that in this case you will
     * typically need to verify that the user is still hovering  over the component in question before calling Hover.show() -
     * if the user has moved the mouse  off the component, the information will not apply to whatever is now under the mouse. 
     * Suggested approaches for handling this are to either use a {@link com.smartgwt.client.widgets.Canvas#addMouseOutHandler
     * Canvas.mouseOut} handler to track when the user moves off the component, or checking {@link
     * com.smartgwt.client.util.EventHandler#getTarget EventHandler.getTarget} as part of the asynchronous callback <p> The
     * default Hover canvas position will be based on the mouse pointer position, adjusted by {@link
     * com.smartgwt.client.widgets.Hover#leftOffset leftOffset} and {@link com.smartgwt.client.widgets.Hover#topOffset
     * topOffset}. If this position would render the Hover canvas partially clipped, it will be automatically modified to
     * ensure the Hover  is entirely visible.
     * @param contents contents for the hover. See {@link com.smartgwt.client.docs.HTMLString HTMLString}
     * @param properties object containing attributes for managing the hover canvas'   appearance. Valid properties include:<ul>  <li>left, top,
     * width, height  <li>baseStyle  <li>opacity  <li>wrap  <li>moveWithMouse  </ul>
     */
    public static native void show(String contents, Label properties) /*-{
        $wnd.isc.Hover.show(
            contents,
            (properties != null ? properties.@com.smartgwt.client.widgets.BaseWidget::getConfig()() : null));
    }-*/;

    /**
     * Displays a standard Hover canvas containing the specified canvas as the content.<br> This method may also be called to modify the
     * content of the hover if it is already showing. Call {@link com.smartgwt.client.widgets.Hover#hide Hover.hide} to hide
     * the canvas again.<br> A common use case for calling this method is to asynchronously fetch detail data from the server
     * about some component, and display it in the Hover canvas when the data is returned. Note that in this case you will
     * typically need to verify that the user is still hovering  over the component in question before calling Hover.show() -
     * if the user has moved the mouse  off the component, the information will not apply to whatever is now under the mouse. 
     * Suggested approaches for handling this are to either use a {@link com.smartgwt.client.widgets.Canvas#addMouseOutHandler
     * Canvas.mouseOut} handler to track when the user moves off the component, or checking {@link
     * com.smartgwt.client.util.EventHandler#getTarget EventHandler.getTarget} as part of the asynchronous callback <p> The
     * default Hover canvas position will be based on the mouse pointer position, adjusted by {@link
     * com.smartgwt.client.widgets.Hover#leftOffset leftOffset} and {@link com.smartgwt.client.widgets.Hover#topOffset
     * topOffset}. If this position would render the Hover canvas partially clipped, it will be automatically modified to
     * ensure the Hover  is entirely visible.
     * @param contents contents for the hover. See {@link com.smartgwt.client.docs.HTMLString HTMLString}
     * @param properties object containing attributes for managing the hover canvas'   appearance. Valid properties include:<ul>  <li>left, top,
     * width, height  <li>baseStyle  <li>opacity  <li>wrap  <li>moveWithMouse  </ul>
     */
    public static native void show(Canvas contents, Label properties) /*-{
        $wnd.isc.Hover.show(
            (contents != null ? contents.@com.smartgwt.client.widgets.BaseWidget::getOrCreateJsObj()() : null),
            (properties != null ? properties.@com.smartgwt.client.widgets.BaseWidget::getConfig()() : null));
    }-*/;

}
