blob: 641b20ab34b2a404e12b38534ff2ea5b465321c7 (
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
|
/*
* Copyright 2011 Vaadin Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.vaadin.terminal;
import java.io.Serializable;
/**
* <p>
* This interface is implemented by all visual objects that can be scrolled
* programmatically from the server-side. The unit of scrolling is pixel.
* </p>
*
* @author Vaadin Ltd.
* @since 3.0
*/
public interface Scrollable extends Serializable {
/**
* Gets scroll left offset.
*
* <p>
* Scrolling offset is the number of pixels this scrollable has been
* scrolled right.
* </p>
*
* @return Horizontal scrolling position in pixels.
*/
public int getScrollLeft();
/**
* Sets scroll left offset.
*
* <p>
* Scrolling offset is the number of pixels this scrollable has been
* scrolled right.
* </p>
*
* @param scrollLeft
* the xOffset.
*/
public void setScrollLeft(int scrollLeft);
/**
* Gets scroll top offset.
*
* <p>
* Scrolling offset is the number of pixels this scrollable has been
* scrolled down.
* </p>
*
* @return Vertical scrolling position in pixels.
*/
public int getScrollTop();
/**
* Sets scroll top offset.
*
* <p>
* Scrolling offset is the number of pixels this scrollable has been
* scrolled down.
* </p>
*
* <p>
* The scrolling position is limited by the current height of the content
* area. If the position is below the height, it is scrolled to the bottom.
* However, if the same response also adds height to the content area,
* scrolling to bottom only scrolls to the bottom of the previous content
* area.
* </p>
*
* @param scrollTop
* the yOffset.
*/
public void setScrollTop(int scrollTop);
}
|
