~ubuntu-branches/debian/stretch/insubstantial/stretch

« back to all changes in this revision

Viewing changes to substance/src/main/java/org/pushingpixels/substance/internal/utils/RolloverMenuItemListener.java

  • Committer: Package Import Robot
  • Author(s): Felix Natter
  • Date: 2016-01-18 20:58:45 UTC
  • Revision ID: package-import@ubuntu.com-20160118205845-crbmrkda61qsi5qa
Tags: upstream-7.3+dfsg2
ImportĀ upstreamĀ versionĀ 7.3+dfsg2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/*
 
2
 * Copyright (c) 2005-2010 Substance Kirill Grouchnikov. All Rights Reserved.
 
3
 *
 
4
 * Redistribution and use in source and binary forms, with or without 
 
5
 * modification, are permitted provided that the following conditions are met:
 
6
 * 
 
7
 *  o Redistributions of source code must retain the above copyright notice, 
 
8
 *    this list of conditions and the following disclaimer. 
 
9
 *     
 
10
 *  o Redistributions in binary form must reproduce the above copyright notice, 
 
11
 *    this list of conditions and the following disclaimer in the documentation 
 
12
 *    and/or other materials provided with the distribution. 
 
13
 *     
 
14
 *  o Neither the name of Substance Kirill Grouchnikov nor the names of 
 
15
 *    its contributors may be used to endorse or promote products derived 
 
16
 *    from this software without specific prior written permission. 
 
17
 *     
 
18
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 
19
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
 
20
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
 
21
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 
 
22
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 
23
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 
24
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
 
25
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 
26
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
 
27
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, 
 
28
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 
29
 */
 
30
package org.pushingpixels.substance.internal.utils;
 
31
 
 
32
import java.awt.event.MouseEvent;
 
33
 
 
34
import javax.swing.ButtonModel;
 
35
import javax.swing.JMenuItem;
 
36
import javax.swing.event.MouseInputListener;
 
37
 
 
38
import org.pushingpixels.substance.internal.animation.StateTransitionTracker;
 
39
 
 
40
/**
 
41
 * Menu item listener for rollover effects. Tracks the mouse motion interaction
 
42
 * for the associated menu item. This class is <b>for internal use only</b>.
 
43
 * 
 
44
 * @author Kirill Grouchnikov
 
45
 */
 
46
public class RolloverMenuItemListener implements MouseInputListener {
 
47
        /**
 
48
         * If the mouse pointer is currently inside the associated menu item area,
 
49
         * <code>this</code> flag is <code>true</code>.
 
50
         */
 
51
        private boolean isMouseInside;
 
52
 
 
53
        /**
 
54
         * The associated menu item.
 
55
         */
 
56
        private JMenuItem item;
 
57
 
 
58
        private StateTransitionTracker stateTransitionTracker;
 
59
 
 
60
        /**
 
61
         * Simple constructor.
 
62
         * 
 
63
         * @param item
 
64
         *            The associated menu item.
 
65
         */
 
66
        public RolloverMenuItemListener(JMenuItem item,
 
67
                        StateTransitionTracker stateTransitionTracker) {
 
68
                this.item = item;
 
69
                this.stateTransitionTracker = stateTransitionTracker;
 
70
                this.isMouseInside = false;
 
71
        }
 
72
 
 
73
        /*
 
74
         * (non-Javadoc)
 
75
         * 
 
76
         * @see java.awt.event.MouseListener#mouseEntered(java.awt.event.MouseEvent)
 
77
         */
 
78
        @Override
 
79
    public void mouseEntered(MouseEvent e) {
 
80
                this.stateTransitionTracker.turnOffModelChangeTracking();
 
81
                try {
 
82
                        this.isMouseInside = true;
 
83
                        this.item.getModel().setRollover(true);
 
84
                } finally {
 
85
                        this.stateTransitionTracker.onModelStateChanged();
 
86
                }
 
87
        }
 
88
 
 
89
        /*
 
90
         * (non-Javadoc)
 
91
         * 
 
92
         * @see java.awt.event.MouseListener#mouseExited(java.awt.event.MouseEvent)
 
93
         */
 
94
        @Override
 
95
    public void mouseExited(MouseEvent e) {
 
96
                this.stateTransitionTracker.turnOffModelChangeTracking();
 
97
                try {
 
98
                        this.isMouseInside = false;
 
99
                        this.item.getModel().setRollover(false);
 
100
                } finally {
 
101
                        this.stateTransitionTracker.onModelStateChanged();
 
102
                }
 
103
        }
 
104
 
 
105
        /*
 
106
         * (non-Javadoc)
 
107
         * 
 
108
         * @see
 
109
         * java.awt.event.MouseListener#mouseReleased(java.awt.event.MouseEvent)
 
110
         */
 
111
        @Override
 
112
    public void mouseReleased(MouseEvent e) {
 
113
                this.stateTransitionTracker.turnOffModelChangeTracking();
 
114
                try {
 
115
                        ButtonModel model = this.item.getModel();
 
116
                        model.setRollover(false);
 
117
                } finally {
 
118
                        this.stateTransitionTracker.onModelStateChanged();
 
119
                }
 
120
        }
 
121
 
 
122
        /*
 
123
         * (non-Javadoc)
 
124
         * 
 
125
         * @see java.awt.event.MouseListener#mouseClicked(java.awt.event.MouseEvent)
 
126
         */
 
127
        @Override
 
128
    public void mouseClicked(MouseEvent e) {
 
129
        }
 
130
 
 
131
        /*
 
132
         * (non-Javadoc)
 
133
         * 
 
134
         * @see java.awt.event.MouseListener#mousePressed(java.awt.event.MouseEvent)
 
135
         */
 
136
        @Override
 
137
    public void mousePressed(MouseEvent e) {
 
138
        }
 
139
 
 
140
        /*
 
141
         * (non-Javadoc)
 
142
         * 
 
143
         * @see
 
144
         * java.awt.event.MouseMotionListener#mouseDragged(java.awt.event.MouseEvent
 
145
         * )
 
146
         */
 
147
        @Override
 
148
    public void mouseDragged(MouseEvent e) {
 
149
        }
 
150
 
 
151
        /*
 
152
         * (non-Javadoc)
 
153
         * 
 
154
         * @see
 
155
         * java.awt.event.MouseMotionListener#mouseMoved(java.awt.event.MouseEvent)
 
156
         */
 
157
        @Override
 
158
    public void mouseMoved(MouseEvent e) {
 
159
                this.stateTransitionTracker.turnOffModelChangeTracking();
 
160
                try {
 
161
                        this.item.getModel().setRollover(this.isMouseInside);
 
162
                } finally {
 
163
                        this.stateTransitionTracker.onModelStateChanged();
 
164
                }
 
165
        }
 
166
 
 
167
}