org.wings.SToolTipManager Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of wings Show documentation
The newest version!
/*
 * Copyright 2000,2005 wingS development team.
 *
 * This file is part of wingS (http://wingsframework.org).
 *
 * wingS is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2.1
 * of the License, or (at your option) any later version.
 *
 * Please see COPYING for the complete licence.
 */
package org.wings;

import org.wings.session.SessionManager;
import java.io.Serializable;
import java.util.Set;

/**
 * Defines the behaviour of component tooltips.
 *
 * @author hengels
 */
public class SToolTipManager implements Serializable {
    private int initialDelay = 1000;
    private int dismissDelay = 3000;
    private boolean followMouse = true;
    
    /**
     * @return The initial delay in ms the mouse pointer has to rest over a component
     * before it's tooltip is shown
     */
    public int getInitialDelay() {
        return initialDelay;
    }
    
    /**
     * @param initialDelay The initial delay in ms the mouse pointer has to rest over a component
     * before it's tooltip is shown
     */
    public void setInitialDelay(int initialDelay) {
        if (this.initialDelay != initialDelay) {
            Set frames = SessionManager.getSession().getFrames();
            frames.forEach(SComponent::reload);
            this.initialDelay = initialDelay;
        }
    }
    
    /**
     * @return The delay in ms before a tooltip is hidden automatically
     */
    public int getDismissDelay() {
        return dismissDelay;
    }
    
    /**
     * @param dismissDelay The delay in ms before a tooltip is hidden automatically
     */
    public void setDismissDelay(int dismissDelay) {
        if (this.dismissDelay != dismissDelay) {
            Set frames = SessionManager.getSession().getFrames();
            frames.forEach(SComponent::reload);
            this.dismissDelay = dismissDelay;
        }
    }
    
    /**
     * @return true if the tooltip popup should follow the mouse movements.
     */
    public boolean isFollowMouse() {
        return followMouse;
    }

    /**
     * @param followMouse true if the tooltip popup should follow the mouse movements.
     */
    public void setFollowMouse(boolean followMouse) {
        if (this.followMouse != followMouse) {
            Set frames = SessionManager.getSession().getFrames();
            frames.forEach(SComponent::reload);
            this.followMouse = followMouse;
        }
    }
    
    public static SToolTipManager sharedInstance() {
        return SessionManager.getSession().getToolTipManager();
    }
}