@compass-framework/core 1.2.55 → 1.2.57

package/@types/AbsoluteLayout.d.ts

@@ -1,8 +1,14 @@
 import { ViewGroup } from "./ViewGroup";
 
+/**
+ * 绝对定位布局，子视图按指定坐标放置。
+ */
 export declare class AbsoluteLayout extends ViewGroup {}
 
 export declare namespace AbsoluteLayout {
+  /**
+   * AbsoluteLayout 的布局参数，包含子视图的 X/Y 坐标。
+   */
   export class LayoutParams extends ViewGroup.LayoutParams {
     public getX(): number;
 

package/@types/AccelerateDecelerateInterpolator.d.ts

@@ -4,6 +4,9 @@ import {
   Interpolator,
 } from "./Interpolator";
 
+/**
+ * 先加速后减速插值器。
+ */
 @Implements(Interpolator)
 export declare class AccelerateDecelerateInterpolator implements Interpolator {
   public getInterpolation(input: number): number;

package/@types/AccelerateInterpolator.d.ts

@@ -4,6 +4,9 @@ import {
   Interpolator,
 } from "./Interpolator";
 
+/**
+ * 加速插值器。
+ */
 @Implements(Interpolator)
 export declare class AccelerateInterpolator implements Interpolator {
   public constructor();

package/@types/Adapter.d.ts

@@ -2,6 +2,9 @@ import { InterfaceTemplate } from "@compass-framework/library";
 import { View } from "./View";
 import { ViewGroup } from "./ViewGroup";
 
+/**
+ * 适配器接口，为列表类控件提供数据与视图绑定。
+ */
 export declare interface Adapter {
   getCount(): number;
 
@@ -20,6 +23,9 @@ export declare interface Adapter {
   getItemViewType(position: number): number;
 }
 
+/**
+ * Adapter 的接口模板实现。
+ */
 export class Adapter extends InterfaceTemplate {
 
 }

package/@types/AlphaAnimation.d.ts

@@ -1,7 +1,12 @@
 import { Transformation } from "./Transformation";
+import { Animation } from "./Animation";
+import { Context } from "./Context";
 
+/**
+ * 透明度动画。
+ */
 export declare class AlphaAnimation extends Animation {
-  public constructor(fromAlpha: number, toAlpha: number);
+  public constructor(context: Context, fromAlpha: number, toAlpha: number) ;
 
   public applyTransformation(interpolatedTime: number, t: Transformation): void;
 

package/@types/Animation.d.ts

@@ -3,7 +3,11 @@ import { Rect } from './Rect';
 import { Transformation } from './Transformation';
 import { Interpolator } from './Interpolator';
 import { AttributeSet } from "./AttributeSet";
+import { Context } from "./Context";
 
+/**
+ * 视图动画的基类。
+ */
 export declare abstract class Animation {
   public static INFINITE: number;
   public static RESTART: number;
@@ -16,8 +20,8 @@ export declare abstract class Animation {
   public static ZORDER_TOP: number;
   public static ZORDER_BOTTOM: number;
 
-  protected constructor();
-  protected constructor(attribute: AttributeSet);
+  protected constructor(context: Context);
+  protected constructor(context: Context, attribute: AttributeSet);
 
   public clone(): Animation;
 
@@ -107,7 +111,13 @@ export declare abstract class Animation {
   public initializeInvalidateRegion(left: number, top: number, right: number, bottom: number): void;
 }
 
+/**
+ * 视图动画相关类型。
+ */
 export declare namespace Animation {
+  /**
+   * 动画生命周期监听器。
+   */
   export interface AnimationListener {
     onAnimationStart(animation: Animation): void
 
@@ -116,6 +126,9 @@ export declare namespace Animation {
     onAnimationRepeat(animation: Animation): void;
   }
 
+  /**
+   * 动画生命周期监听器实现类。
+   */
   export class AnimationListener extends InterfaceTemplate {
 
   }

package/@types/AnimationSet.d.ts

@@ -1,7 +1,11 @@
 import { List } from "@compass-framework/library";
 import { Animation } from "./Animation";
 import { Transformation } from "./Transformation";
+import { Context } from "./Context";
 
+/**
+ * 动画集合，可组合多个动画同时播放。
+ */
 export declare class AnimationSet extends Animation {
   public static PROPERTY_FILL_AFTER_MASK: number;
   public static PROPERTY_FILL_BEFORE_MASK: number;
@@ -12,7 +16,7 @@ export declare class AnimationSet extends Animation {
   public static PROPERTY_MORPH_MATRIX_MASK: number;
   public static PROPERTY_CHANGE_BOUNDS_MASK: number;
 
-  public constructor(shareInterpolator: boolean);
+  public constructor(context: Context, shareInterpolator: boolean) ;
 
   public clone(): AnimationSet;
 

package/@types/Animator.d.ts

@@ -2,6 +2,9 @@ import { ArrayList, InterfaceTemplate } from "@compass-framework/library";
 import { Context } from "./Context";
 import { TimeInterpolator } from "./TimeInterpolator";
 
+/**
+ * 属性动画的基类。
+ */
 export declare abstract class Animator {
   public constructor(context: Context);
 
@@ -40,7 +43,13 @@ export declare abstract class Animator {
   public setupStartValues(): void;
 }
 
+/**
+ * 属性动画相关类型。
+ */
 export declare namespace Animator {
+  /**
+   * 动画器生命周期监听器。
+   */
   export interface AnimatorListener {
     onAnimationStart(animation: Animator): void;
 
@@ -51,5 +60,8 @@ export declare namespace Animator {
     onAnimationRepeat(animation: Animator): void;
   }
 
+  /**
+   * 动画器生命周期监听器实现类。
+   */
   export class AnimatorListener extends InterfaceTemplate {}
 }

package/@types/Application.d.ts

@@ -1,19 +1,57 @@
-import { ApplicationContext } from "./ApplicationContext";
-import { ApplicationManifest } from "./ApplicationManifest";
-import { ApplicationFrame } from "./ApplicationFrame";
+import { Consumer } from "@compass-framework/library";
+import { Context } from "./Context";
+import { RendererBackend } from "./RendererBackend";
+import { InputMethodService } from "./InputMethodService";
 
-export declare class Application {
-  public constructor(applicationManifest: ApplicationManifest);
+/**
+ * Web 端应用启动配置。
+ */
+export interface WebApplicationConfig {
+  ime?: () => InputMethodService
+  container?: string | HTMLElement
+}
+
+/**
+ * CanvasKit 渲染后端的应用启动配置。
+ */
+export interface CanvaskitApplicationConfig extends WebApplicationConfig {
+
+}
 
-  public attachFrame(applicationFrame: ApplicationFrame): void;
+/**
+ * Node 端应用启动配置。
+ */
+export interface NodeApplicationConfig {
+  width: number;
+  height: number;
+}
 
-  public detachFrame(applicationFrame: ApplicationFrame): void;
+/**
+ * 应用程序入口与生命周期管理。
+ */
+export declare interface Application {
+  onReady(consumer: Consumer<Context>): void;
 
-  public onInstall(applicationContext: ApplicationContext): void;
+  addWindow(window: Window): void;
 
-  public onUninstall(): void;
+  removeWindow(window: Window): void;
+}
 
-  public getApplicationContext(): ApplicationContext;
+/**
+ * Application 工厂与配置映射。
+ */
+export namespace Application {
+  /**
+   * 按渲染后端区分的应用配置映射。
+   */
+  export interface ApplicationConfig {
+    [RendererBackend.CanvasKit]: CanvaskitApplicationConfig,
+    [RendererBackend.Web]: WebApplicationConfig,
+    [RendererBackend.Node]: NodeApplicationConfig,
+  }
 
-  public getApplicationManifest(): ApplicationManifest;
+  /**
+   * 按渲染后端创建应用实例。
+   */
+  export function create<T extends keyof ApplicationConfig>(render: RendererBackend, config: ApplicationConfig[T]): Application;
 }

package/@types/ApplicationWindow.d.ts

@@ -1,14 +1,18 @@
 import { ArrayList, Implements, XML } from "@compass-framework/library";
-import { IWindow } from "./IWindow";
 import { Resources } from "./Resources";
 import { View } from "./View";
 import { WindowContext } from "./WindowContext";
-import { ViewGroup } from "./ViewGroup";
 import { WindowManager } from "./WindowManager";
+import { ViewGroup } from "./ViewGroup";
+import { Context } from "./Context";
+import { Window } from "./Window";
 import { Configuration } from "./Configuration";
 
-@Implements(IWindow)
-export declare class ApplicationWindow implements IWindow {
+/**
+ * 应用程序主窗口，承载内容视图与窗口生命周期。
+ */
+@Implements(Window)
+export declare class ApplicationWindow implements Window {
   public constructor();
   public constructor(context: WindowContext);
 
@@ -35,7 +39,7 @@ export declare class ApplicationWindow implements IWindow {
 
   public getResources(): Resources;
 
-  public getWindowContext(): WindowContext;
+  public getContext(): Context;
 
   public setContentXML(xml: XML): void;
 

package/@types/ArrayAdapter.d.ts

@@ -4,6 +4,9 @@ import { BaseAdapter } from "./BaseAdapter";
 import { Context } from "./Context";
 import { ViewGroup } from "./ViewGroup";
 
+/**
+ * 基于数组/列表数据的通用适配器，支持增删排序与变更通知。
+ */
 export declare class ArrayAdapter<T> extends BaseAdapter {
   public constructor(context: Context, textViewResourceId: number);
   public constructor(context: Context, resource: number, textViewResourceId: number);

package/@types/Assets.d.ts

@@ -1,3 +1,6 @@
+/**
+ * 资源资产访问，按名称解析资产 ID。
+ */
 export declare class Assets {
   public getAssetsId(name: string, defaultValue?: number): number;
 }

package/@types/AttributeSet.d.ts

@@ -4,6 +4,9 @@ import { PictureDrawable } from "./PictureDrawable";
 import { Drawable } from "./Drawable";
 import { ColorDrawable } from "./ColorDrawable";
 
+/**
+ * 属性集合，从资源或布局中按名称读取类型化属性值。
+ */
 export declare abstract class AttributeSet {
   public abstract getNumber(name: string, defaultValue?: number): number;
 
@@ -17,8 +20,6 @@ export declare abstract class AttributeSet {
 
   public abstract getResources(): Resources;
 
-  public abstract getConvert<T, R>(name: string, action: Influence<string, Nullable<R>>, defaultValue?: R): R;
-
   public abstract getText(name: string, defaultValue?: CharSequence): CharSequence;
 
   public abstract getDimension(name: string, defaultValue?: number): number;
@@ -29,6 +30,8 @@ export declare abstract class AttributeSet {
 
   public abstract getString(name: string, defaultValue?: string): string;
 
+  public abstract getConvert<T, R>(name: string, action: Influence<string, Nullable<R>>, defaultValue?: R): R;
+
   public abstract getDrawable(name: string, defaultValue?: Drawable): Drawable;
 
   public abstract getAttributeCount(): number;

package/@types/BaseAdapter.d.ts

@@ -3,6 +3,9 @@ import { ListAdapter } from "./ListAdapter";
 import { View } from "./View";
 import { ViewGroup } from "./ViewGroup";
 
+/**
+ * 列表适配器基类，提供 ListAdapter 的默认实现骨架。
+ */
 @Implements(ListAdapter)
 export declare abstract class BaseAdapter implements ListAdapter {
   protected constructor();

package/@types/BlendMode.ts

@@ -0,0 +1,150 @@
+/**
+ * 混合模式，控制源像素与目标像素的合成方式。
+ */
+export enum BlendMode {
+  /**
+     * Clears the destination.
+     */
+  Clear = "clear",
+
+  /**
+     * Replaces the destination with the source.
+     */
+  Src = "src",
+
+  /**
+     * Preserves the destination and discards the source.
+     */
+  Dst = "dst",
+
+  /**
+     * Source over destination.
+     */
+  SrcOver = "src-over",
+
+  /**
+     * Destination over source.
+     */
+  DstOver = "dst-over",
+
+  /**
+     * Source inside destination.
+     */
+  SrcIn = "src-in",
+
+  /**
+     * Destination inside source.
+     */
+  DstIn = "dst-in",
+
+  /**
+     * Source outside destination.
+     */
+  SrcOut = "src-out",
+
+  /**
+     * Destination outside source.
+     */
+  DstOut = "dst-out",
+
+  /**
+     * Source atop destination.
+     */
+  SrcATop = "src-atop",
+
+  /**
+     * Destination atop source.
+     */
+  DstATop = "dst-atop",
+
+  /**
+     * Exclusive-or source and destination.
+     */
+  Xor = "xor",
+
+  /**
+     * Adds source and destination.
+     */
+  Plus = "plus",
+
+  /**
+     * Multiplies source and destination.
+     */
+  Modulate = "modulate",
+
+  /**
+     * Multiplies source and destination colors.
+     */
+  Multiply = "multiply",
+
+  /**
+     * Produces the inverse of multiply.
+     */
+  Screen = "screen",
+
+  /**
+     * Combines multiply and screen.
+     */
+  Overlay = "overlay",
+
+  /**
+     * Selects the darker color.
+     */
+  Darken = "darken",
+
+  /**
+     * Selects the lighter color.
+     */
+  Lighten = "lighten",
+
+  /**
+     * Brightens the destination to reflect the source.
+     */
+  ColorDodge = "color-dodge",
+
+  /**
+     * Darkens the destination to reflect the source.
+     */
+  ColorBurn = "color-burn",
+
+  /**
+     * Multiplies or screens depending on the source.
+     */
+  HardLight = "hard-light",
+
+  /**
+     * Soft-light blend.
+     */
+  SoftLight = "soft-light",
+
+  /**
+     * Subtracts the darker color from the lighter color.
+     */
+  Difference = "difference",
+
+  /**
+     * Similar to difference but with lower contrast.
+     */
+  Exclusion = "exclusion",
+
+  /**
+     * Preserves the hue of the source.
+     */
+  Hue = "hue",
+
+  /**
+     * Preserves the saturation of the source.
+     */
+  Saturation = "saturation",
+
+  /**
+     * Uses the hue and saturation of the source and
+     * the luminosity of the destination.
+     */
+  Color = "color",
+
+  /**
+     * Preserves the luminosity of the source.
+     */
+  Luminosity = "luminosity",
+}

package/@types/BounceInterpolator.d.ts

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

package/@types/Button.d.ts

@@ -1,3 +1,6 @@
 import { TextView } from "./TextView";
 
+/**
+ * 按钮控件，基于 TextView 的可点击交互组件。
+ */
 export declare class Button extends TextView {}

package/@types/Canvas.d.ts

@@ -1,110 +1,96 @@
 import { CharSequence } from "@compass-framework/library";
-import { Paint } from "./Paint";
-import { Path } from "./Path";
-import { Picture } from "./Picture";
 import { Rect } from "./Rect";
+import { Paint } from "./Paint";
 import { Matrix } from "./Matrix";
-import { Bitmap } from "./Bitmap";
+import { Path } from "./Path";
+import { Image } from "./Image";
+import { ImageFilter } from "./ImageFilter";
 
-export declare class Canvas {
-  constructor();
-  constructor(width: number, height: number);
+/**
+ * 画布，提供路径、文本、图像等绘制能力。
+ */
+export interface Canvas {
+  translate(dx: number, dy: number): void;
 
   rotate(degrees: number): void;
   rotate(degrees: number, px: number, py: number): void;
 
   scale(sx: number, sy: number): void;
 
-  concat(matrix: Matrix): void;
-
-  translate(dx: number, dy: number): void;
-
   save(): number;
 
   restore(): void;
 
-  clearCanvas(): void;
+  clipRRect(rect: Rect, radius: number): void;
+  clipRRect(rect: Rect, ltr: number, lbr: number, rtr: number, rbr: number): void;
+  clipRRect(left: number, top: number, right: number, bottom: number, ltr: number, lbr: number, rtr: number, rbr: number): void
+
+  saveLayer(paint: Paint, filter?: ImageFilter): number;
+  saveLayer(left: number, top: number, right: number, bottom: number, paint: Paint): number;
+  saveLayer(left:number, top:number, right:number, bottom:number, paint: Paint, filter?: ImageFilter): number;
+
+  restoreToCount(count: number): void
+
   clearCanvas(rect: Rect): void;
-  clearCanvas(width: number, height: number): void;
+  clearCanvas(left: number, top: number, right: number, bottom: number): void;
 
-  setBitmap(bitmap: Bitmap): void;
+  getMatrix(): Matrix;
 
   getClipBounds(): Rect;
   getClipBounds(rect: Rect): boolean;
 
-  getMatrix(): Matrix;
+  getSaveCount(): number
+
+  clipPath(path: Path): void;
 
   getWidth(): number;
 
   getHeight(): number;
 
-  clipRRect(rect: Rect, radius: number): void;
-  clipRRect(rect: Rect, ltr: number, lbr: number, rtr: number, rbr: number): void;
-  clipRRect(left: number, top: number, right: number, bottom: number, ltr: number, lbr: number, rtr: number, rbr: number): void;
-
-  clipPath(path: Path): void;
-
   clipRect(rect: Rect): void;
   clipRect(left: number, top: number, right: number, bottom: number): void;
 
+  concat(matrix: Matrix): void;
+
   quickReject(rect: Rect): boolean;
-  quickReject(path: Path): boolean;
+  quickReject(rect: Path): boolean;
   quickReject(left: number, top: number, right: number, bottom: number): boolean;
 
-  drawOval(oval: Rect, paint: Paint): void;
-  drawOval(left: number, top: number, right: number, bottom: number, paint: Paint): void;
+  drawArc(oval: Rect, startAngle: number, sweepAngle: number, useCenter: boolean, paint: Paint): void;
+  drawArc(left: number, top: number, right: number, bottom: number, startAngle: number, sweepAngle: number, useCenter: boolean, paint: Paint): void;
+
+  drawDashLines(pts: number[], dash: number[], offset: number, paint: Paint): void;
 
   drawRect(rect: Rect, paint: Paint): void;
   drawRect(left: number, top: number, right: number, bottom: number, paint: Paint): void;
 
-  drawLine(sx: number, sy: number, ex: number, ey: number, paint: Paint): void;
-
-  drawLines(pts: number[], paint: Paint): void;
-
   drawPath(path: Path, paint: Paint): void;
 
-  drawRRect(rect: Rect, radius: number, paint: Paint): void;
-  drawRRect(rect: Rect, ltr: number, lbr: number, rtr: number, rbr: number, paint: Paint): void;
-  drawRRect(left: number, top: number, right: number, bottom: number, ltr: number, lbr: number, rtr: number, rbr: number, paint: Paint): void;
-
-  drawPicture(canvas: Picture): void;
-  drawPicture(canvas: Picture, dst: Rect): void;
-  drawPicture(canvas: Picture, dst: Rect, paint: Paint): void;
-
   drawText(text: CharSequence, x: number, y: number, paint: Paint): void;
   drawText(text: CharSequence, start: number, end: number, x: number, y: number, paint: Paint): void;
 
-  drawDashLine(sx: number, sy: number, ex: number, ey: number, dash: number[], offset: number, paint: Paint): void;
+  drawCircle(cx: number, cy: number, radius: number, paint: Paint): void;
 
-  drawDashLines(pts: number[], dash: number[], offset: number, paint: Paint): void;
+  drawLine(sx: number, sy: number, ex: number, ey: number, paint: Paint): void;
 
-  drawBitmap(bitmap: Bitmap, pt: number[], paint: Paint): void;
-  drawBitmap(bitmap: Bitmap, left: number, top: number, paint: Paint): void;
-  drawBitmap(bitmap: Bitmap, src: Rect, dst: Rect, paint: Paint): void;
+  drawLines(pts: number[], paint: Paint): void;
 
-  drawCircle(cx: number, cy: number, radius: number, paint: Paint): void;
+  drawOval(oval: Rect, paint: Paint): void;
+  drawOval(left: number, top: number, right: number, bottom: number, paint: Paint): void;
 
-  drawArc(oval: Rect, startAngle: number, sweepAngle: number, useCenter: boolean, paint: Paint): void;
-  drawArc(left: number, top: number, right: number, bottom: number, startAngle: number, sweepAngle: number, useCenter: boolean, paint: Paint): void;
+  drawImage(image: Image, paint: Paint): void;
+  drawImage(image: Image, dst: Rect, paint: Paint): void;
+  drawImage(image: Image, src: Rect, dst: Rect, paint: Paint): void
 
-  drawRGB(rect: Rect, r: number, g: number, b: number): void;
-  drawRGB(rect: Rect, r: number, g: number, b: number, paint: Paint): void;
-  drawRGB(left: number, top: number, right: number, bottom: number, r: number, g: number, b: number): void;
-  drawRGB(left: number, top: number, right: number, bottom: number, r: number, g: number, b: number, paint: Paint): void;
+  drawColor(color: number): void;
 
-  drawARGB(rect: Rect, a: number, r: number, g: number, b: number): void;
-  drawARGB(rect: Rect, a: number, r: number, g: number, b: number, paint: Paint): void;
-  drawARGB(left: number, top: number, right: number, bottom: number, a: number, r: number, g: number, b: number): void;
-  drawARGB(left: number, top: number, right: number, bottom: number, a: number, r: number, g: number, b: number, paint: Paint): void;
+  drawRGB(r: number, g: number, b: number): void;
 
-  drawColor(rect: Rect, color: number): void;
-  drawColor(rect: Rect, color: number, paint: Paint): void;
-  drawColor(left: number, top: number, right: number, bottom: number, color: number): void;
-  drawColor(left: number, top: number, right: number, bottom: number, color: number, paint: Paint): void;
-}
+  drawARGB(a: number, r: number, g: number, b: number): void;
 
-export declare namespace Canvas {
-  export function build(): Canvas;
+  drawRRect(rect: Rect, radius: number, paint: Paint): void;
+  drawRRect(rect: Rect, ltr: number, lbr: number, rtr: number, rbr: number, paint: Paint): void
+  drawRRect(left: number, top: number, right: number, bottom: number, ltr: number, lbr: number, rtr: number, rbr: number, paint: Paint): void
 
-  export function radians(degrees: number): number;
+  drawDashLine(sx: number, sy: number, ex: number, ey: number, dash: number[], offset: number, paint: Paint): void;
 }