← Back to branch summary

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

« back to all changes in this revision

Viewing changes to flamingo/src/main/java/org/pushingpixels/flamingo/api/ribbon/resize/RibbonBandResizeSequencingPolicy.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:
flamingo/src/main/java/org/pushingpixels/flamingo/api/ribbon/resize/RibbonBandResizeSequencingPolicy.java
 
1
/*
 
2
 * Copyright (c) 2005-2010 Flamingo 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 Flamingo 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.flamingo.api.ribbon.resize;
 
31
 
 
32
import org.pushingpixels.flamingo.api.ribbon.AbstractRibbonBand;
 
33
import org.pushingpixels.flamingo.api.ribbon.RibbonTask;
 
34
import org.pushingpixels.flamingo.api.ribbon.resize.CoreRibbonResizeSequencingPolicies.CollapseFromLast;
 
35
import org.pushingpixels.flamingo.api.ribbon.resize.CoreRibbonResizeSequencingPolicies.RoundRobin;
 
36
 
 
37
/**
 
38
 * Defines the resize sequencing policies for {@link RibbonTask}s.
 
39
 * 
 
40
 * <p>
 
41
 * The resize sequencing policy defines which ribbon band will be chosen next
 
42
 * when the ribbon is shrinked / expanded. It is installed with the
 
43
 * {@link RibbonTask#setResizeSequencingPolicy(RibbonBandResizeSequencingPolicy)}
 
44
 * .
 
45
 * </p>
 
46
 * 
 
47
 * <p>
 
48
 * The {@link CoreRibbonResizeSequencingPolicies} provides two built in resize
 
49
 * sequencing policies:
 
50
 * </p>
 
51
 * 
 
52
 * <ul>
 
53
 * <li>{@link RoundRobin} under which the ribbon bands are being collapsed in a
 
54
 * cyclic fashion, distributing the collapsed pixels between the different
 
55
 * bands.</li>
 
56
 * <li>{@link CollapseFromLast} under which the ribbon bands are being collapsed
 
57
 * from right to left.</li>
 
58
 * </ul>
 
59
 * 
 
60
 * @author Kirill Grouchnikov
 
61
 */
 
62
public interface RibbonBandResizeSequencingPolicy {
 
63
        /**
 
64
         * Resets this policy. Note that this method is for internal use only and
 
65
         * should not be called by the application code.
 
66
         */
 
67
        public void reset();
 
68
 
 
69
        /**
 
70
         * Returns the next ribbon band for collapse.
 
71
         * 
 
72
         * @return The next ribbon band for collapse.
 
73
         */
 
74
        public AbstractRibbonBand next();
 
75
}