File: MouseTrigger.java

package info (click to toggle)
timingframework 1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster, forky, sid, trixie
  • size: 288 kB
  • sloc: java: 1,501; makefile: 11
file content (150 lines) | stat: -rw-r--r-- 5,757 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
/**
 * Copyright (c) 2007, Sun Microsystems, Inc
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following 
 *     disclaimer in the documentation and/or other materials provided 
 *     with the distribution.
 *   * Neither the name of the TimingFramework project nor the names of its
 *     contributors may be used to endorse or promote products derived 
 *     from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.jdesktop.animation.timing.triggers;

import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import javax.swing.JComponent;
import org.jdesktop.animation.timing.Animator;

/**
 * MouseTrigger handles mouse events
 * and triggers an animation based on those events.
 * For example, to have anim start when component receives an
 * ENTER event, one might write the following:
 * <pre>
 *     MouseTrigger trigger = 
 *         MouseTrigger.addTrigger(component, anim, MouseTriggerEvent.ENTER);
 * </pre>
 * 
 * 
 * 
 * @author Chet
 */
public class MouseTrigger extends Trigger implements MouseListener {
    
    /**
     * Creates a non-auto-reversing MouseTrigger and adds it as a 
     * listener to component.
     * 
     * @param component component that will generate MouseEvents for this
     * trigger
     * @param animator the Animator that will start when the event occurs
     * @param event the MouseTriggerEvent that will cause the action to fire
     * @return MouseTrigger the resulting trigger
     */
    public static MouseTrigger addTrigger(JComponent component,
            Animator animator, MouseTriggerEvent event) {
        return addTrigger(component, animator, event, false);
    }
    
    /**
     * Creates a MouseTrigger and adds it as a listener to component.
     * 
     * @param component component that will generate MouseEvents for this
     * trigger
     * @param animator the Animator that will start when the event occurs
     * @param event the FocusTriggerEvent that will cause the action to fire
     * @param autoReverse flag to determine whether the animator should
     * stop and reverse based on opposite triggerEvents.
     * @return FocusTrigger the resulting trigger
     */
    public static MouseTrigger addTrigger(JComponent component,
            Animator animator, MouseTriggerEvent event, boolean autoReverse) {
        MouseTrigger trigger = new MouseTrigger(animator, event, autoReverse);
        component.addMouseListener(trigger);
        return trigger;
    }
    
    /**
     * Creates a non-auto-reversing MouseTrigger, which should be added
     * to a Component that will generate the mouse events of interest
     */
    public MouseTrigger(Animator animator, MouseTriggerEvent event) {
        this(animator, event, false);
    }

    /**
     * Creates a MouseTrigger, which should be added
     * to a Component that will generate the mouse events of interest
     */
    public MouseTrigger(Animator animator,
            MouseTriggerEvent event, boolean autoReverse) {
        super(animator, event, autoReverse);
    }

    /**
     * Called by the object which added this trigger as a MouseListener.
     * This method starts the animator if the trigger is waiting for an
     * ENTER event.
     */
    public void mouseEntered(MouseEvent e) {
        fire(MouseTriggerEvent.ENTER);
    }

    /**
     * Called by the object which added this trigger as a MouseListener.
     * This method starts the animator if the trigger is waiting for an
     * EXIT event.
     */
    public void mouseExited(MouseEvent e) {
        fire(MouseTriggerEvent.EXIT);
    }

    /**
     * Called by the object which added this trigger as a MouseListener.
     * This method starts the animator if the trigger is waiting for a
     * PRESS event.
     */
    public void mousePressed(MouseEvent e) {
        fire(MouseTriggerEvent.PRESS);
    }

    /**
     * Called by the object which added this trigger as a MouseListener.
     * This method starts the animator if the trigger is waiting for a
     * RELEASE event.
     */
    public void mouseReleased(MouseEvent e) {
        fire(MouseTriggerEvent.RELEASE);
    }

    /**
     * Called by the object which added this trigger as a MouseListener.
     * This method starts the animator if the trigger is waiting for a
     * CLICK event.
     */
    public void mouseClicked(MouseEvent e) {
        fire(MouseTriggerEvent.CLICK);
    }
    
}