01 
02 /*
03  *  JScripter Standard 1.0 - To Script In Java
04  *  Copyright (C) 2008-2011  J.J.Liu<jianjunliu@126.com> <http://www.jscripter.org>
05  *  
06  *  This program is free software: you can redistribute it and/or modify
07  *  it under the terms of the GNU Affero General Public License as published by
08  *  the Free Software Foundation, either version 3 of the License, or
09  *  (at your option) any later version.
10  *  
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU Affero General Public License for more details.
15  *  
16  *  You should have received a copy of the GNU Affero General Public License
17  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 package jsx.ui.event;
21 
22 import js.Id;
23 import jsx.ui.Widget;
24 
25 /**
26  * <p>A type of high level events that may be fired from a source widget when 
27  * the style of the element wrapped by the widget has just been changed.</p>
28  * 
29  * @author <a href="mailto:jianjunliu@126.com">J.J.Liu (Jianjun Liu)</a> at <a href="http://www.jscripter.org" target="_blank">http://www.jscripter.org</a>
30  */
31 public final class Progress extends Widget.Event<OnProgress>
32 {
33     /**
34      * <p>A global identifier for a configurable property of a {@link Progress} object.</p>
35      * <p>The identified configurable property of a {@link Progress} object 
36      * is a referent to style object that has just been applied to the source 
37      * widget.</p>
38      * @since 1.0
39      */
40     public final static Id<Integer> RATE = new Id<Integer>();
41 
42     /**
43      * <p>Constructs an event of this type.</p>
44      * <p>This constructor simply invokes the default constructor of the superclass and 
45      * applies the argument style object to the {@link #RATE} configurable property of 
46      * this event.</p>
47      * <p>Note that, this constructor does not change the configurable properties 
48      * {@link jsx.Source.Event#BUBBLE} and {@link jsx.Source.Event#UPDATE} of this event object.</p>
49      * @param rate The rate of the required progress in centesimal, 0 for minimum, 
50      * 100 for maximum and 50 for half.
51      * @since 1.0
52      */
53     public Progress(int rate) {
54         ini(this).var(RATE, rate);
55     }
56 
57     /**
58      * <p>Dispatches this event to the specified event listener to handle, by invoking the 
59      * handler method of the listener interface passing the event itself as the argument.</p>
60      * @param on The event listener that handles this event.
61      * @since 1.0
62      */
63     @Override
64     protected final void execute(OnProgress on) {
65         on.onEvent(this);
66     }
67 }