View Javadoc

1   /*
2    *  File: IIntervalModificator.java 
3    *  Copyright (c) 2004-2009  Peter Kliem (Peter.Kliem@jaret.de)
4    *  A commercial license is available, see http://www.jaret.de.
5    *
6    *  This program is free software; you can redistribute it and/or modify
7    *  it under the terms of the GNU General Public License as published by
8    *  the Free Software Foundation; either version 2 of the License, or
9    *  (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 General Public License for more details.
15   *
16   *  You should have received a copy of the GNU General Public License
17   *  along with this program; if not, write to the Free Software
18   *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19   */
20  package de.jaret.util.ui.timebars.mod;
21  
22  import de.jaret.util.date.Interval;
23  import de.jaret.util.ui.timebars.model.TimeBarRow;
24  
25  /**
26   * Extension of the interval modificator interface that includes a more specific method for getting the gridsnap for an interval.
27   * The specific grid snap will be used if returned (instead of t he unspecific snap)
28   * 
29   * 
30   * @author kliem
31   * @version $Id$
32   */
33  public interface IIntervalModificator extends IntervalModificator {
34      /**
35       * If this method returns a positive value this is used as the modification interval. The value is given in seconds.
36       * 
37       * @param row row of the interval
38       * @param interval interval in question
39       * @return the positive grid snap or a negative value indicating no grid snap
40       */
41      double getSecondGridSnap(TimeBarRow row, Interval interval);
42  
43  }