001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.gwt.client.ui;
029
030import com.google.gwt.event.dom.client.HasMouseOutHandlers;
031import com.google.gwt.event.dom.client.HasMouseOverHandlers;
032import com.google.gwt.event.dom.client.MouseOutEvent;
033import com.google.gwt.event.dom.client.MouseOutHandler;
034import com.google.gwt.event.dom.client.MouseOverEvent;
035import com.google.gwt.event.dom.client.MouseOverHandler;
036import com.google.gwt.event.shared.HandlerRegistration;
037import com.google.gwt.user.client.ui.HTMLPanel;
038
039/**
040 * A HTML Panel implementation toggles the I_CmsStateCss.cmsHovering CSS class on mouse over.<p>
041 *
042 * @since 8.0.0
043 */
044public class CmsHTMLHoverPanel extends HTMLPanel implements HasMouseOutHandlers, HasMouseOverHandlers {
045
046    /**
047     * Creates an HTML hover panel with the specified HTML contents inside a DIV element. Any element within this HTML that has a specified id can contain a child widget.
048     *
049     * @param html the panel's HTML
050     */
051    public CmsHTMLHoverPanel(String html) {
052
053        super(html);
054        setHandler();
055    }
056
057    /**
058     * Creates an HTML hover panel whose root element has the given tag, and with the specified HTML contents. Any element within this HTML that has a specified id can contain a child widget.
059     *
060     * @param tag the tag of the root element
061     * @param html the panel's HTML
062     */
063    public CmsHTMLHoverPanel(String tag, String html) {
064
065        super(tag, html);
066        setHandler();
067    }
068
069    /**
070     * @see com.google.gwt.event.dom.client.HasMouseOutHandlers#addMouseOutHandler(com.google.gwt.event.dom.client.MouseOutHandler)
071     */
072    public HandlerRegistration addMouseOutHandler(MouseOutHandler handler) {
073
074        return addDomHandler(handler, MouseOutEvent.getType());
075
076    }
077
078    /**
079     * @see com.google.gwt.event.dom.client.HasMouseOverHandlers#addMouseOverHandler(com.google.gwt.event.dom.client.MouseOverHandler)
080     */
081    public HandlerRegistration addMouseOverHandler(MouseOverHandler handler) {
082
083        return addDomHandler(handler, MouseOverEvent.getType());
084    }
085
086    /**
087     * Sets the hover handler.<p>
088     */
089    private void setHandler() {
090
091        A_CmsHoverHandler handler = new CmsClassHoverHandler(getElement());
092        addMouseOutHandler(handler);
093        addMouseOverHandler(handler);
094    }
095}