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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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 org.apache.poi.ss.usermodel;
/**
* A client anchor is attached to an excel worksheet. It anchors against a
* top-left and bottom-right cell.
*
* @author Yegor Kozlov
*/
public interface ClientAnchor {
/**
* Move and Resize With Anchor Cells
* <p>
* Specifies that the current drawing shall move and
* resize to maintain its row and column anchors (i.e. the
* object is anchored to the actual from and to row and column)
* </p>
*/
public static final int MOVE_AND_RESIZE = 0;
/**
* Move With Cells but Do Not Resize
* <p>
* Specifies that the current drawing shall move with its
* row and column (i.e. the object is anchored to the
* actual from row and column), but that the size shall remain absolute.
* </p>
* <p>
* If additional rows/columns are added between the from and to locations of the drawing,
* the drawing shall move its to anchors as needed to maintain this same absolute size.
* </p>
*/
public static final int MOVE_DONT_RESIZE = 2;
/**
* Do Not Move or Resize With Underlying Rows/Columns
* <p>
* Specifies that the current start and end positions shall
* be maintained with respect to the distances from the
* absolute start point of the worksheet.
* </p>
* <p>
* If additional rows/columns are added before the
* drawing, the drawing shall move its anchors as needed
* to maintain this same absolute position.
* </p>
*/
public static final int DONT_MOVE_AND_RESIZE = 3;
/**
* Returns the column (0 based) of the first cell.
*
* @return 0-based column of the first cell.
*/
public short getCol1();
/**
* Sets the column (0 based) of the first cell.
*
* @param col1 0-based column of the first cell.
*/
public void setCol1(int col1);
/**
* Returns the column (0 based) of the second cell.
*
* @return 0-based column of the second cell.
*/
public short getCol2();
/**
* Returns the column (0 based) of the second cell.
*
* @param col2 0-based column of the second cell.
*/
public void setCol2(int col2);
/**
* Returns the row (0 based) of the first cell.
*
* @return 0-based row of the first cell.
*/
public int getRow1();
/**
* Returns the row (0 based) of the first cell.
*
* @param row1 0-based row of the first cell.
*/
public void setRow1(int row1);
/**
* Returns the row (0 based) of the second cell.
*
* @return 0-based row of the second cell.
*/
public int getRow2();
/**
* Returns the row (0 based) of the first cell.
*
* @param row2 0-based row of the first cell.
*/
public void setRow2(int row2);
/**
* Returns the x coordinate within the first cell.
*
* Note - XSSF and HSSF have a slightly different coordinate
* system, values in XSSF are larger by a factor of
* {@link org.apache.poi.xssf.usermodel.XSSFShape#EMU_PER_PIXEL}
*
* @return the x coordinate within the first cell
*/
public int getDx1();
/**
* Sets the x coordinate within the first cell
*
* Note - XSSF and HSSF have a slightly different coordinate
* system, values in XSSF are larger by a factor of
* {@link org.apache.poi.xssf.usermodel.XSSFShape#EMU_PER_PIXEL}
*
* @param dx1 the x coordinate within the first cell
*/
public void setDx1(int dx1);
/**
* Returns the y coordinate within the first cell
*
* Note - XSSF and HSSF have a slightly different coordinate
* system, values in XSSF are larger by a factor of
* {@link org.apache.poi.xssf.usermodel.XSSFShape#EMU_PER_PIXEL}
*
* @return the y coordinate within the first cell
*/
public int getDy1();
/**
* Sets the y coordinate within the first cell
*
* Note - XSSF and HSSF have a slightly different coordinate
* system, values in XSSF are larger by a factor of
* {@link org.apache.poi.xssf.usermodel.XSSFShape#EMU_PER_PIXEL}
*
* @param dy1 the y coordinate within the first cell
*/
public void setDy1(int dy1);
/**
* Sets the y coordinate within the second cell
*
* Note - XSSF and HSSF have a slightly different coordinate
* system, values in XSSF are larger by a factor of
* {@link org.apache.poi.xssf.usermodel.XSSFShape#EMU_PER_PIXEL}
*
* @return the y coordinate within the second cell
*/
public int getDy2();
/**
* Sets the y coordinate within the second cell
*
* Note - XSSF and HSSF have a slightly different coordinate
* system, values in XSSF are larger by a factor of
* {@link org.apache.poi.xssf.usermodel.XSSFShape#EMU_PER_PIXEL}
*
* @param dy2 the y coordinate within the second cell
*/
public void setDy2(int dy2);
/**
* Returns the x coordinate within the second cell
*
* Note - XSSF and HSSF have a slightly different coordinate
* system, values in XSSF are larger by a factor of
* {@link org.apache.poi.xssf.usermodel.XSSFShape#EMU_PER_PIXEL}
*
* @return the x coordinate within the second cell
*/
public int getDx2();
/**
* Sets the x coordinate within the second cell
*
* Note - XSSF and HSSF have a slightly different coordinate
* system, values in XSSF are larger by a factor of
* {@link org.apache.poi.xssf.usermodel.XSSFShape#EMU_PER_PIXEL}
*
* @param dx2 the x coordinate within the second cell
*/
public void setDx2(int dx2);
/**
* Sets the anchor type
* <p>
* 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
* </p>
* @param anchorType the anchor type
* @see #MOVE_AND_RESIZE
* @see #MOVE_DONT_RESIZE
* @see #DONT_MOVE_AND_RESIZE
*/
public void setAnchorType( int anchorType );
/**
* Gets the anchor type
* <p>
* 0 = Move and size with Cells, 2 = Move but don't size with cells, 3 = Don't move or size with cells.
* </p>
* @return the anchor type
* @see #MOVE_AND_RESIZE
* @see #MOVE_DONT_RESIZE
* @see #DONT_MOVE_AND_RESIZE
*/
public int getAnchorType();
}
|
