summaryrefslogtreecommitdiffstats
path: root/src/com/itmill/toolkit/terminal/Scrollable.java
blob: a874d2fd1b29148b6768916ae9d657b8e27e7eb8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
/* 
@ITMillApache2LicenseForJavaFiles@
 */

package com.itmill.toolkit.terminal;

/**
 * <p>
 * This interface is implemented by all visual objects that can be scrolled. The
 * unit of scrolling is pixel.
 * </p>
 * 
 * @author IT Mill Ltd.
 * @version
 * @VERSION@
 * @since 3.0
 */
public interface Scrollable {

    /**
     * Gets scroll X offset.
     * 
     * <p>
     * Scrolling offset is the number of pixels this scrollable has been
     * scrolled to left.
     * </p>
     * 
     * @return Horizontal scrolling position in pixels.
     */
    public int getScrollOffsetX();

    /**
     * Sets scroll X offset.
     * 
     * <p>
     * Scrolling offset is the number of pixels this scrollable has been
     * scrolled to left.
     * </p>
     * 
     * @param pixelsScrolledLeft
     *                the xOffset.
     */
    public void setScrollOffsetX(int pixelsScrolledLeft);

    /**
     * Gets scroll Y offset.
     * 
     * <p>
     * Scrolling offset is the number of pixels this scrollable has been
     * scrolled to down.
     * </p>
     * 
     * @return Vertical scrolling position in pixels.
     */
    public int getScrollOffsetY();

    /**
     * Sets scroll Y offset.
     * 
     * <p>
     * Scrolling offset is the number of pixels this scrollable has been
     * scrolled to down.
     * </p>
     * 
     * @param pixelsScrolledDown
     *                the yOffset.
     */
    public void setScrollOffsetY(int pixelsScrolledDown);

    /**
     * Is the scrolling enabled.
     * 
     * <p>
     * Enabling scrolling allows the user to scroll the scrollable view
     * interactively
     * </p>
     * 
     * @return <code>true</code> if the scrolling is allowed, otherwise
     *         <code>false</code>.
     */
    public boolean isScrollable();

    /**
     * Enables or disables scrolling..
     * 
     * <p>
     * Enabling scrolling allows the user to scroll the scrollable view
     * interactively
     * </p>
     * 
     * @param isScrollingEnabled
     *                true if the scrolling is allowed.
     */
    public void setScrollable(boolean isScrollingEnabled);

}