@compass-framework/core 1.2.59 → 1.2.60

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,10 +1,9 @@
1
1
  import { ArrayList, Implements, XML } from "@compass-framework/library";
2
2
  import { Resources } from "./Resources";
3
3
  import { View } from "./View";
4
- import { WindowContext } from "./WindowContext";
4
+ import { Context } from "./Context";
5
5
  import { WindowManager } from "./WindowManager";
6
6
  import { ViewGroup } from "./ViewGroup";
7
- import { Context } from "./Context";
8
7
  import { Window } from "./Window";
9
8
  import { Configuration } from "./Configuration";
10
9
 
@@ -14,7 +13,7 @@ import { Configuration } from "./Configuration";
14
13
  @Implements(Window)
15
14
  export declare class ApplicationWindow implements Window {
16
15
  public constructor();
17
- public constructor(context: WindowContext);
16
+ public constructor(context: Context);
18
17
 
19
18
  public findViewById(id: number): View;
20
19
  public findViewById(id: string): View;
package/@types/Color.d.ts CHANGED
@@ -30,11 +30,11 @@ export declare namespace Color {
30
30
 
31
31
  export function blue(color: number): number;
32
32
 
33
- export function argb(alpha: number, red: number, green: number, blue: number);
33
+ export function argb(alpha: number, red: number, green: number, blue: number): number;
34
34
 
35
35
  export function hue(color: number): number;
36
36
 
37
- export function rgb(red: number, green: number, blue: number);
37
+ export function rgb(red: number, green: number, blue: number): number;
38
38
 
39
39
  export function pin(value: number): number;
40
40
 
@@ -4,29 +4,29 @@ import { Rect } from "./Rect";
4
4
  * 重力对齐常量与布局定位工具。
5
5
  */
6
6
  export declare class Gravity {
7
- public static NO_GRAVITY;
8
- public static AXIS_PULL_BEFORE;
9
- public static AXIS_SPECIFIED;
10
- public static AXIS_PULL_AFTER;
11
- public static AXIS_CLIP;
12
- public static AXIS_X_SHIFT;
13
- public static AXIS_Y_SHIFT;
14
- public static TOP;
15
- public static BOTTOM;
16
- public static LEFT;
17
- public static RIGHT;
18
- public static CENTER_VERTICAL;
19
- public static FILL_VERTICAL;
20
- public static CENTER_HORIZONTAL;
21
- public static FILL_HORIZONTAL;
22
- public static CENTER;
23
- public static FILL;
24
- public static CLIP_VERTICAL;
25
- public static CLIP_HORIZONTAL;
26
- public static HORIZONTAL_GRAVITY_MASK;
27
- public static VERTICAL_GRAVITY_MASK;
28
- public static DISPLAY_CLIP_VERTICAL;
29
- public static DISPLAY_CLIP_HORIZONTAL;
7
+ public static NO_GRAVITY: number;
8
+ public static AXIS_PULL_BEFORE: number;
9
+ public static AXIS_SPECIFIED: number;
10
+ public static AXIS_PULL_AFTER: number;
11
+ public static AXIS_CLIP: number;
12
+ public static AXIS_X_SHIFT: number;
13
+ public static AXIS_Y_SHIFT: number;
14
+ public static TOP: number;
15
+ public static BOTTOM: number;
16
+ public static LEFT: number;
17
+ public static RIGHT: number;
18
+ public static CENTER_VERTICAL: number;
19
+ public static FILL_VERTICAL: number;
20
+ public static CENTER_HORIZONTAL: number;
21
+ public static FILL_HORIZONTAL: number;
22
+ public static CENTER: number;
23
+ public static FILL: number;
24
+ public static CLIP_VERTICAL: number;
25
+ public static CLIP_HORIZONTAL: number;
26
+ public static HORIZONTAL_GRAVITY_MASK: number;
27
+ public static VERTICAL_GRAVITY_MASK: number;
28
+ public static DISPLAY_CLIP_VERTICAL: number;
29
+ public static DISPLAY_CLIP_HORIZONTAL: number;
30
30
 
31
31
  public static convert(type: string, defaultValue?: number): number;
32
32
 
package/@types/Paint.d.ts CHANGED
@@ -13,122 +13,314 @@ import { ImageFilter } from "./ImageFilter";
13
13
  * 画笔,描述颜色、样式、字体等绘制属性。
14
14
  */
15
15
  export interface Paint {
16
+ /**
17
+ * 测量整段文本的绘制宽度。
18
+ */
16
19
  measureText(text: CharSequence): number;
20
+
21
+ /**
22
+ * 测量指定区间文本的绘制宽度。
23
+ */
17
24
  measureText(text: CharSequence, start: number, end: number): number;
18
25
 
26
+ /**
27
+ * 从另一支画笔复制全部属性,并返回自身。
28
+ */
19
29
  set(paint: Paint): Paint
20
30
 
31
+ /**
32
+ * 按像素对齐调整描边位置,使线条绘制更锐利。
33
+ */
21
34
  adjustForPixelPerfectLine(pixel: number): void;
22
35
 
36
+ /**
37
+ * 返回是否启用抗锯齿。
38
+ */
23
39
  isAntiAlias(): boolean;
24
40
 
41
+ /**
42
+ * 返回文本是否应用了水平倾斜。
43
+ */
25
44
  isTextSkewX(): boolean;
26
45
 
46
+ /**
47
+ * 返回像素对齐描边的调整值。
48
+ */
27
49
  getPixelPerfectLine(): number
28
50
 
51
+ /**
52
+ * 返回字体度量信息。
53
+ */
29
54
  getFontMetrics(): Paint.FontMetrics
55
+
56
+ /**
57
+ * 将字体度量写入指定对象,并返回行距。
58
+ */
30
59
  getFontMetrics(fontMetrics: Paint.FontMetrics): number
31
60
 
61
+ /**
62
+ * 获取整段文本中每个字符的宽度,返回测量的字符数。
63
+ */
32
64
  getTextWidths(text: CharSequence, widths: number[]): number
65
+
66
+ /**
67
+ * 获取指定区间文本中每个字符的宽度,返回测量的字符数。
68
+ */
33
69
  getTextWidths(text: CharSequence, start: number, end: number, widths: number[]): number
70
+
71
+ /**
72
+ * 从字符串数组指定位置起测量字符宽度,返回测量的字符数。
73
+ */
34
74
  getTextWidths(text: string[], index:number, count:number, widths: number[]): number
35
75
 
76
+ /**
77
+ * 将整段文本的包围盒写入指定矩形。
78
+ */
36
79
  getTextBounds(text: CharSequence, bounds: Rect): void
80
+
81
+ /**
82
+ * 将指定区间文本的包围盒写入指定矩形。
83
+ */
37
84
  getTextBounds(text: CharSequence, start: number, end: number, bounds: Rect): void
38
85
 
86
+ /**
87
+ * 在最大宽度内截断文本,返回实际测量的字符数。
88
+ */
39
89
  breakText(text: CharSequence, measureForwards: boolean, maxWidth: number, measuredWidth: number[]): number
90
+
91
+ /**
92
+ * 在最大宽度内截断指定区间文本,返回实际测量的字符数。
93
+ */
40
94
  breakText(text: CharSequence, start: number, end: number, measureForwards: boolean, maxWidth: number, measuredWidth: number[]): number
41
95
 
96
+ /**
97
+ * 返回填充/描边绘制样式。
98
+ */
42
99
  getStyle(): Paint.Style;
43
100
 
101
+ /**
102
+ * 复制当前画笔并返回新实例。
103
+ */
44
104
  copy(): Paint;
45
105
 
106
+ /**
107
+ * 返回图像滤镜。
108
+ */
46
109
  getImageFilter(): ImageFilter;
47
110
 
111
+ /**
112
+ * 返回画笔标志位。
113
+ */
48
114
  getFlags(): number
49
115
 
116
+ /**
117
+ * 返回透明度,取值范围为 0–255。
118
+ */
50
119
  getAlpha(): number
51
120
 
121
+ /**
122
+ * 返回当前颜色(ARGB 数值)。
123
+ */
52
124
  getColor(): number
53
125
 
126
+ /**
127
+ * 返回当前颜色的字符串表示。
128
+ */
54
129
  getColorString(): string
55
130
 
131
+ /**
132
+ * 返回描边转角连接样式。
133
+ */
56
134
  getStrokeJoin(): Paint.Join
57
135
 
136
+ /**
137
+ * 返回描边端点样式。
138
+ */
58
139
  getStrokeCap(): Paint.Cap
59
140
 
141
+ /**
142
+ * 返回阴影效果。
143
+ */
60
144
  getShadow(): Shadow
61
145
 
146
+ /**
147
+ * 返回文本字号。
148
+ */
62
149
  getTextSize(): number
63
150
 
151
+ /**
152
+ * 返回颜色滤镜。
153
+ */
64
154
  getColorFilter(): ColorFilter;
65
155
 
156
+ /**
157
+ * 返回文本水平对齐方式。
158
+ */
66
159
  getTextAlign(): Paint.Align
67
160
 
161
+ /**
162
+ * 返回着色器。
163
+ */
68
164
  getShader(): Shader;
69
165
 
166
+ /**
167
+ * 返回描边宽度。
168
+ */
70
169
  getStrokeWidth(): number
71
170
 
171
+ /**
172
+ * 返回文本水平倾斜值。
173
+ */
72
174
  getTextSkewX(): number;
73
175
 
176
+ /**
177
+ * 返回是否启用伪粗体。
178
+ */
74
179
  getFakeBoldText(): boolean;
75
180
 
181
+ /**
182
+ * 返回混合模式。
183
+ */
76
184
  getBlendMode(): BlendMode;
77
185
 
186
+ /**
187
+ * 返回当前字体。
188
+ */
78
189
  getTypeface(): Typeface;
79
190
 
191
+ /**
192
+ * 返回路径效果。
193
+ */
80
194
  getPathEffect(): PathEffect
81
195
 
196
+ /**
197
+ * 返回文本水平缩放比例。
198
+ */
82
199
  getTextScaleX(): number;
83
200
 
201
+ /**
202
+ * 设置描边宽度。
203
+ */
84
204
  setStrokeWidth(width: number): void
85
205
 
206
+ /**
207
+ * 设置路径效果。
208
+ */
86
209
  setPathEffect(pathEffect: PathEffect): void
87
210
 
211
+ /**
212
+ * 设置是否启用抗锯齿。
213
+ */
88
214
  setAntiAlias(aa: boolean): void;
89
215
 
216
+ /**
217
+ * 设置颜色(ARGB 数值)。
218
+ */
90
219
  setColor(color: number): void
91
220
 
221
+ /**
222
+ * 设置描边转角连接样式。
223
+ */
92
224
  setStrokeJoin(join: Paint.Join): void
93
225
 
226
+ /**
227
+ * 设置文本字号。
228
+ */
94
229
  setTextSize(textSize: number): void
95
230
 
231
+ /**
232
+ * 设置描边端点样式。
233
+ */
96
234
  setStrokeCap(cap: Paint.Cap): void
97
235
 
236
+ /**
237
+ * 返回推荐行距。
238
+ */
98
239
  getFontSpacing(): number;
99
240
 
241
+ /**
242
+ * 设置文本水平对齐方式。
243
+ */
100
244
  setTextAlign(textAlign: Paint.Align): void
101
245
 
246
+ /**
247
+ * 设置画笔标志位。
248
+ */
102
249
  setFlags(flags: number): void
103
250
 
251
+ /**
252
+ * 设置图像滤镜。
253
+ */
104
254
  setImageFilter(imageFilter: ImageFilter): void;
105
255
 
256
+ /**
257
+ * 设置填充/描边绘制样式。
258
+ */
106
259
  setStyle(style: Paint.Style): void
107
260
 
261
+ /**
262
+ * 设置透明度,取值范围为 0–255。
263
+ */
108
264
  setAlpha(a: number): void
109
265
 
266
+ /**
267
+ * 设置阴影效果。
268
+ */
110
269
  setShadow(shadow: Shadow): void
111
270
 
271
+ /**
272
+ * 设置着色器。
273
+ */
112
274
  setShader(shader: Shader): void
113
275
 
276
+ /**
277
+ * 设置颜色滤镜。
278
+ */
114
279
  setColorFilter(filter: ColorFilter): void;
115
280
 
281
+ /**
282
+ * 按 Alpha、红、绿、蓝分量设置颜色。
283
+ */
116
284
  setARGB(a: number, r: number, g: number, b: number): void
117
285
 
286
+ /**
287
+ * 设置字体。
288
+ */
118
289
  setTypeface(typeface: Typeface): void;
119
290
 
291
+ /**
292
+ * 设置文本水平缩放比例。
293
+ */
120
294
  setTextScaleX(scaleX: number): void;
121
295
 
296
+ /**
297
+ * 设置文本水平倾斜值。
298
+ */
122
299
  setTextSkewX(value: number): void;
123
300
 
301
+ /**
302
+ * 设置是否启用伪粗体。
303
+ */
124
304
  setFakeBoldText(value: boolean): void;
125
305
 
306
+ /**
307
+ * 设置混合模式。
308
+ */
126
309
  setBlendMode(mode: BlendMode): void;
127
310
 
311
+ /**
312
+ * 设置是否绘制删除线。
313
+ */
128
314
  setStrikeThruText(value: boolean): void;
129
315
 
316
+ /**
317
+ * 释放画笔占用的资源。
318
+ */
130
319
  dispose(): void;
131
320
 
321
+ /**
322
+ * 返回画笔属性的字符串描述。
323
+ */
132
324
  toString(): CharSequence;
133
325
  }
134
326
 
@@ -141,21 +333,58 @@ export abstract class Paint extends InterfaceTemplate {}
141
333
  * Paint 相关类型与工厂方法。
142
334
  */
143
335
  export namespace Paint {
336
+ /**
337
+ * 下划线文本标志位。
338
+ */
144
339
  export const UNDERLINE_TEXT_FLAG: number;
340
+
341
+ /**
342
+ * 删除线文本标志位。
343
+ */
145
344
  export const STRIKE_THRU_TEXT_FLAG: number;
146
345
 
147
346
  /**
148
347
  * 字体度量信息。
149
348
  */
150
349
  export class FontMetrics {
350
+ /**
351
+ * 基线以上的推荐上升距离(通常为负)。
352
+ */
151
353
  public ascent: number;
354
+
355
+ /**
356
+ * 基线以下的推荐下降距离(通常为正)。
357
+ */
152
358
  public descent: number;
359
+
360
+ /**
361
+ * 基线以上的最大上升距离(通常为负)。
362
+ */
153
363
  public top: number;
364
+
365
+ /**
366
+ * 基线以下的最大下降距离(通常为正)。
367
+ */
154
368
  public bottom: number;
369
+
370
+ /**
371
+ * 额外行距。
372
+ */
155
373
  public leading: number;
374
+
375
+ /**
376
+ * 字形相对绘制原点的最左边界。
377
+ */
156
378
  public left: number;
379
+
380
+ /**
381
+ * 字形相对绘制原点的最右边界。
382
+ */
157
383
  public right: number;
158
384
 
385
+ /**
386
+ * 从另一组度量复制全部字段,并返回自身。
387
+ */
159
388
  public set(metrics: FontMetrics): FontMetrics;
160
389
  }
161
390
 
@@ -163,8 +392,19 @@ export namespace Paint {
163
392
  * 描边转角连接样式。
164
393
  */
165
394
  export enum Join {
395
+ /**
396
+ * 斜角连接。
397
+ */
166
398
  BEVEL = "bevel",
399
+
400
+ /**
401
+ * 尖角连接。
402
+ */
167
403
  MITER = "miter",
404
+
405
+ /**
406
+ * 圆角连接。
407
+ */
168
408
  ROUND = "round",
169
409
  }
170
410
 
@@ -172,8 +412,19 @@ export namespace Paint {
172
412
  * 描边端点样式。
173
413
  */
174
414
  export enum Cap {
415
+ /**
416
+ * 平端,精确停在路径端点。
417
+ */
175
418
  BUTT = "butt",
419
+
420
+ /**
421
+ * 圆端,以端点为圆心向外延伸半个线宽。
422
+ */
176
423
  ROUND = "round",
424
+
425
+ /**
426
+ * 方端,向外延伸半个线宽的矩形。
427
+ */
177
428
  SQUARE = "square",
178
429
  }
179
430
 
@@ -181,8 +432,19 @@ export namespace Paint {
181
432
  * 填充与描边绘制样式。
182
433
  */
183
434
  export enum Style {
435
+ /**
436
+ * 仅填充内部。
437
+ */
184
438
  FILL,
439
+
440
+ /**
441
+ * 仅描边轮廓。
442
+ */
185
443
  STROKE,
444
+
445
+ /**
446
+ * 同时填充内部并描边轮廓。
447
+ */
186
448
  FILL_AND_STROKE,
187
449
  }
188
450
 
@@ -190,8 +452,19 @@ export namespace Paint {
190
452
  * 文本水平对齐方式。
191
453
  */
192
454
  export enum Align {
455
+ /**
456
+ * 左对齐。
457
+ */
193
458
  LEFT = 'left',
459
+
460
+ /**
461
+ * 居中对齐。
462
+ */
194
463
  CENTER = 'center',
464
+
465
+ /**
466
+ * 右对齐。
467
+ */
195
468
  RIGHT = 'right',
196
469
  }
197
470
 
package/@types/View.d.ts CHANGED
@@ -23,260 +23,638 @@ import { Resources } from "./Resources";
23
23
  import { ViewParent } from "./ViewParent";
24
24
  import { ViewOutlineProvider } from "./ViewOutlineProvider";
25
25
  import { DisplayMetrics } from "./DisplayMetrics";
26
- import { IWindow } from "./IWindow";
26
+ import { Window } from "./Window";
27
27
 
28
28
  /**
29
29
  * 基础视图,负责测量、布局、绘制与事件分发。
30
30
  */
31
31
  export declare class View implements Drawable.Callback {
32
+ /**
33
+ * 根据测量规格解析最终尺寸。
34
+ */
32
35
  public static resolveSize(size: number, measureSpec: number): number;
36
+ /**
37
+ * 从测量规格中提取测量模式。
38
+ */
33
39
  public static getMode(measureSpec: number): number;
40
+ /**
41
+ * 根据期望尺寸与测量规格计算默认尺寸。
42
+ */
34
43
  public static getDefaultSize(size: number, measureSpec: number): number;
35
44
 
45
+ /**
46
+ * 不可见但仍占用布局空间。
47
+ */
36
48
  public static INVISIBLE: number;
49
+ /**
50
+ * 不可见且不占用布局空间。
51
+ */
37
52
  public static GONE: number;
53
+ /**
54
+ * 可见。
55
+ */
38
56
  public static VISIBLE: number;
39
57
 
58
+ /**
59
+ * 使用运行时上下文构造视图。
60
+ */
40
61
  public constructor(context: Context);
62
+ /**
63
+ * 使用上下文与属性集合构造视图。
64
+ */
41
65
  public constructor(context: Context, attrs: AttributeSet);
42
66
 
67
+ /**
68
+ * 通知宿主指定 Drawable 需要重绘。
69
+ */
43
70
  public invalidateDrawable(who: Drawable): void;
44
71
 
72
+ /**
73
+ * 在指定时间调度 Drawable 的回调。
74
+ */
45
75
  public scheduleDrawable(who: Drawable, what: Runnable, when: number): void;
46
76
 
77
+ /**
78
+ * 取消已调度的 Drawable 回调。
79
+ */
47
80
  public unScheduleDrawable(who: Drawable, what: Runnable): void;
48
81
 
82
+ /**
83
+ * 返回视图是否可获取焦点。
84
+ */
49
85
  public isFocusable(): boolean;
50
86
 
87
+ /**
88
+ * 返回触摸模式下是否可获取焦点。
89
+ */
51
90
  public isFocusableInTouchMode(): boolean;
52
91
 
92
+ /**
93
+ * 返回视图当前是否拥有焦点。
94
+ */
53
95
  public isFocused(): boolean;
54
96
 
97
+ /**
98
+ * 标记视图需要重绘。
99
+ */
55
100
  public invalidate(): void;
56
101
 
102
+ /**
103
+ * 标记视图轮廓需要重新计算。
104
+ */
57
105
  public invalidateOutline(): void;
58
106
 
107
+ /**
108
+ * 根据宽高测量规格测量视图。
109
+ */
59
110
  public measure(widthMeasureSpec: number, heightMeasureSpec: number): void;
60
111
 
112
+ /**
113
+ * 将视图布局到指定边界。
114
+ */
61
115
  public layout(left: number, top: number, right: number, bottom: number): void;
62
116
 
117
+ /**
118
+ * 将视图绘制到指定画布。
119
+ */
63
120
  public draw(canvas: Canvas): void;
64
121
 
122
+ /**
123
+ * 按数字 ID 查找子视图。
124
+ */
65
125
  public findViewById(id: number): View;
126
+ /**
127
+ * 按字符串 ID 查找子视图。
128
+ */
66
129
  public findViewById(id: string): View;
67
130
 
131
+ /**
132
+ * 按标签查找第一个匹配的子视图。
133
+ */
68
134
  public findViewByTag(tag: string): View;
69
135
 
136
+ /**
137
+ * 按标签查找所有匹配的子视图。
138
+ */
70
139
  public findViewsByTag(tag: string): ArrayList<View>;
71
140
 
141
+ /**
142
+ * 将任务投递到视图消息队列,返回是否投递成功。
143
+ */
72
144
  public post(action:Runnable): boolean;
73
145
 
146
+ /**
147
+ * 移除尚未执行的投递任务,返回是否移除成功。
148
+ */
74
149
  public removeCallbacks(action: Runnable): boolean;
75
150
 
151
+ /**
152
+ * 返回视图或其子孙是否拥有焦点。
153
+ */
76
154
  public hasFocus(): boolean;
77
155
 
156
+ /**
157
+ * 请求父视图重新测量并布局。
158
+ */
78
159
  public requestLayout(): void;
79
160
 
161
+ /**
162
+ * 请求获取焦点,返回是否成功。
163
+ */
80
164
  public requestFocus(): boolean;
81
165
 
166
+ /**
167
+ * 清除当前焦点。
168
+ */
82
169
  public clearFocus(): void;
83
170
 
171
+ /**
172
+ * 添加附着/分离窗口状态变化监听器。
173
+ */
84
174
  public addOnAttachStateChangeListener(listener:View.OnAttachStateChangeListener): void;
85
175
 
176
+ /**
177
+ * 移除附着/分离窗口状态变化监听器。
178
+ */
86
179
  public removeOnAttachStateChangeListener(listener:View.OnAttachStateChangeListener): void;
87
180
 
181
+ /**
182
+ * 添加布局变化监听器。
183
+ */
88
184
  public addOnLayoutChangeListener(listener: View.OnLayoutChangeListener): void;
89
185
 
186
+ /**
187
+ * 移除布局变化监听器。
188
+ */
90
189
  public removeOnLayoutChangeListener(listener: View.OnLayoutChangeListener): void;
91
190
 
191
+ /**
192
+ * 滚动到指定绝对位置。
193
+ */
92
194
  public scrollTo(x: number, y: number): void;
93
195
 
196
+ /**
197
+ * 相对当前滚动位置偏移指定距离。
198
+ */
94
199
  public scrollBy(x: number, y: number): void;
95
200
 
201
+ /**
202
+ * 触发点击回调。
203
+ */
96
204
  public performClick(): void;
97
205
 
206
+ /**
207
+ * 启动视图动画。
208
+ */
98
209
  public startAnimation(animation:Animation) : void;
99
210
 
211
+ /**
212
+ * 测量回调,子类在此计算自身尺寸。
213
+ */
100
214
  public onMeasure(widthMeasureSpec: number, heightMeasureSpec: number): void;
101
215
 
216
+ /**
217
+ * 绘制回调,子类在此绘制自身内容。
218
+ */
102
219
  public onDraw(canvas: Canvas): void;
103
220
 
221
+ /**
222
+ * 布局回调,子类在此安排子视图位置。
223
+ */
104
224
  public onLayout(changed: boolean, left: number, top: number, right: number, bottom: number): void;
105
225
 
226
+ /**
227
+ * 设备或主题等配置变化时回调。
228
+ */
106
229
  public onConfigurationChanged(newConfig: Configuration): void;
107
230
 
231
+ /**
232
+ * 屏幕密度变化时回调。
233
+ */
108
234
  public onDensityMetricsChanged(newConfig: Configuration): void;
109
235
 
236
+ /**
237
+ * 返回视图透明度,取值范围为 0–1。
238
+ */
110
239
  public getAlpha(): number;
111
240
 
241
+ /**
242
+ * 返回视图宽度。
243
+ */
112
244
  public getWidth(): number;
113
245
 
246
+ /**
247
+ * 返回视图高度。
248
+ */
114
249
  public getHeight(): number;
115
250
 
251
+ /**
252
+ * 返回视图变换矩阵。
253
+ */
116
254
  public getMatrix(): Matrix;
117
255
 
256
+ /**
257
+ * 返回父视图。
258
+ */
118
259
  public getParent(): ViewParent;
119
260
 
261
+ /**
262
+ * 返回视图 ID。
263
+ */
120
264
  public getId(): number;
121
265
 
266
+ /**
267
+ * 返回变换枢轴点的 X 坐标。
268
+ */
122
269
  public getPivotX(): number;
123
270
 
271
+ /**
272
+ * 返回变换枢轴点的 Y 坐标。
273
+ */
124
274
  public getPivotY(): number;
125
275
 
276
+ /**
277
+ * 返回视图在父容器中的 X 坐标。
278
+ */
126
279
  public getX(): number;
127
280
 
281
+ /**
282
+ * 返回视图在父容器中的 Y 坐标。
283
+ */
128
284
  public getY(): number;
129
285
 
286
+ /**
287
+ * 返回当前显示度量。
288
+ */
130
289
  public getDisplayMetrics(): DisplayMetrics;
131
290
 
291
+ /**
292
+ * 返回水平滚动偏移。
293
+ */
132
294
  public getScrollX(): number;
133
295
 
296
+ /**
297
+ * 返回垂直滚动偏移。
298
+ */
134
299
  public getScrollY(): number;
135
300
 
301
+ /**
302
+ * 返回父视图。
303
+ */
136
304
  public getParent(): ViewParent;
137
305
 
306
+ /**
307
+ * 返回可见性,取值为 VISIBLE、INVISIBLE 或 GONE。
308
+ */
138
309
  public getVisibility(): number;
139
310
 
311
+ /**
312
+ * 返回布局参数。
313
+ */
140
314
  public getLayoutParams(): ViewGroup.LayoutParams;
141
315
 
316
+ /**
317
+ * 返回关联的运行时上下文。
318
+ */
142
319
  public getContext(): Context;
143
320
 
321
+ /**
322
+ * 返回背景 Drawable。
323
+ */
144
324
  public getBackground(): Drawable;
145
325
 
326
+ /**
327
+ * 返回绕枢轴点的旋转角度(度)。
328
+ */
146
329
  public getRotation(): number;
147
330
 
331
+ /**
332
+ * 返回水平平移量。
333
+ */
148
334
  public getTranslationX(): number;
149
335
 
336
+ /**
337
+ * 返回垂直平移量。
338
+ */
150
339
  public getTranslationY(): number;
151
340
 
341
+ /**
342
+ * 返回水平缩放比例。
343
+ */
152
344
  public getScaleX(): number;
153
345
 
346
+ /**
347
+ * 返回垂直缩放比例。
348
+ */
154
349
  public getScaleY(): number;
155
350
 
351
+ /**
352
+ * 返回建议的最小宽度。
353
+ */
156
354
  public getMinimumWidth(): number;
157
355
 
356
+ /**
357
+ * 返回建议的最小高度。
358
+ */
158
359
  public getMinimumHeight(): number;
159
360
 
361
+ /**
362
+ * 返回视图标签。
363
+ */
160
364
  public getTag(): string;
161
365
 
366
+ /**
367
+ * 返回视图叠加层。
368
+ */
162
369
  public getOverlay(): ViewOverlay;
163
370
 
371
+ /**
372
+ * 返回视图树观察者。
373
+ */
164
374
  public getViewTreeObserver(): ViewTreeObserver;
165
375
 
376
+ /**
377
+ * 返回轮廓提供者。
378
+ */
166
379
  public getOutlineProvider(): ViewOutlineProvider;
167
380
 
381
+ /**
382
+ * 将视图在屏幕上的位置写入长度为 2 的数组。
383
+ */
168
384
  public getLocationOnScreen(location: number[]): void;
169
385
 
386
+ /**
387
+ * 返回上内边距。
388
+ */
170
389
  public getPaddingTop(): number;
171
390
 
391
+ /**
392
+ * 返回下内边距。
393
+ */
172
394
  public getPaddingBottom(): number;
173
395
 
396
+ /**
397
+ * 返回附着窗口时的临时绘制与变换信息。
398
+ */
174
399
  public getAttachInfo(): View.AttachInfo;
175
400
 
401
+ /**
402
+ * 返回左内边距。
403
+ */
176
404
  public getPaddingLeft(): number;
177
405
 
406
+ /**
407
+ * 返回右内边距。
408
+ */
178
409
  public getPaddingRight(): number;
179
410
 
411
+ /**
412
+ * 返回关联的资源管理器。
413
+ */
180
414
  public getResources(): Resources;
181
415
 
416
+ /**
417
+ * 返回未经缩放换算的左内边距。
418
+ */
182
419
  public getRawPaddingLeft(): number;
183
420
 
421
+ /**
422
+ * 返回未经缩放换算的上内边距。
423
+ */
184
424
  public getRawPaddingTop(): number;
185
425
 
426
+ /**
427
+ * 返回未经缩放换算的右内边距。
428
+ */
186
429
  public getRawPaddingRight(): number;
187
430
 
431
+ /**
432
+ * 返回未经缩放换算的下内边距。
433
+ */
188
434
  public getRawPaddingBottom(): number;
189
435
 
436
+ /**
437
+ * 设置前景 Drawable。
438
+ */
190
439
  public setForeground(foreground: Drawable): void;
191
440
 
441
+ /**
442
+ * 设置是否处于悬停状态。
443
+ */
192
444
  public setHovered(hovered: boolean): void;
193
445
 
446
+ /**
447
+ * 设置变换枢轴点的 X 坐标。
448
+ */
194
449
  public setPivotX(x: number): void;
195
450
 
451
+ /**
452
+ * 设置变换枢轴点的 Y 坐标。
453
+ */
196
454
  public setPivotY(y: number): void;
197
455
 
456
+ /**
457
+ * 设置水平缩放比例。
458
+ */
198
459
  public setScaleX(x: number): number;
199
460
 
461
+ /**
462
+ * 设置垂直缩放比例。
463
+ */
200
464
  public setScaleY(y: number): number;
201
465
 
466
+ /**
467
+ * 设置是否启用绘制缓存。
468
+ */
202
469
  public setDrawingCacheEnabled(enabled: boolean): void;
203
470
 
471
+ /**
472
+ * 设置纯色背景。
473
+ */
204
474
  public setBackgroundColor(color: number): void;
205
475
 
476
+ /**
477
+ * 设置背景 Drawable。
478
+ */
206
479
  public setBackgroundDrawable(drawable: Drawable): void;
207
480
 
481
+ /**
482
+ * 设置视图是否跳过自身绘制。
483
+ */
208
484
  public setWillNotDraw(willNotDraw: boolean) :void;
209
485
 
486
+ /**
487
+ * 设置测量后的宽高,通常在 onMeasure 中调用。
488
+ */
210
489
  public setMeasuredDimension(measuredWidth: number, measuredHeight: number): void;
211
490
 
491
+ /**
492
+ * 设置建议的最小宽度。
493
+ */
212
494
  public setMinimumWidth(minWidth: number): void;
213
495
 
496
+ /**
497
+ * 设置建议的最小高度。
498
+ */
214
499
  public setMinimumHeight(minHeight: number): void;
215
500
 
501
+ /**
502
+ * 设置视图透明度,取值范围为 0–1。
503
+ */
216
504
  public setAlpha(alpha: number): void;
217
505
 
506
+ /**
507
+ * 设置可见性,取值为 VISIBLE、INVISIBLE 或 GONE。
508
+ */
218
509
  public setVisibility(visibility: number): void;
219
510
 
511
+ /**
512
+ * 设置视图标签。
513
+ */
220
514
  public setTag(tag: string): void;
221
515
 
516
+ /**
517
+ * 设置轮廓提供者。
518
+ */
222
519
  public setOutlineProvider(provider: ViewOutlineProvider): void;
223
520
 
521
+ /**
522
+ * 设置视图是否可获取焦点。
523
+ */
224
524
  public setFocusable(focusable: boolean): void;
225
525
 
526
+ /**
527
+ * 设置触摸模式下是否可获取焦点。
528
+ */
226
529
  public setFocusableInTouchMode(focusableInTouchMode: boolean): void;
227
530
 
531
+ /**
532
+ * 设置点击事件监听器。
533
+ */
228
534
  public setOnClickListener(l: View.OnClickListener): void;
229
535
 
536
+ /**
537
+ * 设置 inflate 完成回调监听器。
538
+ */
230
539
  public setOnFinishInflateListener(l: View.OnFinishInflateListener): void;
231
540
 
541
+ /**
542
+ * 设置按键事件监听器。
543
+ */
232
544
  public setOnKeyListener(l: View.OnKeyListener): void;
233
545
 
546
+ /**
547
+ * 设置触摸事件监听器。
548
+ */
234
549
  public setOnTouchListener(l: View.OnTouchListener): void;
235
550
 
551
+ /**
552
+ * 设置视图是否可点击。
553
+ */
236
554
  public setClickable(clickable: boolean): void;
237
555
 
556
+ /**
557
+ * 设置通用运动事件监听器。
558
+ */
238
559
  public setOnGenericMotionListener(l: View.OnGenericMotionListener): void;
239
560
 
561
+ /**
562
+ * 设置四周内边距。
563
+ */
240
564
  public setPadding(left: number, top: number, right: number, bottom: number): void;
241
565
 
566
+ /**
567
+ * 设置布局参数。
568
+ */
242
569
  public setLayoutParams(params: ViewGroup.LayoutParams): void;
243
570
 
571
+ /**
572
+ * 设置绕枢轴点的旋转角度(度)。
573
+ */
244
574
  public setRotation(rotation: number): void;
245
575
 
576
+ /**
577
+ * 设置是否按轮廓裁剪绘制内容。
578
+ */
246
579
  public setClipToOutline(clipToOutline: boolean): void;
247
580
 
581
+ /**
582
+ * 设置水平平移量。
583
+ */
248
584
  public setTranslationX(translationX: number): void;
249
585
 
586
+ /**
587
+ * 设置垂直平移量。
588
+ */
250
589
  public setTranslationY(translationY: number): void;
251
590
 
591
+ /**
592
+ * 设置悬停事件监听器。
593
+ */
252
594
  public setOnHoverListener(l: View.OnHoverListener): void;
253
595
 
596
+ /**
597
+ * 设置悬停时的鼠标光标样式。
598
+ */
254
599
  public setHoverCursor(cursor: string): void;
255
600
 
601
+ /**
602
+ * 设置悬停时显示的 Drawable。
603
+ */
256
604
  public setHoverDrawable(drawable: Drawable): void;
257
605
 
606
+ /**
607
+ * 设置焦点变化监听器。
608
+ */
258
609
  public setOnFocusChangeListener(l: View.OnFocusChangeListener): void;
259
610
  }
260
611
 
612
+ /**
613
+ * View 相关嵌套类型。
614
+ */
261
615
  export declare namespace View {
262
616
  /**
263
617
  * 按圆角半径生成视图轮廓的 OutlineProvider。
264
618
  */
265
619
  export class ViewRadiusOutlineProvider extends ViewOutlineProvider {
620
+ /**
621
+ * 使用视图及四个圆角半径构造轮廓提供者。
622
+ */
266
623
  public constructor(view: View, ltr: number, lbr: number, rtr: number, rbr: number);
267
624
 
625
+ /**
626
+ * 设备或主题等配置变化时回调。
627
+ */
268
628
  public onConfigurationChanged(newConfig: Configuration): void;
269
629
 
630
+ /**
631
+ * 将视图外形轮廓写入指定 Outline。
632
+ */
270
633
  public getOutline(view: View, outline: Outline): void;
271
634
 
635
+ /**
636
+ * 同时设置四个圆角半径。
637
+ */
272
638
  public setRadius(value: number): void;
273
639
 
640
+ /**
641
+ * 设置左下圆角半径。
642
+ */
274
643
  public setLeftBottomRadius(value: number): void;
275
644
 
645
+ /**
646
+ * 设置左上圆角半径。
647
+ */
276
648
  public setLeftTopRadius(value: number): void;
277
649
 
650
+ /**
651
+ * 设置右下圆角半径。
652
+ */
278
653
  public setRightBottomRadius(value: number): void;
279
654
 
655
+ /**
656
+ * 设置右上圆角半径。
657
+ */
280
658
  public setRightTopRadius(value: number): void;
281
659
  }
282
660
 
@@ -284,20 +662,44 @@ export declare namespace View {
284
662
  * 视图附着窗口时的临时绘制与变换信息。
285
663
  */
286
664
  export class AttachInfo {
665
+ /**
666
+ * 返回透明区域定位用的临时坐标数组。
667
+ */
287
668
  public getTransparentLocation(): Array<number>;
288
669
 
670
+ /**
671
+ * 返回临时变换矩阵。
672
+ */
289
673
  public getTmpMatrix(): Matrix;
290
674
 
675
+ /**
676
+ * 返回子视图失效定位用的临时坐标数组。
677
+ */
291
678
  public getInvalidateChildLocation(): Array<number>;
292
679
 
293
- public getWindow(): IWindow;
680
+ /**
681
+ * 返回所属窗口。
682
+ */
683
+ public getWindow(): Window;
294
684
 
685
+ /**
686
+ * 返回临时轮廓对象。
687
+ */
295
688
  public getTmpOutline(): Outline;
296
689
 
690
+ /**
691
+ * 返回变换定位用的临时坐标数组。
692
+ */
297
693
  public getTmpTransformLocation(): Array<number>;
298
694
 
695
+ /**
696
+ * 返回变换计算用的临时矩形。
697
+ */
299
698
  public getTmpTransformRect(): Rect;
300
699
 
700
+ /**
701
+ * 返回当前变换信息。
702
+ */
301
703
  public getTransformation(): Transformation;
302
704
  }
303
705
 
@@ -305,20 +707,50 @@ export declare namespace View {
305
707
  * 测量规格工具,编码尺寸与测量模式。
306
708
  */
307
709
  export class MeasureSpec {
710
+ /**
711
+ * 测量模式在规格值中的位移位数。
712
+ */
308
713
  public static MODE_SHIFT: number;
714
+ /**
715
+ * 测量模式掩码。
716
+ */
309
717
  public static MODE_MASK: number;
718
+ /**
719
+ * 未指定模式,父视图未施加约束。
720
+ */
310
721
  public static UNSPECIFIED: number;
722
+ /**
723
+ * 精确模式,子视图必须等于给定尺寸。
724
+ */
311
725
  public static EXACTLY: number;
726
+ /**
727
+ * 至多模式,子视图不得超过给定尺寸。
728
+ */
312
729
  public static AT_MOST: number;
313
730
 
731
+ /**
732
+ * 将尺寸与测量模式编码为测量规格。
733
+ */
314
734
  public static makeMeasureSpec(size: number, mode: number): number;
315
735
 
736
+ /**
737
+ * 创建安全的测量规格,避免溢出。
738
+ */
316
739
  public static makeSafeMeasureSpec(size: number, mode: number): number;
317
740
 
741
+ /**
742
+ * 从测量规格中提取测量模式。
743
+ */
318
744
  public static getMode(measureSpec: number): number;
319
745
 
746
+ /**
747
+ * 从测量规格中提取尺寸。
748
+ */
320
749
  public static getSize(measureSpec: number): number;
321
750
 
751
+ /**
752
+ * 按增量调整测量规格中的尺寸。
753
+ */
322
754
  public static adjust(measureSpec: number, delta: number): number;
323
755
  }
324
756
 
@@ -326,8 +758,14 @@ export declare namespace View {
326
758
  * 视图附着/分离窗口状态变化监听器。
327
759
  */
328
760
  export interface OnAttachStateChangeListener {
761
+ /**
762
+ * 视图附着到窗口时回调。
763
+ */
329
764
  onViewAttachedToWindow(v: View): void;
330
765
 
766
+ /**
767
+ * 视图从窗口分离时回调。
768
+ */
331
769
  onViewDetachedFromWindow(v: View): void;
332
770
  }
333
771
  /**
@@ -339,6 +777,9 @@ export declare namespace View {
339
777
  * 触摸事件监听器。
340
778
  */
341
779
  export interface OnTouchListener {
780
+ /**
781
+ * 处理触摸事件,返回是否已消费。
782
+ */
342
783
  onTouch(v: View, event: MotionEvent): boolean;
343
784
  }
344
785
  /**
@@ -350,6 +791,9 @@ export declare namespace View {
350
791
  * 点击事件监听器。
351
792
  */
352
793
  export interface OnClickListener {
794
+ /**
795
+ * 视图被点击时回调。
796
+ */
353
797
  onClick(v: View): void;
354
798
  }
355
799
  /**
@@ -361,6 +805,9 @@ export declare namespace View {
361
805
  * 悬停事件监听器。
362
806
  */
363
807
  export interface OnHoverListener {
808
+ /**
809
+ * 处理悬停事件,返回是否已消费。
810
+ */
364
811
  onHover(v: View, event: MotionEvent): boolean;
365
812
  }
366
813
  /**
@@ -372,6 +819,9 @@ export declare namespace View {
372
819
  * 按键事件监听器。
373
820
  */
374
821
  export interface OnKeyListener {
822
+ /**
823
+ * 处理按键事件,返回是否已消费。
824
+ */
375
825
  onKey(v: View, keyCode: number, event: KeyEvent): boolean;
376
826
  }
377
827
  /**
@@ -383,6 +833,9 @@ export declare namespace View {
383
833
  * 焦点变化监听器。
384
834
  */
385
835
  export interface OnFocusChangeListener {
836
+ /**
837
+ * 焦点变化时回调。
838
+ */
386
839
  onFocusChange(v: View, hasFocus: boolean): void;
387
840
  }
388
841
  /**
@@ -394,6 +847,9 @@ export declare namespace View {
394
847
  * 通用运动事件监听器。
395
848
  */
396
849
  export interface OnGenericMotionListener {
850
+ /**
851
+ * 处理通用运动事件,返回是否已消费。
852
+ */
397
853
  onGenericMotion(v: View, event: MotionEvent): boolean;
398
854
  }
399
855
  /**
@@ -405,6 +861,9 @@ export declare namespace View {
405
861
  * 布局尺寸或位置变化监听器。
406
862
  */
407
863
  export interface OnLayoutChangeListener {
864
+ /**
865
+ * 布局边界变化时回调,参数为新旧左、上、右、下坐标。
866
+ */
408
867
  onLayoutChange(v: View, left: number, top: number, right: number, bottom: number, oldLeft: number, oldTop: number, oldRight: number, oldBottom: number):void;
409
868
  }
410
869
  /**
@@ -416,6 +875,9 @@ export declare namespace View {
416
875
  * 视图完成 inflate 后的回调监听器。
417
876
  */
418
877
  export interface OnFinishInflateListener {
878
+ /**
879
+ * 视图 inflate 完成时回调。
880
+ */
419
881
  onViewFinishInflate(v: View): void;
420
882
  }
421
883
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compass-framework/core",
3
- "version": "1.2.59",
3
+ "version": "1.2.60",
4
4
  "description": "@compass-framework/core public api",
5
5
  "types": "./index.d.ts",
6
6
  "main": "./index.js",