@compass-framework/core 1.2.56 → 1.2.58

package/@types/View.d.ts

@@ -25,6 +25,9 @@ import { ViewOutlineProvider } from "./ViewOutlineProvider";
 import { DisplayMetrics } from "./DisplayMetrics";
 import { IWindow } from "./IWindow";
 
+/**
+ * 基础视图，负责测量、布局、绘制与事件分发。
+ */
 export declare class View implements Drawable.Callback {
   public static resolveSize(size: number, measureSpec: number): number;
   public static getMode(measureSpec: number): number;
@@ -256,6 +259,9 @@ export declare class View implements Drawable.Callback {
 }
 
 export declare namespace View {
+  /**
+   * 按圆角半径生成视图轮廓的 OutlineProvider。
+   */
   export class ViewRadiusOutlineProvider extends ViewOutlineProvider {
     public constructor(view: View, ltr: number, lbr: number, rtr: number, rbr: number);
 
@@ -274,6 +280,9 @@ export declare namespace View {
     public setRightTopRadius(value: number): void;
   }
 
+  /**
+   * 视图附着窗口时的临时绘制与变换信息。
+   */
   export class AttachInfo {
     public getTransparentLocation(): Array<number>;
 
@@ -292,6 +301,9 @@ export declare namespace View {
     public getTransformation(): Transformation;
   }
 
+  /**
+   * 测量规格工具，编码尺寸与测量模式。
+   */
   export class MeasureSpec {
     public static MODE_SHIFT: number;
     public static MODE_MASK: number;
@@ -310,50 +322,104 @@ export declare namespace View {
     public static adjust(measureSpec: number, delta: number): number;
   }
 
+  /**
+   * 视图附着/分离窗口状态变化监听器。
+   */
   export interface OnAttachStateChangeListener {
     onViewAttachedToWindow(v: View): void;
 
     onViewDetachedFromWindow(v: View): void;
   }
+  /**
+   * OnAttachStateChangeListener 的接口模板实现。
+   */
   export class OnAttachStateChangeListener extends InterfaceTemplate {}
 
+  /**
+   * 触摸事件监听器。
+   */
   export interface OnTouchListener {
     onTouch(v: View, event: MotionEvent): boolean;
   }
+  /**
+   * OnTouchListener 的接口模板实现。
+   */
   export class OnTouchListener extends InterfaceTemplate {}
 
+  /**
+   * 点击事件监听器。
+   */
   export interface OnClickListener {
     onClick(v: View): void;
   }
+  /**
+   * OnClickListener 的接口模板实现。
+   */
   export class OnClickListener extends InterfaceTemplate {}
 
+  /**
+   * 悬停事件监听器。
+   */
   export interface OnHoverListener {
     onHover(v: View, event: MotionEvent): boolean;
   }
+  /**
+   * OnHoverListener 的接口模板实现。
+   */
   export class OnHoverListener extends InterfaceTemplate {}
 
+  /**
+   * 按键事件监听器。
+   */
   export interface OnKeyListener {
     onKey(v: View, keyCode: number, event: KeyEvent): boolean;
   }
+  /**
+   * OnKeyListener 的接口模板实现。
+   */
   export class OnKeyListener extends InterfaceTemplate {}
 
+  /**
+   * 焦点变化监听器。
+   */
   export interface OnFocusChangeListener {
     onFocusChange(v: View, hasFocus: boolean): void;
   }
+  /**
+   * OnFocusChangeListener 的接口模板实现。
+   */
   export class OnFocusChangeListener extends InterfaceTemplate {}
 
+  /**
+   * 通用运动事件监听器。
+   */
   export interface OnGenericMotionListener {
     onGenericMotion(v: View, event: MotionEvent): boolean;
   }
+  /**
+   * OnGenericMotionListener 的接口模板实现。
+   */
   export class OnGenericMotionListener extends InterfaceTemplate {}
 
+  /**
+   * 布局尺寸或位置变化监听器。
+   */
   export interface OnLayoutChangeListener {
     onLayoutChange(v: View, left: number, top: number, right: number, bottom: number, oldLeft: number, oldTop: number, oldRight: number, oldBottom: number):void;
   }
+  /**
+   * OnLayoutChangeListener 的接口模板实现。
+   */
   export class OnLayoutChangeListener extends InterfaceTemplate {}
 
+  /**
+   * 视图完成 inflate 后的回调监听器。
+   */
   export interface OnFinishInflateListener {
     onViewFinishInflate(v: View): void;
   }
+  /**
+   * OnFinishInflateListener 的接口模板实现。
+   */
   export class OnFinishInflateListener extends InterfaceTemplate {}
 }

package/@types/ViewGroup.d.ts

@@ -6,6 +6,9 @@ import { ViewParent } from "./ViewParent";
 import { MotionEvent } from "./MotionEvent";
 import { DisplayMetrics } from "./DisplayMetrics";
 
+/**
+ * 视图组，可容纳并管理子视图的测量、布局与触摸分发。
+ */
 @Implements(ViewParent)
 export declare abstract class ViewGroup extends View implements ViewParent {
   public static FLAG_USE_CHILD_DRAWING_ORDER: number;
@@ -58,6 +61,9 @@ export declare abstract class ViewGroup extends View implements ViewParent {
 }
 
 export declare namespace ViewGroup {
+  /**
+   * 子视图布局参数，描述宽高约束。
+   */
   class LayoutParams {
     public static MATCH_PARENT: number;
     public static WRAP_CONTENT: number;
@@ -83,6 +89,9 @@ export declare namespace ViewGroup {
     public setHeight(height: number): void;
   }
 
+  /**
+   * 带外边距的布局参数。
+   */
   class MarginLayoutParams extends LayoutParams {
     public setLeftMargin(margin: number): void;
 

package/@types/ViewGroupOverlay.d.ts

@@ -2,6 +2,9 @@ import { ViewOverlay } from "./ViewOverlay";
 import { Drawable } from "./Drawable";
 import { View } from "./View";
 
+/**
+ * 视图组叠加层，可叠加 Drawable 或子视图。
+ */
 export declare class ViewGroupOverlay extends ViewOverlay {
   public add(drawable: Drawable): void;
   public add(view: View): void;

package/@types/ViewOutlineProvider.d.ts

@@ -1,6 +1,9 @@
 import { Outline } from "./Outline";
 import { View } from "./View";
 
+/**
+ * 视图轮廓提供者，为裁剪与阴影提供 Outline。
+ */
 export declare abstract class ViewOutlineProvider {
   public static BACKGROUND: ViewOutlineProvider;
 

package/@types/ViewOverlay.d.ts

@@ -1,6 +1,9 @@
 import { Drawable } from "./Drawable";
 import { ViewGroup } from "./ViewGroup";
 
+/**
+ * 视图叠加层，用于在视图之上绘制额外 Drawable。
+ */
 export declare class ViewOverlay {
   public add(drawable: Drawable): void;
 

package/@types/ViewParent.d.ts

@@ -1,9 +1,15 @@
 import { InterfaceTemplate, Nullable } from "@compass-framework/library";
 
+/**
+ * 视图父节点接口，提供层级关系与触摸拦截控制。
+ */
 export interface ViewParent {
   getParent(): Nullable<ViewParent>;
 
   requestDisallowInterceptTouchEvent(disallowIntercept: boolean): void
 }
 
+/**
+ * ViewParent 的接口模板实现。
+ */
 export class ViewParent extends InterfaceTemplate {}

package/@types/ViewSlot.d.ts

@@ -3,6 +3,9 @@ import { FrameLayout } from "./FrameLayout";
 import { Slot } from "./Slot";
 import { View } from "./View";
 
+/**
+ * 视图插槽容器，可替换内部目标视图。
+ */
 @Implements(Slot)
 export declare class ViewSlot extends FrameLayout implements Slot {
   replace(target: View, options?: Slot.Options): void;

package/@types/ViewTreeObserver.d.ts

@@ -2,6 +2,9 @@ import { InterfaceTemplate } from "@compass-framework/library";
 import { View } from "./View";
 import { MotionEvent } from "./MotionEvent";
 
+/**
+ * 视图树观察者，监听全局布局、绘制前与焦点/触摸变化。
+ */
 export declare class ViewTreeObserver {
   public addOnGlobalLayoutListener(listener: ViewTreeObserver.OnGlobalLayoutListener) :void;
 
@@ -21,23 +24,47 @@ export declare class ViewTreeObserver {
 }
 
 export declare namespace ViewTreeObserver {
+  /**
+   * 全局布局完成监听器。
+   */
   export interface OnGlobalLayoutListener {
     onGlobalLayout(): void;
   }
+  /**
+   * OnGlobalLayoutListener 的接口模板实现。
+   */
   export class OnGlobalLayoutListener extends InterfaceTemplate {}
 
+  /**
+   * 绘制前回调监听器。
+   */
   export interface OnPreDrawListener {
     onPreDraw(): boolean;
   }
+  /**
+   * OnPreDrawListener 的接口模板实现。
+   */
   export class OnPreDrawListener extends InterfaceTemplate {}
 
+  /**
+   * 全局触摸事件监听器。
+   */
   export interface OnGlobalTouchEventListener {
     onGlobalTouch(ev: MotionEvent): void
   }
+  /**
+   * OnGlobalTouchEventListener 的接口模板实现。
+   */
   export class OnGlobalTouchEventListener extends InterfaceTemplate {}
 
+  /**
+   * 全局焦点变化监听器。
+   */
   export interface OnGlobalFocusChangeListener {
     onGlobalFocusChanged(oldFocus: View, newFocus: View): void;
   }
+  /**
+   * OnGlobalFocusChangeListener 的接口模板实现。
+   */
   export class OnGlobalFocusChangeListener extends InterfaceTemplate {}
 }

package/@types/{IWindow.d.ts → Window.d.ts}

@@ -2,10 +2,13 @@ import { ArrayList, InterfaceTemplate, XML } from "@compass-framework/library";
 import { Resources } from "./Resources";
 import { View } from "./View";
 import { ViewGroup } from "./ViewGroup";
-import { WindowContext } from "./WindowContext";
 import { WindowManager } from "./WindowManager";
+import { Context } from "./Context";
 
-export interface IWindow {
+/**
+ * 窗口契约，定义内容视图与生命周期回调。
+ */
+export interface Window {
   findViewsByTag(tag: string): ArrayList<View>;
 
   findViewByTag(tag: string): View;
@@ -21,7 +24,7 @@ export interface IWindow {
 
   getLayoutParams(): WindowManager.LayoutParams;
 
-  getWindowContext(): WindowContext;
+  getContext(): Context;
 
   getDecorView(): ViewGroup;
 
@@ -34,6 +37,9 @@ export interface IWindow {
   setContentXML(xml: XML): void;
 }
 
-export class IWindow extends InterfaceTemplate {
+/**
+ * Window 接口的实现基类。
+ */
+export class Window extends InterfaceTemplate {
 
 }

package/@types/WindowManager.d.ts

@@ -1,17 +1,25 @@
 import { ViewGroup } from "./ViewGroup";
-import { IWindow } from "./IWindow";
 
+/**
+ * 窗口管理器，负责添加、移除与更新窗口布局。
+ */
 export declare class WindowManager {
-  public attachWindow(window: IWindow): void;
-  public attachWindow(window: IWindow, params: WindowManager.LayoutParams): void;
+  public addWindow(window: Window): void;
+  public addWindow(window: Window, params: WindowManager.LayoutParams): void;
 
-  public detachWindow(window: IWindow): void;
+  public removeWindow(window: Window): void;
 
-  public updateWindowLayout(window: IWindow): void;
-  public updateWindowLayout(window: IWindow, params: WindowManager.LayoutParams): void;
+  public updateWindowLayout(window: Window): void;
+  public updateWindowLayout(window: Window, params: WindowManager.LayoutParams): void;
 }
 
+/**
+ * WindowManager 相关布局参数类型。
+ */
 export declare namespace WindowManager {
+  /**
+   * 窗口布局参数，控制层级、透明度与对齐。
+   */
   export class LayoutParams extends ViewGroup.LayoutParams {
     public static TYPE_APPLICATION_ATTACHED_DIALOG: number;
 

package/@types/XMLLayoutParser.d.ts

@@ -2,6 +2,9 @@ import { Context } from "./Context";
 import { View } from "./View";
 import { ViewGroup } from "./ViewGroup";
 
+/**
+ * XML 布局解析器，将布局 XML 解析为视图。
+ */
 export declare class XMLLayoutParser {
   public static from(context: Context): XMLLayoutParser;
 

package/@types/XMLResourcesParser.d.ts

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

package/@types/XMLViewFactoryRegistry.d.ts

@@ -3,6 +3,9 @@ import { Context } from "./Context";
 import { View } from "./View";
 import { AttributeSet } from "./AttributeSet";
 
+/**
+ * XML 视图工厂注册表，按标签名创建视图实例。
+ */
 export declare class XMLViewFactoryRegistry {
   public registryViewFactory<T extends View>(name: string, factory: XMLViewFactoryRegistry.Factory<T>, overwrite?: boolean): XMLViewFactoryRegistry;
 
@@ -21,15 +24,27 @@ export declare class XMLViewFactoryRegistry {
   public getDefaultAttribute(attr?: XMLViewFactoryRegistry.Attribute): XMLViewFactoryRegistry.Attribute;
 }
 
+/**
+ * XMLViewFactoryRegistry 相关工厂与属性类型。
+ */
 export declare namespace XMLViewFactoryRegistry {
+  /**
+   * 默认属性键值映射。
+   */
   export type Attribute = { [key: string]: string };
 
+  /**
+   * XML 视图工厂接口。
+   */
   export interface Factory<T extends View> {
     onRegistry(context: Context): void;
 
     getView(context: Context, attrs: AttributeSet): T;
   }
 
+  /**
+   * 基于类的默认视图工厂。
+   */
   export class ViewFactory<T extends View> implements Factory<T> {
     public constructor(clazz:Class<View>);
 
@@ -38,6 +53,9 @@ export declare namespace XMLViewFactoryRegistry {
     public getView(context: Context, attrs: AttributeSet): T;
   }
 
+  /**
+   * 基于回调的自定义视图工厂。
+   */
   export class CustomFactory<T extends View> implements Factory<T> {
     public constructor(callback: BiFunction<Context, AttributeSet, View>);
 

package/index.d.ts

@@ -1,113 +1,111 @@
-export * from "./@types/AbsoluteLayout";
-export * from "./@types/ApplicationFrame";
-export * from "./@types/AccelerateDecelerateInterpolator";
-export * from "./@types/AccelerateInterpolator";
-export * from "./@types/Adapter";
-export * from "./@types/Animation";
-export * from "./@types/AnimationSet";
-export * from "./@types/Assets";
-export * from "./@types/Animator";
-export * from "./@types/Application";
-export * from "./@types/ApplicationContext";
-export * from "./@types/ApplicationBoot";
-export * from "./@types/ApplicationManifest";
-export * from "./@types/ApplicationWindow";
-export * from "./@types/ListAdapter";
-export * from "./@types/ArrayAdapter";
-export * from "./@types/BaseAdapter";
-export * from "./@types/AttributeSet";
-export * from "./@types/Bitmap";
-export * from "./@types/BitmapDrawable";
-export * from "./@types/BounceInterpolator";
-export * from "./@types/Button";
-export * from "./@types/Canvas";
-export * from "./@types/Color";
-export * from "./@types/Context";
-export * from "./@types/ContextUtils";
-export * from "./@types/CycleInterpolator";
-export * from "./@types/ColorDrawable";
-export * from "./@types/LayerDrawable";
-export * from "./@types/DecelerateInterpolator";
-export * from "./@types/Drawable";
-export * from "./@types/Editable";
-export * from "./@types/EditText";
-export * from "./@types/FrameLayout";
-export * from "./@types/Gravity";
-export * from "./@types/GridLayout";
-export * from "./@types/GridLayoutAnimationController";
-export * from "./@types/GridView";
-export * from "./@types/ICursor";
-export * from "./@types/ImageView";
-export * from "./@types/Interpolator";
-export * from "./@types/IWindow";
-export * from "./@types/KeyEvent";
-export * from "./@types/LayoutAnimationController";
-export * from "./@types/LinearGradient";
-export * from "./@types/LinearInterpolator";
-export * from "./@types/LinearLayout";
-export * from "./@types/ListView";
-export * from "./@types/Matrix";
-export * from "./@types/MotionEvent";
-export * from "./@types/Paint";
-export * from "./@types/Path";
-export * from "./@types/Picture";
-export * from "./@types/PictureDrawable";
-export * from "./@types/PopupWindow";
-export * from "./@types/PropertyValuesHolder";
-export * from "./@types/Rect";
-export * from "./@types/RelativeLayout";
-export * from "./@types/Resources";
-export * from "./@types/Readying";
-export * from "./@types/RotateAnimation";
-export * from "./@types/CornersDrawable";
-export * from './@types/Slot';
-export * from './@types/ViewSlot';
-export * from "./@types/Theme";
-export * from "./@types/ScaleAnimation";
-export * from "./@types/ScrollView";
-export * from "./@types/Shader";
-export * from "./@types/Shadow";
-export * from "./@types/StackLayout";
-export * from "./@types/TableLayout";
-export * from "./@types/TabBarLayout";
-export * from "./@types/TableRow";
-export * from "./@types/TextView";
-export * from "./@types/TimeInterpolator";
-export * from "./@types/Transformation";
-export * from "./@types/TranslateAnimation";
-export * from "./@types/TypeEvaluator";
-export * from "./@types/Typeface";
-export * from "./@types/TypefaceFactory";
-export * from "./@types/ValueAnimator";
-export * from "./@types/View";
-export * from "./@types/ViewGroup";
-export * from "./@types/ViewParent";
-export * from "./@types/WindowContext";
-export * from "./@types/WindowManager";
-export * from "./@types/ApplicationFrameObserver";
-export * from "./@types/HorizontalScrollView";
-export * from "./@types/XMLLayoutParser";
-export * from "./@types/XMLViewFactoryRegistry";
-export * from "./@types/XMLResourcesParser";
-export * from "./@types/DoubleClick";
-export * from "./@types/DoubleClickListener";
-export * from "./@types/Outline";
-export * from "./@types/ViewOutlineProvider";
-export * from "./@types/ViewTreeObserver";
-export * from "./@types/FreezeLayoutViewGroup";
-export * from "./@types/FreezeAbsoluteLayout";
-export * from "./@types/ViewOverlay";
-export * from "./@types/ViewGroupOverlay";
-export * from './@types/LayoutInflater';
-export * from './@types/PathEffect';
-export * from './@types/Configuration';
-export * from './@types/CornerPathEffect';
-export * from './@types/ApplicationFrameContext';
-export * from './@types/ResourcesInflater';
-export * from './@types/ApplicationFrameSettings';
-export * from './@types/EditRichText';
-export * from './@types/InputMethodServer';
-export * from './@types/Environment';
-export * from './@types/Resolver';
-export * from "./@types/PixelFormat"
-export * from "./@types/DisplayMetrics"
+export * from "./@types/AbsoluteLayout";
+export * from "./@types/AccelerateDecelerateInterpolator";
+export * from "./@types/AccelerateInterpolator";
+export * from "./@types/Adapter";
+export * from "./@types/AlphaAnimation";
+export * from "./@types/Animation";
+export * from "./@types/AnimationSet";
+export * from "./@types/Animator";
+export * from "./@types/Application";
+export * from "./@types/ApplicationWindow";
+export * from "./@types/ArrayAdapter";
+export * from "./@types/Assets";
+export * from "./@types/AttributeSet";
+export * from "./@types/BaseAdapter";
+export * from "./@types/BlendMode";
+export * from "./@types/BounceInterpolator";
+export * from "./@types/Button";
+export * from "./@types/Canvas";
+export * from "./@types/Color";
+export * from "./@types/ColorDrawable";
+export * from "./@types/ColorFilter";
+export * from "./@types/Configuration";
+export * from "./@types/Context";
+export * from "./@types/ContextUtils";
+export * from "./@types/CornerPathEffect";
+export * from "./@types/CornersDrawable";
+export * from "./@types/CycleInterpolator";
+export * from "./@types/DecelerateInterpolator";
+export * from "./@types/DisplayMetrics";
+export * from "./@types/DoubleClick";
+export * from "./@types/DoubleClickListener";
+export * from "./@types/Drawable";
+export * from "./@types/Editable";
+export * from "./@types/EditRichText";
+export * from "./@types/EditText";
+export * from "./@types/Environment";
+export * from "./@types/FrameLayout";
+export * from "./@types/FreezeAbsoluteLayout";
+export * from "./@types/FreezeLayoutViewGroup";
+export * from "./@types/Gravity";
+export * from "./@types/GridLayout";
+export * from "./@types/GridLayoutAnimationController";
+export * from "./@types/GridView";
+export * from "./@types/HorizontalScrollView";
+export * from "./@types/Image";
+export * from "./@types/ImageDrawable";
+export * from "./@types/ImageFilter";
+export * from "./@types/ImageView";
+export * from "./@types/InputMethodService";
+export * from "./@types/Interpolator";
+export * from "./@types/KeyEvent";
+export * from "./@types/LayerDrawable";
+export * from "./@types/LayoutAnimationController";
+export * from "./@types/LayoutInflater";
+export * from "./@types/LinearGradient";
+export * from "./@types/LinearGradientDrawable";
+export * from "./@types/LinearInterpolator";
+export * from "./@types/LinearLayout";
+export * from "./@types/ListAdapter";
+export * from "./@types/ListView";
+export * from "./@types/Matrix";
+export * from "./@types/MotionEvent";
+export * from "./@types/MouseCursor";
+export * from "./@types/Outline";
+export * from "./@types/Paint";
+export * from "./@types/Path";
+export * from "./@types/PathEffect";
+export * from "./@types/Picture";
+export * from "./@types/PictureDrawable";
+export * from "./@types/PixelFormat";
+export * from "./@types/PopupWindow";
+export * from "./@types/PropertyValuesHolder";
+export * from "./@types/Rect";
+export * from "./@types/RelativeLayout";
+export * from "./@types/RendererBackend";
+export * from "./@types/Resolver";
+export * from "./@types/Resources";
+export * from "./@types/ResourcesInflater";
+export * from "./@types/RotateAnimation";
+export * from "./@types/ScaleAnimation";
+export * from "./@types/ScrollView";
+export * from "./@types/Shader";
+export * from "./@types/Shadow";
+export * from "./@types/Slot";
+export * from "./@types/Surface";
+export * from "./@types/SurfaceProvider";
+export * from "./@types/TabBarLayout";
+export * from "./@types/TableLayout";
+export * from "./@types/TableRow";
+export * from "./@types/TextView";
+export * from "./@types/Theme";
+export * from "./@types/TimeInterpolator";
+export * from "./@types/Transformation";
+export * from "./@types/TranslateAnimation";
+export * from "./@types/TypeEvaluator";
+export * from "./@types/Typeface";
+export * from "./@types/TypefaceFactory";
+export * from "./@types/ValueAnimator";
+export * from "./@types/View";
+export * from "./@types/ViewGroup";
+export * from "./@types/ViewGroupOverlay";
+export * from "./@types/ViewOutlineProvider";
+export * from "./@types/ViewOverlay";
+export * from "./@types/ViewParent";
+export * from "./@types/ViewSlot";
+export * from "./@types/ViewTreeObserver";
+export * from "./@types/Window";
+export * from "./@types/WindowManager";
+export * from "./@types/XMLLayoutParser";
+export * from "./@types/XMLResourcesParser";
+export * from "./@types/XMLViewFactoryRegistry";