001package votorola.g.web.gwt.event; // Copyright 2012, Michael Allan.  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Votorola Software"), to deal in the Votorola Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicence, and/or sell copies of the Votorola Software, and to permit persons to whom the Votorola Software is furnished to do so, subject to the following conditions: The preceding copyright notice and this permission notice shall be included in all copies or substantial portions of the Votorola Software. THE VOTOROLA SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE VOTOROLA SOFTWARE OR THE USE OR OTHER DEALINGS IN THE VOTOROLA SOFTWARE.
002
003import com.google.gwt.core.client.Scheduler;
004import com.google.gwt.event.shared.GwtEvent;
005import com.google.gwt.event.shared.HasHandlers;
006
007
008/** An event that signals a change.
009  */
010public final class Change extends GwtEvent<ChangeHandler>
011{
012
013
014    /** The common type key for all change events.
015      */
016    public static final Type<ChangeHandler> TYPE = new Type<ChangeHandler>();
017
018
019
020   // - G w t - E v e n t ----------------------------------------------------------------
021
022
023    public @Override Type<ChangeHandler> getAssociatedType() { return TYPE; }
024
025
026
027    protected @Override void dispatch( final ChangeHandler h ) { h.onChange( Change.this ); }
028
029
030
031   // ====================================================================================
032
033
034    /** A coalescing scheduler for the dispatch of change events.  Call {@linkplain
035      * #schedule() schedule}() one or more times to fire a single event in the next
036      * dispatch phase.
037      */
038    public static final class CoalescingGun extends CoalescingSchedulerS
039      implements Scheduler.ScheduledCommand
040    {
041
042        /** Constructs a new CoalescingGun.
043          *
044          *     @see #source()
045          *     @see #phaser()
046          */
047        public CoalescingGun( HasHandlers _source, Phaser _phaser )
048        {
049            super( Scheduler.get(), _phaser );
050            source = _source;
051            init( CoalescingGun.this );
052        }
053
054
055       // --------------------------------------------------------------------------------
056
057
058        /** The source from which the change events are to be fired.
059          */
060        public HasHandlers source() { return source; }
061
062
063            private final HasHandlers source;
064
065
066       // - S c h e d u l e r . S c h e d u l e d - C o m m a n d ------------------------
067
068
069        public void execute() { source.fireEvent( new Change() ); }
070
071    }
072}