@compass-framework/core 1.2.56 → 1.2.57

package/@types/LayerDrawable.d.ts

@@ -2,11 +2,15 @@ import { Implements, Runnable } from "@compass-framework/library";
 import { Drawable } from "./Drawable";
 import { Canvas } from "./Canvas";
 import { Resources } from "./Resources";
+import { Context } from "./Context";
 
+/**
+ * 图层 Drawable，按顺序叠加绘制多个子 Drawable。
+ */
 @Implements(Drawable.Callback)
 export declare class LayerDrawable extends Drawable implements Drawable.Callback {
-  public constructor();
-  public constructor(layers: Drawable[]);
+  public constructor(context: Context);
+  public constructor(context: Context, layers: Drawable[]);
 
   public addLayer(layer: Drawable): void;
 

package/@types/LayoutAnimationController.d.ts

@@ -3,6 +3,9 @@ import { Context } from "./Context";
 import { View } from "./View";
 import { Interpolator } from "./Interpolator";
 
+/**
+ * 布局动画控制器，使子视图按序播放动画。
+ */
 export declare class LayoutAnimationController {
   public static ORDER_NORMAL: number;
   public static ORDER_REVERSE: number;
@@ -43,7 +46,13 @@ export declare class LayoutAnimationController {
   public getTransformedIndex(params: LayoutAnimationController.AnimationParameters): number;
 }
 
+/**
+ * 布局动画控制器相关类型。
+ */
 export declare namespace LayoutAnimationController {
+  /**
+   * 布局动画参数。
+   */
   export class AnimationParameters {
     public count: number;
     public index: number;

package/@types/LayoutInflater.ts

@@ -3,6 +3,9 @@ import { Context } from "./Context";
 import { View } from "./View";
 import { ViewGroup } from "./ViewGroup";
 
+/**
+ * 布局填充器，将 XML 布局膨胀为视图树。
+ */
 export declare class LayoutInflater {
   public static from(context: Context, record?: Record<string, any>): LayoutInflater;
 

package/@types/LinearGradient.d.ts

@@ -1,5 +1,25 @@
+import { InterfaceTemplate } from "@compass-framework/library";
 import { Shader } from "./Shader";
+import { Context } from "./Context";
 
-export declare class LinearGradient extends Shader {
-  public constructor(x0: number, y0: number, x1: number, y1: number, colors: number[], positions: number[]);
+/**
+ * 线性渐变着色器。
+ */
+export interface LinearGradient extends Shader {
+
+}
+
+/**
+ * LinearGradient 接口的实现基类。
+ */
+export abstract class LinearGradient extends InterfaceTemplate {}
+
+/**
+ * LinearGradient 工厂方法。
+ */
+export namespace LinearGradient {
+  /**
+   * 创建线性渐变着色器。
+   */
+  export function create(context: Context, x0: number, y0: number, x1: number, y1: number, colors: number[], positions: number[]): LinearGradient;
 }

package/@types/LinearGradientDrawable.d.ts

@@ -1,5 +1,8 @@
 import { Canvas } from "./Canvas";
 
+/**
+ * 线性渐变 Drawable，按角度或方向填充渐变色。
+ */
 export declare class LinearGradientDrawable {
   public static MakeAngle(deg: number, colors: number[]): LinearGradientDrawable;
   public static MakeAngle(deg: number, colors: number[], radius: number): LinearGradientDrawable;

package/@types/LinearInterpolator.d.ts

@@ -1,6 +1,9 @@
 import { Implements } from "@compass-framework/library";
 import { Interpolator } from "./Interpolator";
 
+/**
+ * 线性插值器。
+ */
 @Implements(Interpolator)
 export declare class LinearInterpolator implements Interpolator {
   public getInterpolation(input: number): number;

package/@types/LinearLayout.d.ts

@@ -1,5 +1,8 @@
 import { ViewGroup } from "./ViewGroup";
 
+/**
+ * 线性布局，按水平或垂直方向依次排列子视图。
+ */
 export declare class LinearLayout extends ViewGroup {
   public static HORIZONTAL: number;
   public static VERTICAL: number;
@@ -10,5 +13,8 @@ export declare class LinearLayout extends ViewGroup {
 }
 
 export declare namespace LinearLayout {
+  /**
+   * LinearLayout 的布局参数。
+   */
   export class LayoutParams extends ViewGroup.MarginLayoutParams {}
 }

package/@types/ListAdapter.d.ts

@@ -1,10 +1,16 @@
 import { Implements, InterfaceTemplate } from "@compass-framework/library";
 import { Adapter } from "./Adapter";
 
+/**
+ * 列表适配器接口，扩展 Adapter 供 ListView/GridView 使用。
+ */
 export declare interface ListAdapter extends Adapter {
 
 }
 
+/**
+ * ListAdapter 的接口模板实现。
+ */
 @Implements(Adapter)
 export class ListAdapter extends InterfaceTemplate {
 

package/@types/ListView.d.ts

@@ -1,6 +1,9 @@
 import { ListAdapter } from "./ListAdapter";
 import { ViewGroup } from "./ViewGroup";
 
+/**
+ * 列表视图，通过适配器展示可滚动的条目列表。
+ */
 export declare class ListView extends ViewGroup {
   public setAdapter(adapter: ListAdapter): void;
 

package/@types/Matrix.d.ts

@@ -1,81 +1,138 @@
+import { InterfaceTemplate } from "@compass-framework/library";
 import { Rect } from "./Rect";
+import { Context } from "./Context";
 
-export declare class Matrix {
-  public static MSCALE_X: number;
-  public static MSKEW_X: number;
-  public static MTRANS_X: number;
-  public static MSKEW_Y: number;
-  public static MSCALE_Y: number;
-  public static MTRANS_Y: number;
-  public static MPERSP_0: number;
-  public static MPERSP_1: number;
-  public static MPERSP_2: number;
+/**
+ * 二维变换矩阵，用于平移、缩放、旋转等几何变换。
+ */
+export interface Matrix {
+  setTranslate(dx: number, dy: number): void
 
-  public constructor();
-  public constructor(src: Matrix);
+  mapPoints(pts: number[][]): void;
+  mapPoints(dst: number[][], src: number[][]): void;
+  mapPoints(dst: number[][], dstIndex: number, src: number[][], srcIndex: number, pointCount: number): void;
 
-  public set(src: Matrix): void;
-  public set(index: number, value: number): void;
+  mapVectors(vecs: number[][]): void;
+  mapVectors(vecs: number[][], count: number): void;
+  mapVectors(dst: number[][], src: number[][]): void;
+  mapVectors(dst: number[][], dstIndex: number, src: number[][], srcIndex: number, vectorCount: number): void;
 
-  public reset(): void;
+  setScale(sx: number, sy: number): void;
+  setScale(sx: number, sy: number, px: number, py: number): void;
 
-  public setTranslate(dx: number, dy: number): void;
+  setRotate(degrees: number): void;
+  setRotate(degrees: number, px: number, py: number): void;
 
-  public setScale(sx: number, sy: number, px: number, py: number): void;
-  public setScale(sx: number, sy: number): void;
+  setSinCos(sinValue: number, cosValue: number): void;
+  setSinCos(sinValue: number, cosValue: number, px: number, py: number): void;
 
-  public setRotate(degrees: number, px: number, py: number): void;
-  public setRotate(degrees: number): void;
+  setSkew(kx: number, ky: number): void;
+  setSkew(kx: number, ky: number, px: number, py: number): void;
 
-  public setSinCos(sinValue: number, cosValue: number, px: number, py: number): void;
-  public setSinCos(sinValue: number, cosValue: number): void;
+  setConcat(a: Matrix, b: Matrix): void
 
-  public setSkew(kx: number, ky: number, px: number, py: number): void;
-  public setSkew(kx: number, ky: number): void;
+  preTranslate(dx: number, dy: number): void
 
-  public setConcat(a: Matrix, b: Matrix): void;
+  preScale(sx: number, sy: number): void;
+  preScale(sx: number, sy: number, px: number, py: number): void;
 
-  public preTranslate(dx: number, dy: number): void;
+  preRotate(degrees: number): void;
+  preRotate(degrees: number, px: number, py: number): void;
 
-  public preScale(sx: number, sy: number, px: number, py: number): void;
-  public preScale(sx: number, sy: number): void;
+  preSkew(kx: number, ky: number): void;
+  preSkew(kx: number, ky: number, px: number, py: number): void;
 
-  public preRotate(degrees: number, px: number, py: number): void;
-  public preRotate(degrees: number): void;
+  preConcat(other: Matrix): number
 
-  public preSkew(kx: number, ky: number, px: number, py: number): void;
-  public preSkew(kx: number, ky: number): void;
+  postTranslate(dx: number, dy: number): void
 
-  public preConcat(other: Matrix): void;
+  postScale(sx: number, sy: number): void;
+  postScale(sx: number, sy: number, px: number, py: number): void;
 
-  public postTranslate(dx: number, dy: number): void;
+  postRotate(degrees: number): void;
+  postRotate(degrees: number, px: number, py: number): void;
 
-  public postScale(sx: number, sy: number, px: number, py: number): void;
-  public postScale(sx: number, sy: number): void;
+  rectStaysRect(): boolean
 
-  public postRotate(degrees: number, px: number, py: number): void;
-  public postRotate(degrees: number): void;
+  hasPerspective(): boolean
 
-  public postSkew(kx: number, ky: number, px: number, py: number): void;
-  public postSkew(kx: number, ky: number): void;
+  isIdentity(): boolean
 
-  public postConcat(other: Matrix): void;
+  set(src: Matrix): void;
+  set(index: number, value: number): void;
 
-  public mapRect(rect: Rect): void;
-  public mapRect(dst: Rect, src: Rect): void;
+  reset(): void
 
-  public getValues(accept: number[]): number[];
-  public getValues(accept: number[], index: number): number[];
-  public getValues(accept: number[], index: number, count: number): number[];
+  postSkew(kx: number, ky: number): void;
+  postSkew(kx: number, ky: number, px: number, py: number): void;
 
-  public setValues(values: number[]): void;
+  mapXY(x: number, y: number, point: number[]): void;
+
+  postConcat(other: Matrix): number
+
+  invert(inverse: Matrix): void
+
+  mapRect(rect: Rect): void;
+  mapRect(dst: Rect, src: Rect): void;
+
+  mapRadius(radius: number): number
+
+  getValues(accept: number[]): number[];
+  getValues(accept: number[], index: number): number[];
+  getValues(accept: number[], index: number, count: number): number[];
+
+  setValues(values: number[]): void
+
+  setRectToRect(src: Rect, dst: Rect, stf: Matrix.ScaleToFit): boolean
+
+  setPolyToPoly(src: number[][], srcIndex: number, dst: number[][], dstIndex: number, pointCount: number): boolean
+
+  dispose(): void
+
+  equals(target: Matrix): boolean
 }
 
-export declare namespace Matrix {
-  enum ScaleToFit {
-    FILL = 0,
-    START = 1,
-    CENTER = 2,
-    END = 3,
+/**
+ * Matrix 接口的实现基类。
+ */
+export abstract class Matrix extends InterfaceTemplate {}
+
+/**
+ * Matrix 相关常量、类型与工厂方法。
+ */
+export namespace Matrix {
+  export const MSCALE_X: number;
+  export const MSKEW_X: number;
+  export const MTRANS_X: number;
+  export const MSKEW_Y: number;
+  export const MSCALE_Y: number;
+  export const MTRANS_Y: number;
+  export const MPERSP_0: number;
+  export const MPERSP_1: number;
+  export const MPERSP_2: number;
+
+  export const CHANGE_MSCALE_X: number;
+  export const CHANGE_MSKEW_X: number;
+  export const CHANGE_MTRANS_X: number;
+  export const CHANGE_MSKEW_Y: number;
+  export const CHANGE_MSCALE_Y: number;
+  export const CHANGE_MTRANS_Y: number;
+  export const CHANGE_MPERSP_0: number;
+  export const CHANGE_MPERSP_1: number;
+  export const CHANGE_MPERSP_2: number;
+
+  /**
+   * 矩形到矩形的缩放适配方式。
+   */
+  export enum ScaleToFit {
+    FILL,
+    START,
+    CENTER,
+    END,
   }
+
+  /**
+   * 创建 Matrix 实例。
+   */
+  export function create(context: Context): Matrix;
 }

package/@types/MotionEvent.d.ts

@@ -1,3 +1,6 @@
+/**
+ * 触摸/指针运动事件及动作常量。
+ */
 export declare class MotionEvent {
   public static ACTION_DOWN: number;
   public static ACTION_MOVE: number;
@@ -51,7 +54,13 @@ export declare class MotionEvent {
   public getPointerCoords(pointerIndex: number, outPointerCoords: MotionEvent.PointerCoords): void;
 }
 
+/**
+ * MotionEvent 相关类型定义。
+ */
 export declare namespace MotionEvent {
+  /**
+   * 指针坐标信息。
+   */
   export class PointerCoords {
     public x: number;
     public y: number;

package/@types/{ICursor.d.ts → MouseCursor.ts}

@@ -1,17 +1,28 @@
 import { View } from "./View";
 
-export declare interface ICursor {
-  reset(): void
+/**
+ * 鼠标光标控制，支持锁定、悬停与重置。
+ */
+export declare interface MouseCursor {
+  lock(view: View, type: MouseCursor.MODE): void;
+
+  unlock(view: View): void;
 
-  lock(view: View, type: ICursor.Type): void;
+  reset(): void
 
-  unlock(view: View): void
+  hover(view: View, event: number, type?: MouseCursor.MODE): void;
 
-  hover(view: View, event: number, type: ICursor.Type): void;
+  isLock(): boolean;
 }
 
-export declare namespace ICursor {
-  export enum Type {
+/**
+ * MouseCursor 相关类型定义。
+ */
+export declare namespace MouseCursor {
+  /**
+   * 鼠标光标样式枚举。
+   */
+  export enum MODE {
     DEFAULT = 'default',
     AUTO = 'auto',
     HAND = 'hand',

package/@types/Outline.d.ts

@@ -1,8 +1,12 @@
 import { Rect } from "./Rect";
+import { Context } from "./Context";
 
+/**
+ * 轮廓，用于描述视图或 Drawable 的外形边界。
+ */
 export declare class Outline {
-  public constructor();
-  public constructor(src: Outline);
+  public constructor(context: Context);
+  public constructor(context: Context, src: Outline);
 
   public setRect(rect:Rect): void;
   public setRect(left:number, top:number, right:number, bottom:number): void;