@compass-framework/core 1.2.56 → 1.2.57

package/@types/Rect.d.ts

@@ -1,75 +1,98 @@
-export declare class Rect {
-  public static MAX: Rect;
+import { InterfaceTemplate } from "@compass-framework/library";
+import { Context } from "./Context";
 
-  public static intersects(a: Rect, b: Rect): boolean;
+/**
+ * 矩形区域，表示轴对齐的边界框。
+ */
+export interface Rect {
+  equals(rect: Rect): boolean
 
-  public constructor();
-  public constructor(rect: Rect);
-  public constructor(width: number, height: number);
-  public constructor(left: number, top: number, right: number, bottom: number);
+  isEmpty(): boolean
 
-  public equals(rect: Rect): boolean;
+  width(): number
 
-  public isEmpty() : boolean;
+  height(): number
 
-  public width(): number;
+  centerX(): number
 
-  public height(): number;
+  centerY(): number
 
-  public centerX(): number;
+  setEmpty(): void
 
-  public centerY(): number;
+  exactCenterX(): number
 
-  public setEmpty(): void;
+  exactCenterY(): number
 
-  public exactCenterX(): number;
+  set(rect: Rect):void;
+  set(left: number, top: number, right: number, bottom: number):void;
 
-  public exactCenterY(): number;
+  offset(dx: number, dy: number): void
 
-  public set(rect: Rect):void;
-  public set(left: number, top: number, right: number, bottom: number):void;
+  offsetTo(newLeft: number, newTop: number): void
 
-  public offset(dx: number, dy: number): void;
+  inset(dx: number, dy: number): void
 
-  public offsetTo(newLeft: number, newTop: number): void;
+  contains(rect: Rect): boolean;
+  contains(x: number, y: number): boolean;
+  contains(left: number, top: number, right: number, bottom: number): boolean;
 
-  public inset(dx: number, dy: number): void;
+  intersect(rect: Rect): boolean;
+  intersect(left: number, top: number, right: number, bottom: number): boolean;
 
-  public contains(rect: Rect): boolean;
-  public contains(x: number, y: number): boolean;
-  public contains(left: number, top: number, right: number, bottom: number): boolean;
+  setIntersect(a: Rect, b: Rect): boolean
 
-  public intersect(rect: Rect): boolean;
-  public intersect(left: number, top: number, right: number, bottom: number): boolean;
+  intersects(rect: Rect): boolean;
+  intersects(left: number, top: number, right: number, bottom: number): boolean;
 
-  public setIntersect(a: Rect, b: Rect): boolean;
+  union(rect: Rect): void;
+  union(x: number, y: number,): void;
+  union(left: number, top: number, right: number, bottom: number): void;
 
-  public intersects(rect: Rect): boolean;
-  public intersects(left: number, top: number, right: number, bottom: number): boolean;
+  sort(): void
 
-  public union(rect: Rect): void;
-  public union(x: number, y: number,): void;
-  public union(left: number, top: number, right: number, bottom: number): void;
+  round(): void
 
-  public sort(): void;
+  scale(scale: number): void
 
-  public round(): void;
+  getLeft(): number
 
-  public scale(scale: number): void;
+  getRight(): number
 
-  public setLeft(left: number): Rect;
+  getTop(): number
 
-  public setRight(right: number): Rect;
+  getBottom(): number
 
-  public setTop(top: number): Rect;
+  setLeft(left: number): Rect
 
-  public setBottom(bottom: number): Rect;
+  setRight(right: number): Rect
 
-  public getLeft(): number;
+  setTop(top: number): Rect
 
-  public getRight(): number;
+  setBottom(bottom: number): Rect
 
-  public getTop(): number;
+  toString(): string
 
-  public getBottom(): number;
+  dispose(): void;
+}
+
+/**
+ * Rect 接口的实现基类。
+ */
+export abstract class Rect extends InterfaceTemplate {}
+
+/**
+ * Rect 相关工具与工厂方法。
+ */
+export namespace Rect {
+  /**
+   * 判断两个矩形是否相交。
+   */
+  export function intersects(a: Rect, b: Rect): boolean;
+
+  /**
+   * 创建 Rect 实例。
+   */
+  export function create(context: Context,): Rect;
+  export function create(context: Context, rect: Rect): Rect;
+  export function create(context: Context, left: number, top: number, right: number, bottom: number): Rect;
 }

package/@types/RelativeLayout.d.ts

@@ -1,7 +1,13 @@
 import { ViewGroup } from "./ViewGroup";
 
+/**
+ * 相对布局，按相对关系定位子视图。
+ */
 export declare class RelativeLayout extends ViewGroup {}
 
 export declare namespace RelativeLayout {
+  /**
+   * RelativeLayout 的布局参数。
+   */
   class LayoutParams extends RelativeLayout.MarginLayoutParams {}
 }

package/@types/RendererBackend.ts

@@ -0,0 +1,8 @@
+/**
+ * 渲染后端类型（CanvasKit / Web / Node）。
+ */
+export enum RendererBackend {
+  CanvasKit = "canvasKit",
+  Web = "web",
+  Node = "node",
+}

package/@types/Resolver.ts

@@ -1,7 +1,12 @@
-import { Resources } from "./Resources";
+import { Context } from "./Context";
 
+/**
+ * 环境解析器，在 Context 挂载后解析命名参数。
+ */
 export declare class Resolver {
-  public mounted(res: Resources): void;
+  public mounted(context: Context): void;
 
   public resolve(...parameter: any[]): any;
+
+  public getContext(): Context;
 }

package/@types/Resources.d.ts

@@ -6,6 +6,9 @@ import { ColorDrawable } from "./ColorDrawable";
 import { Configuration } from "./Configuration";
 import { AttributeSet } from "./AttributeSet";
 
+/**
+ * 资源管理器，提供布局、drawable、字符串等资源读写。
+ */
 export declare class Resources {
   public getDisplayMetrics(): DisplayMetrics;
 

package/@types/ResourcesInflater.d.ts

@@ -1,6 +1,9 @@
 import { XML } from "@compass-framework/library";
 import { Context } from "./Context";
 
+/**
+ * 资源填充器，将 XML 资源解析并注入 Resources。
+ */
 export declare class ResourcesInflater {
   public static from(context: Context): ResourcesInflater;
 

package/@types/RotateAnimation.d.ts

@@ -1,10 +1,14 @@
 import { Animation } from "./Animation";
 import { Transformation } from "./Transformation";
+import { Context } from "./Context";
 
+/**
+ * 旋转动画。
+ */
 export declare class RotateAnimation extends Animation {
-  public constructor(fromDegrees: number, toDegrees: number);
-  public constructor(fromDegrees: number, toDegrees: number, pivotX: number, pivotY: number);
-  public constructor(fromDegrees: number, toDegrees: number, pivotXType: number, pivotXValue: number, pivotYType: number, pivotYValue: number);
+  public constructor(context: Context, fromDegrees: number, toDegrees: number);
+  public constructor(context: Context, fromDegrees: number, toDegrees: number, pivotX: number, pivotY: number);
+  public constructor(context: Context, fromDegrees: number, toDegrees: number, pivotXType: number, pivotXValue: number, pivotYType: number, pivotYValue: number);
 
   public applyTransformation(interpolatedTime: number, t: Transformation): void;
 

package/@types/ScaleAnimation.d.ts

@@ -1,10 +1,14 @@
 import { Animation } from "./Animation";
 import { Transformation } from "./Transformation";
+import { Context } from "./Context";
 
+/**
+ * 缩放动画。
+ */
 export declare class ScaleAnimation extends Animation {
-  public constructor(fromX: number, toX: number, fromY: number, toY: number);
-  public constructor(fromX: number, toX: number, fromY: number, toY: number, pivotX: number, pivotY: number);
-  public constructor(fromX: number, toX: number, fromY: number, toY: number, pivotXType: number, pivotXValue: number, pivotYType: number, pivotYValue: number);
+  public constructor(contex: Context, fromX: number, toX: number, fromY: number, toY: number);
+  public constructor(contex: Context, fromX: number, toX: number, fromY: number, toY: number, pivotX: number, pivotY: number);
+  public constructor(contex: Context, fromX: number, toX: number, fromY: number, toY: number, pivotXType: number, pivotXValue: number, pivotYType: number, pivotYValue: number);
 
   public applyTransformation(interpolatedTime: number, t: Transformation): void;
 

package/@types/ScrollView.d.ts

@@ -2,6 +2,9 @@ import {
   FrameLayout,
 } from "./FrameLayout";
 
+/**
+ * 垂直滚动视图，可滚动显示超出范围的内容。
+ */
 export declare class ScrollView extends FrameLayout {
   public scrollTo(x: number, y: number): void;
 

package/@types/Shader.d.ts

@@ -1 +1,15 @@
-export abstract class Shader {}
+import {
+  InterfaceTemplate,
+} from "@compass-framework/library";
+
+/**
+ * 着色器，为 Paint 提供渐变或图案填充。
+ */
+export interface Shader {
+  dispose(): void;
+}
+
+/**
+ * Shader 接口的实现基类。
+ */
+export abstract class Shader extends InterfaceTemplate {}

package/@types/Shadow.d.ts

@@ -1,8 +1,34 @@
-export declare class Shadow {
-  public x: number;
-  public y: number;
-  public blur: number;
-  public color: number;
+import {
+  InterfaceTemplate,
+} from "@compass-framework/library";
+import { Context } from "./Context";
 
-  public constructor(x: number, y: number, blur: number, color: number);
+/**
+ * 阴影效果，描述偏移、模糊半径与颜色。
+ */
+export interface Shadow {
+  getShadowX(): number;
+
+  getShadowY(): number;
+
+  getShadowRadius(): number;
+
+  getShadowColor(): number;
+
+  dispose(): void
+}
+
+/**
+ * Shadow 接口的实现基类。
+ */
+export abstract class Shadow extends InterfaceTemplate {}
+
+/**
+ * Shadow 工厂方法。
+ */
+export namespace Shadow {
+  /**
+   * 创建阴影效果实例。
+   */
+  export function create(context: Context, shadowX: number, shadowY: number, shadowRadius: number, shadowColor: number): Shadow;
 }

package/@types/Slot.d.ts

@@ -1,15 +1,24 @@
 import { InterfaceTemplate } from "@compass-framework/library";
 import { View } from "./View";
 
+/**
+ * 插槽接口，用于替换目标视图内容。
+ */
 export declare interface Slot {
   replace(target: View, options?: Slot.Options): void
 }
 
+/**
+ * Slot 的接口模板实现。
+ */
 export class Slot extends InterfaceTemplate {
 
 }
 
 export namespace Slot {
+  /**
+   * 插槽替换选项，控制替换或包裹模式。
+   */
   export interface Options {
     patten?: 'replace' | 'wrap'
   }

package/@types/Surface.d.ts

@@ -0,0 +1,32 @@
+import { InterfaceTemplate } from "@compass-framework/library";
+import { Image } from "./Image";
+import { Canvas } from "./Canvas";
+import { Context } from "./Context";
+
+/**
+ * 离屏绘制表面，可获取 Canvas 并生成图像快照。
+ */
+export interface Surface {
+  getCanvas(): Canvas;
+
+  dispose(): void;
+
+  flush(): void;
+
+  makeImageSnapshot(): Image
+}
+
+/**
+ * Surface 接口的实现基类。
+ */
+export abstract class Surface extends InterfaceTemplate {}
+
+/**
+ * Surface 工厂方法。
+ */
+export namespace Surface {
+  /**
+   * 创建指定宽高的 Surface。
+   */
+  export function create(context: Context, width: number, height: number): Surface;
+}

package/@types/SurfaceProvider.d.ts

@@ -0,0 +1,25 @@
+import { InterfaceTemplate } from "@compass-framework/library";
+import { Context } from "./Context";
+import { Surface } from "./Surface";
+
+/**
+ * Surface 提供者，按设备尺寸创建绘制表面。
+ */
+export interface SurfaceProvider {
+  makeSurface(deviceWidth: number, deviceHeight: number): Surface;
+}
+
+/**
+ * SurfaceProvider 接口的实现基类。
+ */
+export abstract class SurfaceProvider extends InterfaceTemplate {}
+
+/**
+ * SurfaceProvider 工厂方法。
+ */
+export namespace SurfaceProvider {
+  /**
+   * 创建 SurfaceProvider 实例。
+   */
+  export function create(context: Context): SurfaceProvider;
+}

package/@types/TabBarLayout.d.ts

@@ -2,6 +2,9 @@ import { InterfaceTemplate } from "@compass-framework/library";
 import { View } from "./View";
 import { LinearLayout } from "./LinearLayout";
 
+/**
+ * 标签栏布局，管理内容区与页脚区的标签切换。
+ */
 export declare class TabBarLayout extends LinearLayout {
   public hasScroll(): boolean;
 
@@ -17,16 +20,25 @@ export declare class TabBarLayout extends LinearLayout {
 }
 
 export namespace TabBarLayout {
+  /**
+   * 标签栏插槽类型，区分内容区、页脚与默认区域。
+   */
   export enum Slot {
     CONTENT = "CONTENT",
     FOOTER = "FOOTER",
     DEFAULT = "DEFAULT",
   }
 
+  /**
+   * 标签栏元素视图的编辑与状态回调。
+   */
   export interface TabBarLayoutElementViewListener {
     onEdit(): void;
     onState(status: boolean): void;
   }
+  /**
+   * TabBarLayoutElementViewListener 的接口模板实现。
+   */
   export class TabBarLayoutElementViewListener extends InterfaceTemplate {
 
   }

package/@types/TableLayout.d.ts

@@ -1,8 +1,14 @@
 import { ViewGroup } from "./ViewGroup";
 import { LinearLayout } from "./LinearLayout";
 
+/**
+ * 表格布局，按行列组织子视图。
+ */
 export declare class TableLayout extends ViewGroup {}
 
 export declare namespace TableLayout {
+  /**
+   * TableLayout 的布局参数。
+   */
   export class LayoutParams extends LinearLayout.LayoutParams {}
 }

package/@types/TableRow.d.ts

@@ -1,8 +1,14 @@
 import { ViewGroup } from "./ViewGroup";
 import { LinearLayout } from "./LinearLayout";
 
+/**
+ * 表格行，作为 TableLayout 中的一行容器。
+ */
 export declare class TableRow extends ViewGroup {}
 
 export namespace TableRow {
+  /**
+   * TableRow 的布局参数。
+   */
   export class LayoutParams extends LinearLayout.LayoutParams {}
 }

package/@types/TextView.d.ts

@@ -1,6 +1,9 @@
 import { CharSequence } from "@compass-framework/library";
 import { View } from "./View";
 
+/**
+ * 文本视图，负责显示与样式化文本内容。
+ */
 export declare class TextView extends View {
   public getHint(): CharSequence;
 

package/@types/Theme.d.ts

@@ -1,3 +1,6 @@
+/**
+ * 主题，管理亮色/暗色模式。
+ */
 export declare class Theme {
   public constructor();
   public constructor(theme: Theme);
@@ -9,7 +12,13 @@ export declare class Theme {
   public setMode(mode: Theme.Mode): void;
 }
 
+/**
+ * Theme 相关类型定义。
+ */
 export namespace Theme {
+  /**
+   * 主题模式（亮色/暗色）。
+   */
   export enum Mode {
     Light,
     Dark,

package/@types/TimeInterpolator.d.ts

@@ -1,9 +1,15 @@
 import { InterfaceTemplate } from "@compass-framework/library";
 
+/**
+ * 时间插值器接口。
+ */
 export declare interface TimeInterpolator {
   getInterpolation(input: number): number;
 }
 
+/**
+ * 时间插值器实现类。
+ */
 export declare class TimeInterpolator extends InterfaceTemplate {
 
 }

package/@types/Transformation.d.ts

@@ -1,11 +1,17 @@
 import { Matrix } from './Matrix';
+import { Context } from "./Context";
 
+/**
+ * 变换信息，组合透明度与矩阵用于动画插值结果。
+ */
 export declare class Transformation {
   public static TYPE_IDENTITY: number;
   public static TYPE_ALPHA: number;
   public static TYPE_MATRIX: number;
   public static TYPE_BOTH: number;
 
+  public constructor(context: Context);
+
   public clear(): void;
 
   public getTransformationType(): number;

package/@types/TranslateAnimation.d.ts

@@ -1,9 +1,13 @@
 import { Animation } from "./Animation";
 import { Transformation } from "./Transformation";
+import { Context } from "./Context";
 
+/**
+ * 平移动画。
+ */
 export declare class TranslateAnimation extends Animation {
-  public constructor(fromXDelta: number, toXDelta: number, fromYDelta: number, toYDelta: number);
-  public constructor(fromXType: number, fromXValue: number, toXType: number, toXValue: number, fromYType: number, fromYValue: number, toYType: number, toYValue: number);
+  public constructor(context: Context, fromXDelta: number, toXDelta: number, fromYDelta: number, toYDelta: number);
+  public constructor(context: Context, fromXType: number, fromXValue: number, toXType: number, toXValue: number, fromYType: number, fromYValue: number, toYType: number, toYValue: number);
 
   public applyTransformation(interpolatedTime: number, t:Transformation): void;
 

package/@types/TypeEvaluator.d.ts

@@ -1,3 +1,6 @@
+/**
+ * 类型求值器，用于计算动画中间值。
+ */
 export declare class TypeEvaluator {
 
 }

package/@types/Typeface.d.ts

@@ -1,10 +1,28 @@
-export declare class Typeface {
-  public getTypefaceName(): string;
+import {
+  InterfaceTemplate,
+} from "@compass-framework/library";
 
-  public getTypefaceStyle(): Typeface.TypefaceStyle;
+/**
+ * 字体（字型），描述字体名称与样式。
+ */
+export interface Typeface {
+  getTypefaceName(): string;
+
+  getTypefaceStyle(): Typeface.TypefaceStyle;
 }
 
+/**
+ * Typeface 接口的实现基类。
+ */
+export abstract class Typeface extends InterfaceTemplate {}
+
+/**
+ * Typeface 相关类型。
+ */
 export namespace Typeface {
+  /**
+   * 字体样式（常规、粗体、斜体等）。
+   */
   export enum TypefaceStyle {
     NORMAL,
     BOLD,

package/@types/TypefaceFactory.d.ts

@@ -1,9 +1,45 @@
+import { InterfaceTemplate } from "@compass-framework/library";
+import { Context } from "./Context";
 import { Typeface } from "./Typeface";
 
-export declare class TypefaceFactory {
-  public static getInstance(): TypefaceFactory;
+/**
+ * 字体工厂，用于获取、创建与加载 Typeface。
+ */
+export interface TypefaceFactory {
+  createFromTypeface(typeface: Typeface, style?: Typeface.TypefaceStyle): Typeface;
 
-  public create(name: string, style?: Typeface.TypefaceStyle): Typeface;
+  acquireTypeface(name: string, style?: Typeface.TypefaceStyle): Typeface;
 
-  public load(name: string, url: string, style?: Typeface.TypefaceStyle,): Promise<Typeface>;
+  defaultFromStyle(style?: Typeface.TypefaceStyle): Typeface;
+
+  useDefaultTypeface(typeface: Typeface, style?: Typeface.TypefaceStyle): void
+
+  loadTypefaceFromUrl(name: string, url: string, options?: TypefaceFactory.LoadTypefaceOptions): Promise<Typeface>;
+}
+
+/**
+ * TypefaceFactory 接口的实现基类。
+ */
+export abstract class TypefaceFactory extends InterfaceTemplate {}
+
+/**
+ * TypefaceFactory 相关常量、选项与单例访问。
+ */
+export namespace TypefaceFactory {
+  export const SANS_SERIF: string;
+  export const SERIF : string;
+  export const MONOSPACE: string;
+
+  /**
+   * 从 URL 加载字体时的选项。
+   */
+  export interface LoadTypefaceOptions {
+    useDefault?: boolean;
+    style?: Typeface.TypefaceStyle
+  }
+
+  /**
+   * 获取 TypefaceFactory 单例。
+   */
+  export function getInstance(context: Context): TypefaceFactory;
 }

package/@types/ValueAnimator.d.ts

@@ -5,6 +5,9 @@ import { PropertyValuesHolder } from "./PropertyValuesHolder";
 import { TimeInterpolator } from "./TimeInterpolator";
 import { TypeEvaluator } from "./TypeEvaluator";
 
+/**
+ * 值动画，在指定值之间插值。
+ */
 export declare class ValueAnimator extends Animator {
   public static getCurrentAnimationsCount(): number;
 
@@ -103,10 +106,19 @@ export declare class ValueAnimator extends Animator {
   public setCurrentPlayTime(playTime: number): void;
 }
 
+/**
+ * 值动画相关类型。
+ */
 export namespace ValueAnimator {
+  /**
+   * 动画值更新监听器。
+   */
   export interface AnimatorUpdateListener {
     onAnimationUpdate(animation: ValueAnimator): void;
   }
 
+  /**
+   * 动画值更新监听器实现类。
+   */
   export class AnimatorUpdateListener extends InterfaceTemplate {}
 }