@compass-framework/core 1.2.56 → 1.2.58

package/@types/Color.d.ts

@@ -1,46 +1,56 @@
-export declare class Color {
-  public static BLACK: number;
-  public static DKGRAY: number;
-  public static GRAY: number;
-  public static LTGRAY: number;
-  public static WHITE: number;
-  public static RED: number;
-  public static GREEN: number;
-  public static BLUE: number;
-  public static YELLOW: number;
-  public static CYAN: number;
-  public static MAGENTA: number;
-  public static TRANSPARENT: number;
+/**
+ * 颜色工具接口占位。
+ */
+export interface Color {
 
-  public static alpha(color: number): number;
+}
+
+/**
+ * 颜色常量与 ARGB/HSV 等颜色工具方法。
+ */
+export declare namespace Color {
+  export const BLACK: number;
+  export const DKGRAY: number;
+  export const GRAY: number;
+  export const LTGRAY: number;
+  export const WHITE: number;
+  export const RED: number;
+  export const GREEN: number;
+  export const BLUE: number;
+  export const TRANSPARENT: number;
+  export const YELLOW: number;
+  export const CYAN: number;
+  export const MAGENTA: number;
+
+  export function alpha(color: number): number;
 
-  public static red(color: number): number;
+  export function red(color: number): number;
 
-  public static green(color: number): number;
+  export function green(color: number): number;
 
-  public static blue(color: number): number;
+  export function blue(color: number): number;
 
-  public static argb(alpha: number, red: number, green: number, blue: number);
+  export function argb(alpha: number, red: number, green: number, blue: number);
 
-  public static rgb(red: number, green: number, blue: number);
+  export function hue(color: number): number;
 
-  public static hue(color: number): number;
+  export function rgb(red: number, green: number, blue: number);
 
-  public static pin(value: number): number;
+  export function pin(value: number): number;
 
-  public static rgbaString(color: number): string;
+  export function rgbaString(color: number): string;
 
-  public static rgbString(color: number): string;
+  export function rgbString(color: number): string;
 
-  public static parseColor(colorString: string, colorType?: 'rgba' | 'argb'): number;
+  export function parseColor(colorString: string, colorType?: 'rgba' | 'argb'): number;
 
-  public static saturation(color: number): number;
+  export function saturation(color: number): number;
 
-  public static brightness(color: number): number;
+  export function brightness(color: number): number;
 
-  public static HSBtoColor(hsb: number[]): number;
-  public static HSBtoColor(h: number, s: number, b: number): number;
+  export function HSBtoColor(hsb: number[]): number;
+  export function HSBtoColor(h: number, s: number, b: number): number;
 
-  public static HSVToColor(hsv: number[]): number;
-  public static HSVToColor(alpha: number, hsv: number[]): number;
+  export function HSVToColor(hsv: number[]): number;
+  export function HSVToColor(alpha: number, hsv: number[]): number;
 }

package/@types/ColorDrawable.d.ts

@@ -1,8 +1,12 @@
 import { Drawable } from "./Drawable";
 import { Canvas } from "./Canvas";
+import { Context } from "./Context";
 
+/**
+ * 纯色 Drawable，用单一颜色填充自身边界。
+ */
 export declare class ColorDrawable extends Drawable {
-  public constructor(color: number);
+  public constructor(context: Context, color: number);
 
   public draw(canvas: Canvas): void;
 

package/@types/ColorFilter.ts

@@ -0,0 +1,15 @@
+import { InterfaceTemplate } from "@compass-framework/library";
+
+/**
+ * 颜色滤镜，用于改变绘制内容的颜色表现。
+ */
+export interface ColorFilter {
+  dispose(): void;
+}
+
+/**
+ * ColorFilter 接口的实现基类。
+ */
+export abstract class ColorFilter extends InterfaceTemplate {
+
+}

package/@types/Configuration.d.ts

@@ -1,6 +1,9 @@
 import { Theme } from "./Theme";
 import { DisplayMetrics } from "./DisplayMetrics";
 
+/**
+ * 设备与主题等运行时配置。
+ */
 export declare class Configuration {
   constructor(config: Configuration);
 

package/@types/Context.d.ts

@@ -1,11 +1,29 @@
 import { Environment } from "./Environment";
 import { Resources } from "./Resources";
 import { XMLViewFactoryRegistry } from "./XMLViewFactoryRegistry";
+import { DisplayMetrics } from "./DisplayMetrics";
+import { MouseCursor } from "./MouseCursor";
+import { RendererBackend } from "./RendererBackend";
+import { WindowManager } from "./WindowManager";
+import { SurfaceProvider } from "./SurfaceProvider";
 
+/**
+ * 全局运行时上下文，提供资源、环境与窗口管理等服务。
+ */
 export declare interface Context {
-  getViewFactoryRegistry(): XMLViewFactoryRegistry;
+  getDisplayMetrics(): DisplayMetrics
 
-  getResources(): Resources;
+  getMouseCursor(): MouseCursor
 
-  getEnvironment(): Environment;
+  getRendererBackend(): RendererBackend
+
+  getResources(): Resources
+
+  getSurfaceProvider(): SurfaceProvider
+
+  getViewFactoryRegistry() :XMLViewFactoryRegistry
+
+  getEnvironment(): Environment
+
+  getWindowManager(): WindowManager
 }

package/@types/ContextUtils.d.ts

@@ -1,5 +1,8 @@
 import { Context } from "./Context";
 
+/**
+ * Context 工具类，用于创建子作用域上下文。
+ */
 export declare class ContextUtils {
   static newSubScopeContext(context: Context): Context;
 }

package/@types/CornerPathEffect.d.ts

@@ -0,0 +1,26 @@
+import { Implements, InterfaceTemplate } from "@compass-framework/library";
+import { Context } from "./Context";
+import { PathEffect } from "./PathEffect";
+
+/**
+ * 圆角路径效果，将路径尖角平滑为圆角。
+ */
+export declare interface CornerPathEffect extends PathEffect {
+
+}
+
+/**
+ * CornerPathEffect 接口的实现基类。
+ */
+@Implements(PathEffect)
+export class CornerPathEffect extends InterfaceTemplate {}
+
+/**
+ * CornerPathEffect 工厂方法。
+ */
+export namespace CornerPathEffect {
+  /**
+   * 创建指定圆角半径的 CornerPathEffect。
+   */
+  export function create(context: Context, radius: number): CornerPathEffect;
+}

package/@types/CornersDrawable.d.ts

@@ -1,9 +1,12 @@
 import { Drawable } from "./Drawable";
 import { Canvas } from "./Canvas";
-import { Resources } from "./Resources";
+import { Context } from "./Context";
 
+/**
+ * 圆角矩形 Drawable，支持填充色与描边。
+ */
 export declare class CornersDrawable extends Drawable {
-  public constructor(info: CornersDrawable.CornersInfo, resources?: Resources);
+  public constructor(context: Context, info: CornersDrawable.CornersInfo);
 
   public draw(canvas: Canvas): void;
 
@@ -11,12 +14,14 @@ export declare class CornersDrawable extends Drawable {
 
   public getLeftTopRadius(): number;
 
-  public getRightTopRadius(): number;
-
   public getRightBottomRadius(): number;
 
+  public getRightTopRadius(): number;
+
   public getOpacity(): number;
 
+  public setBorderStrokeWidth(strokeWidth: number): void;
+
   public setCornersRadius(radius: number): void;
 
   public setAlpha(alpha: number): void;
@@ -25,8 +30,6 @@ export declare class CornersDrawable extends Drawable {
 
   public setBackgroundColor(color: number): void;
 
-  public setBorderStrokeWidth(strokeWidth: number): void;
-
   public setLeftBottomRadius(radius: number): void;
 
   public setLeftTopRadius(radius: number): void;
@@ -36,7 +39,13 @@ export declare class CornersDrawable extends Drawable {
   public setRightBottomRadius(radius: number): void;
 }
 
+/**
+ * CornersDrawable 相关配置类型。
+ */
 export namespace CornersDrawable {
+  /**
+   * 圆角、边框与背景色配置。
+   */
   export interface CornersInfo {
     leftTopRadius?: number,
     leftBottomRadius?: number,

package/@types/CycleInterpolator.d.ts

@@ -1,6 +1,9 @@
 import { Implements } from "@compass-framework/library";
 import { Interpolator } from "./Interpolator";
 
+/**
+ * 循环插值器。
+ */
 @Implements(Interpolator)
 export declare class CycleInterpolator implements Interpolator {
   public constructor(cycles: number);

package/@types/DecelerateInterpolator.d.ts

@@ -1,6 +1,9 @@
 import { Implements } from "@compass-framework/library";
 import { Interpolator } from "./Interpolator";
 
+/**
+ * 减速插值器。
+ */
 @Implements(Interpolator)
 export declare class DecelerateInterpolator implements Interpolator {
   public constructor();

package/@types/DisplayMetrics.d.ts

@@ -1,3 +1,6 @@
+/**
+ * 显示度量，提供屏幕尺寸、密度及单位换算。
+ */
 export class DisplayMetrics {
   public dp2px(dp: number): number;
 

package/@types/DoubleClick.d.ts

@@ -3,6 +3,9 @@ import { DoubleClickListener } from "./DoubleClickListener";
 import { View } from "./View";
 import { MotionEvent } from "./MotionEvent";
 
+/**
+ * 双击手势识别器，将触摸事件转换为单击/双击回调。
+ */
 @Implements(View.OnTouchListener)
 export declare class DoubleClick implements View.OnTouchListener {
   public constructor(doubleClickListener: DoubleClickListener, timeDifference?: number);

package/@types/DoubleClickListener.d.ts

@@ -2,6 +2,9 @@ import { InterfaceTemplate } from "@compass-framework/library";
 import { View } from "./View";
 import { MotionEvent } from "./MotionEvent";
 
+/**
+ * 双击监听器，处理单击、双击与指针触摸回调。
+ */
 export declare interface DoubleClickListener {
   onSingleClick(event: MotionEvent, view: View): void;
 
@@ -10,4 +13,7 @@ export declare interface DoubleClickListener {
   onTouchPointer(event: MotionEvent, view: View): boolean;
 }
 
+/**
+ * DoubleClickListener 的接口模板实现。
+ */
 export class DoubleClickListener extends InterfaceTemplate {}

package/@types/Drawable.d.ts

@@ -1,14 +1,17 @@
 import { InterfaceTemplate, Runnable } from "@compass-framework/library";
-import { Rect } from "./Rect";
+import { Resources } from "./Resources";
 import { Canvas } from "./Canvas";
-import { Configuration } from "./Configuration";
 import { Outline } from "./Outline";
-import { Resources } from "./Resources";
+import { Rect } from "./Rect";
+import { Configuration } from "./Configuration";
+import { Context } from "./Context";
 import { DisplayMetrics } from "./DisplayMetrics";
 
+/**
+ * 可绘制对象的基类，封装边界、透明度与绘制回调。
+ */
 export declare abstract class Drawable {
-  protected constructor();
-  protected constructor(drawable: Drawable);
+  protected constructor(context: Context);
 
   public abstract draw(canvas: Canvas): void;
 
@@ -47,7 +50,13 @@ export declare abstract class Drawable {
   public setCallback(callback: Drawable.Callback): void;
 }
 
+/**
+ * Drawable 相关嵌套类型。
+ */
 export declare namespace Drawable {
+  /**
+   * Drawable 的不可变常量状态，用于创建新实例。
+   */
   export abstract class ConstantState {
     public abstract newDrawable(): Drawable;
 
@@ -56,6 +65,9 @@ export declare namespace Drawable {
     public abstract getChangingConfigurations(): number;
   }
 
+  /**
+   * Drawable 失效与调度回调接口。
+   */
   export interface Callback {
     invalidateDrawable(who:Drawable): void
 
@@ -66,6 +78,9 @@ export declare namespace Drawable {
     getResources(): Resources;
   }
 
+  /**
+   * Callback 接口的实现基类。
+   */
   export class Callback extends InterfaceTemplate {
 
   }

package/@types/EditRichText.d.ts

@@ -3,6 +3,9 @@ import { Context } from "./Context";
 import { AttributeSet } from "./AttributeSet";
 import { View } from "./View";
 
+/**
+ * 富文本编辑器，支持 HTML 互转与选区样式操作。
+ */
 export class EditRichText extends FrameLayout {
   public static TEXT_DECORATION_UNDERLINE: number;
   public static TEXT_DECORATION_DOUBLE: number;

package/@types/EditText.d.ts

@@ -1,6 +1,9 @@
 import { TextView } from "./TextView";
 import { Editable } from "./Editable";
 
+/**
+ * 可编辑文本框，支持输入、选区与只读控制。
+ */
 export declare class EditText extends TextView {
   public isReadonly(): boolean;
 

package/@types/Editable.d.ts

@@ -1,9 +1,15 @@
 import { CharSequence, Implements, InterfaceTemplate } from "@compass-framework/library";
 
+/**
+ * 可编辑字符序列，表示可变文本内容。
+ */
 export declare interface Editable extends CharSequence {
 
 }
 
+/**
+ * Editable 的接口模板实现。
+ */
 @Implements(CharSequence)
 export class Editable extends InterfaceTemplate {
 

package/@types/Environment.ts

@@ -1,5 +1,8 @@
 import { Resolver } from "./Resolver";
 
+/**
+ * 运行环境，用于注册命名解析器。
+ */
 export interface Environment {
   defineResolver(name: string, resolver: Resolver): void
 }

package/@types/FrameLayout.d.ts

@@ -1,11 +1,17 @@
 import { ViewGroup } from "./ViewGroup";
 
+/**
+ * 帧布局，子视图按添加顺序叠放，可通过 gravity 对齐。
+ */
 export declare class FrameLayout extends ViewGroup {}
 
 export declare namespace FrameLayout {
+  /**
+   * FrameLayout 的布局参数，支持 gravity 对齐。
+   */
   export class LayoutParams extends ViewGroup.MarginLayoutParams {
-    public getGravity(): number
+    public getGravity(): number;
 
-    public setGravity(gravity: number): void
+    public setGravity(gravity: number): void;
   }
 }

package/@types/FreezeAbsoluteLayout.d.ts

@@ -1,7 +1,13 @@
 import { FreezeLayoutViewGroup } from "./FreezeLayoutViewGroup";
 
+/**
+ * 支持冻结区域的绝对定位布局。
+ */
 export declare class FreezeAbsoluteLayout extends FreezeLayoutViewGroup {}
 
 export declare namespace FreezeAbsoluteLayout {
+  /**
+   * FreezeAbsoluteLayout 的布局参数。
+   */
   export class LayoutParams extends FreezeLayoutViewGroup.LayoutParams {}
 }

package/@types/FreezeLayoutViewGroup.d.ts

@@ -1,5 +1,8 @@
 import { ViewGroup } from "./ViewGroup";
 
+/**
+ * 支持顶部/左侧区域冻结与独立滚动的视图组基类。
+ */
 export declare class FreezeLayoutViewGroup extends ViewGroup {
   public getFreezeLayoutScrollXStart(): number;
 

package/@types/Gravity.d.ts

@@ -1,5 +1,8 @@
 import { Rect } from "./Rect";
 
+/**
+ * 重力对齐常量与布局定位工具。
+ */
 export declare class Gravity {
   public static NO_GRAVITY;
   public static AXIS_PULL_BEFORE;

package/@types/GridLayout.d.ts

@@ -1,9 +1,15 @@
 import { ViewGroup } from "./ViewGroup";
 
+/**
+ * 网格布局，按行与列排列子视图。
+ */
 export declare class GridLayout extends ViewGroup {
 
 }
 
 export declare namespace GridLayout {
+  /**
+   * GridLayout 的布局参数。
+   */
   export class LayoutParams extends ViewGroup.MarginLayoutParams {}
 }

package/@types/GridLayoutAnimationController.d.ts

@@ -1,5 +1,8 @@
 import { LayoutAnimationController } from "./LayoutAnimationController";
 
+/**
+ * 网格布局动画控制器。
+ */
 export declare class GridLayoutAnimationController extends LayoutAnimationController {
 
 }

package/@types/GridView.d.ts

@@ -1,6 +1,9 @@
 import { ViewGroup } from "./ViewGroup";
 import { ListAdapter } from "./ListAdapter";
 
+/**
+ * 网格列表视图，以网格形式展示适配器数据。
+ */
 export declare class GridView extends ViewGroup {
   public getAdapter(): ListAdapter;
 

package/@types/HorizontalScrollView.ts

@@ -1,5 +1,8 @@
 import { FrameLayout } from "./FrameLayout";
 
+/**
+ * 水平滚动视图，可横向滚动显示超出范围的内容。
+ */
 export declare class HorizontalScrollView extends FrameLayout {
   public scrollTo(x:number, y:number) :void;
 

package/@types/Image.d.ts

@@ -0,0 +1,28 @@
+import { InterfaceTemplate } from "@compass-framework/library";
+import { Context } from "./Context";
+
+/**
+ * 位图图像，封装像素缓冲及其尺寸。
+ */
+export declare interface Image {
+  getWidth(): number;
+
+  getHeight(): number;
+
+  dispose(): void;
+}
+
+/**
+ * Image 接口的实现基类。
+ */
+export class Image extends InterfaceTemplate {}
+
+/**
+ * Image 工厂方法。
+ */
+export namespace Image {
+  /**
+   * 从 ArrayBuffer 创建 Image。
+   */
+  export function create(context: Context, arraybuffer: ArrayBuffer): Promise<Image>;
+}

package/@types/ImageDrawable.ts

@@ -0,0 +1,43 @@
+import { Drawable } from "./Drawable";
+import { Image } from "./Image";
+import { Canvas } from "./Canvas";
+import { Context } from "./Context";
+
+/**
+ * 图像 Drawable，将 Image 按重力对齐绘制到边界内。
+ */
+export declare abstract class ImageDrawable extends Drawable {
+  protected constructor(context: Context);
+  protected constructor(context: Context, imageState: ImageDrawable.ImageState);
+  protected constructor(context: Context, image: Image);
+
+  public draw(canvas: Canvas): void;
+
+  public getOpacity(): number;
+
+  public getImage(): Image;
+
+  public setImage(image: Image): void;
+
+  public setAlpha(alpha: number): void;
+
+  public setGravity(gravity: number): void;
+}
+
+/**
+ * ImageDrawable 相关嵌套类型。
+ */
+export declare namespace ImageDrawable {
+  /**
+   * ImageDrawable 的常量状态。
+   */
+  class ImageState extends Drawable.ConstantState {
+    public constructor(context: Context);
+    public constructor(context: Context, imageState: ImageState);
+    public constructor(context: Context, image: Image);
+
+    public newDrawable(): Drawable;
+
+    public getChangingConfigurations(): number;
+  }
+}

package/@types/ImageFilter.ts

@@ -0,0 +1,13 @@
+import { InterfaceTemplate } from "@compass-framework/library";
+
+/**
+ * 图像滤镜，用于对图层或绘制结果做效果处理。
+ */
+export interface ImageFilter {
+  dispose(): void;
+}
+
+/**
+ * ImageFilter 接口的实现基类。
+ */
+export abstract class ImageFilter extends InterfaceTemplate {}

package/@types/ImageView.d.ts

@@ -7,9 +7,15 @@ import {
   View,
 } from "./View";
 
+/**
+ * 图片视图，用于展示图像内容。
+ */
 export declare class ImageView extends View {}
 
 export declare namespace ImageView {
+  /**
+   * 图片更新通知接口，支持订阅与一次性回调。
+   */
   export interface UpdateNotification<S> {
     addNotification(c: Consumer<S>): void;
 
@@ -18,5 +24,8 @@ export declare namespace ImageView {
     removeNotification(c: Consumer<S>): void;
   }
 
+  /**
+   * UpdateNotification 的接口模板实现。
+   */
   export class UpdateNotification<S> extends InterfaceTemplate {}
 }

package/@types/InputMethodService.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 输入法服务抽象基类。
+ */
+export abstract class InputMethodService {
+
+}

package/@types/Interpolator.d.ts

@@ -4,8 +4,14 @@ import {
   TimeInterpolator,
 } from "./TimeInterpolator";
 
+/**
+ * 插值器接口。
+ */
 export declare interface Interpolator extends TimeInterpolator {
 }
 
+/**
+ * 插值器实现类。
+ */
 @Implements(TimeInterpolator)
 export declare class Interpolator extends InterfaceTemplate {}

package/@types/KeyEvent.d.ts

@@ -1,3 +1,6 @@
+/**
+ * 键盘按键事件及键码常量。
+ */
 export declare class KeyEvent {
   public static KEYCODE_ESCAPE:number;
   public static KEYCODE_F1:number;