sapdon 2.0.0

package/src/core/ui/Properties/Grid.js

@@ -0,0 +1,98 @@
+/**
+ * Grid 类
+ * 
+ * 该类表示一个网格控件，用于管理网格布局及其相关属性。
+ * 
+ * 属性：
+ * - grid_dimensions: Vector [columns, rows] - 网格的列数和行数
+ * - maximum_grid_items: int - 网格生成的最大项目数
+ * - grid_dimension_binding: string - 网格尺寸的绑定名称
+ * - grid_rescaling_type: enum - 网格重新缩放方向（可能值：vertical, horizontal, none，默认值：none）
+ * - grid_fill_direction: enum - 网格填充方向（可能值：vertical, horizontal, none，默认值：none）
+ * - grid_item_template: string - 处理集合的子元素名称（例如："common.container_item"）
+ * - precached_grid_item_count: int - 预缓存的网格项目数量
+ */
+
+export class Grid {
+    constructor() {
+        /*
+        this.grid_dimensions = null;
+        this.maximum_grid_items = 0;
+        this.grid_dimension_binding = '';
+        this.grid_rescaling_type = 'none';
+        this.grid_fill_direction = 'none';
+        this.grid_item_template = '';
+        this.precached_grid_item_count = 0;
+        */
+    }
+
+    /**
+     * 设置网格的列数和行数。
+     * @param {number[]} dimensions - 格式为 [columns, rows]
+     * @returns {Grid} 返回当前实例以支持链式调用
+     */
+    setGridDimensions(dimensions) {
+        this.grid_dimensions = dimensions;
+        return this;
+    }
+
+    /**
+     * 设置网格生成的最大项目数。
+     * @param {number} maxItems - 最大项目数
+     * @returns {Grid} 返回当前实例以支持链式调用
+     */
+    setMaximumGridItems(maxItems) {
+        this.maximum_grid_items = maxItems;
+        return this;
+    }
+
+    /**
+     * 设置网格尺寸的绑定名称。
+     * @param {string} binding - 绑定名称
+     * @returns {Grid} 返回当前实例以支持链式调用
+     */
+    setGridDimensionBinding(binding) {
+        this.grid_dimension_binding = binding;
+        return this;
+    }
+
+    /**
+     * 设置网格重新缩放方向。
+     * @param {string} type - 可能值：vertical, horizontal, none（默认值：none）
+     * @returns {Grid} 返回当前实例以支持链式调用
+     */
+    setGridRescalingType(type = 'none') {
+        this.grid_rescaling_type = type;
+        return this;
+    }
+
+    /**
+     * 设置网格填充方向。
+     * @param {string} direction - 可能值：vertical, horizontal, none（默认值：none）
+     * @returns {Grid} 返回当前实例以支持链式调用
+     */
+    setGridFillDirection(direction = 'none') {
+        this.grid_fill_direction = direction;
+        return this;
+    }
+
+    /**
+     * 设置处理集合的子元素名称。
+     * @param {string} template - 元素名称（例如："common.container_item"）
+     * @returns {Grid} 返回当前实例以支持链式调用
+     */
+    setGridItemTemplate(template) {
+        this.grid_item_template = template;
+        return this;
+    }
+
+    /**
+     * 设置预缓存的网格项目数量。
+     * @param {number} count - 预缓存数量
+     * @returns {Grid} 返回当前实例以支持链式调用
+     */
+    setPrecachedGridItemCount(count) {
+        this.precached_grid_item_count = count;
+        return this;
+    }
+}

package/src/core/ui/Properties/Input.js

@@ -0,0 +1,146 @@
+/**
+ * Input 类
+ * 
+ * 该类表示输入配置，用于管理 UI 元素的输入行为。
+ * 
+ * 属性：
+ * - button_mappings: Array of mapping objects - 按钮映射配置
+ * - modal: boolean - 是否为模态输入
+ * - inline_modal: boolean - 是否为内联模态输入
+ * - always_listen_to_input: boolean - 是否始终监听输入
+ * - always_handle_pointer: boolean - 是否始终处理指针事件
+ * - always_handle_controller_direction: boolean - 是否始终处理控制器方向事件
+ * - hover_enabled: boolean - 是否启用悬停事件
+ * - prevent_touch_input: boolean - 是否阻止触摸输入
+ * - consume_event: boolean - 是否消耗事件
+ * - consume_hover_events: boolean - 是否消耗悬停事件
+ * - gesture_tracking_button: string - 手势跟踪按钮
+ */
+
+export class Input {
+    constructor() {
+        /*
+        this.button_mappings = [];
+        this.modal = false;
+        this.inline_modal = false;
+        this.always_listen_to_input = false;
+        this.always_handle_pointer = false;
+        this.always_handle_controller_direction = false;
+        this.hover_enabled = false;
+        this.prevent_touch_input = false;
+        this.consume_event = false;
+        this.consume_hover_events = false;
+        this.gesture_tracking_button = '';
+        */
+    }
+
+    /**
+     * 设置按钮映射配置。
+     * @param {ButtonMapping[]} mappings - 按钮映射配置数组
+     * @returns {Input} 返回当前实例以支持链式调用
+     */
+    setButtonMappings(mappings) {
+        this.button_mappings = mappings;
+        return this;
+    }
+
+    /**
+     * 设置是否为模态输入。
+     * @param {boolean} modal - 是否为模态输入
+     * @returns {Input} 返回当前实例以支持链式调用
+     */
+    setModal(modal = false) {
+        this.modal = modal;
+        return this;
+    }
+
+    /**
+     * 设置是否为内联模态输入。
+     * @param {boolean} inlineModal - 是否为内联模态输入
+     * @returns {Input} 返回当前实例以支持链式调用
+     */
+    setInlineModal(inlineModal = false) {
+        this.inline_modal = inlineModal;
+        return this;
+    }
+
+    /**
+     * 设置是否始终监听输入。
+     * @param {boolean} alwaysListen - 是否始终监听输入
+     * @returns {Input} 返回当前实例以支持链式调用
+     */
+    setAlwaysListenToInput(alwaysListen = false) {
+        this.always_listen_to_input = alwaysListen;
+        return this;
+    }
+
+    /**
+     * 设置是否始终处理指针事件。
+     * @param {boolean} alwaysHandle - 是否始终处理指针事件
+     * @returns {Input} 返回当前实例以支持链式调用
+     */
+    setAlwaysHandlePointer(alwaysHandle = false) {
+        this.always_handle_pointer = alwaysHandle;
+        return this;
+    }
+
+    /**
+     * 设置是否始终处理控制器方向事件。
+     * @param {boolean} alwaysHandle - 是否始终处理控制器方向事件
+     * @returns {Input} 返回当前实例以支持链式调用
+     */
+    setAlwaysHandleControllerDirection(alwaysHandle = false) {
+        this.always_handle_controller_direction = alwaysHandle;
+        return this;
+    }
+
+    /**
+     * 设置是否启用悬停事件。
+     * @param {boolean} enabled - 是否启用悬停事件
+     * @returns {Input} 返回当前实例以支持链式调用
+     */
+    setHoverEnabled(enabled = false) {
+        this.hover_enabled = enabled;
+        return this;
+    }
+
+    /**
+     * 设置是否阻止触摸输入。
+     * @param {boolean} prevent - 是否阻止触摸输入
+     * @returns {Input} 返回当前实例以支持链式调用
+     */
+    setPreventTouchInput(prevent = false) {
+        this.prevent_touch_input = prevent;
+        return this;
+    }
+
+    /**
+     * 设置是否消耗事件。
+     * @param {boolean} consume - 是否消耗事件
+     * @returns {Input} 返回当前实例以支持链式调用
+     */
+    setConsumeEvent(consume = false) {
+        this.consume_event = consume;
+        return this;
+    }
+
+    /**
+     * 设置是否消耗悬停事件。
+     * @param {boolean} consume - 是否消耗悬停事件
+     * @returns {Input} 返回当前实例以支持链式调用
+     */
+    setConsumeHoverEvents(consume = false) {
+        this.consume_hover_events = consume;
+        return this;
+    }
+
+    /**
+     * 设置手势跟踪按钮。
+     * @param {string} button - 手势跟踪按钮
+     * @returns {Input} 返回当前实例以支持链式调用
+     */
+    setGestureTrackingButton(button) {
+        this.gesture_tracking_button = button;
+        return this;
+    }
+}

package/src/core/ui/Properties/Layout.js

@@ -0,0 +1,158 @@
+/**
+ * Layout 类
+ * 
+ * 该类表示一个具有各种属性和方法的 UI 布局元素，用于操作其布局和大小。
+ * 
+ * 属性：
+ * - size: Vector [width, height] - UI 元素的大小（默认值：["default", "default"]）
+ * - max_size: Vector [width, height] - UI 元素的最大大小（默认值：["default", "default"]）
+ * - min_size: Vector [width, height] - UI 元素的最小大小（默认值：["default", "default"]）
+ * - offset: Vector [x, y] - UI 元素相对于父元素的位置（默认值：[0, 0]）
+ * - anchor_from: enum - 父元素中的锚点（默认值：center）
+ * - anchor_to: enum - 元素自身的锚点（默认值：center）
+ * - inherit_max_sibling_width: boolean - 是否使用兄弟元素的最大宽度（默认值：false）
+ * - inherit_max_sibling_height: boolean - 是否使用兄弟元素的最大高度（默认值：false）
+ * - use_anchored_offset: boolean - 是否使用基于锚点的偏移（默认值：false）
+ * - contained: boolean - 是否限制元素在父元素边界内（默认值：false）
+ * - draggable: enum - 是否使元素可拖动（可能值：vertical, horizontal, both）
+ * - follows_cursor: boolean - 是否使元素跟随光标（默认值：false）
+ */
+
+export class Layout {
+    constructor() {
+        /*
+        this.size = ["default", "default"];
+        this.max_size = ["default", "default"];
+        this.min_size = ["default", "default"];
+        this.offset = [0, 0];
+        this.anchor_from = "center";
+        this.anchor_to = "center";
+        this.inherit_max_sibling_width = false;
+        this.inherit_max_sibling_height = false;
+        this.use_anchored_offset = false;
+        this.contained = false;
+        this.draggable = null;
+        this.follows_cursor = false;
+        */
+    }
+
+    /**
+     * 设置 UI 元素的大小。
+     * @param {any[]} size - 大小，格式为 [width, height]（默认值：["default", "default"]）
+     * @returns {Layout} 返回当前实例以支持链式调用
+     */
+    setSize(size = ["default", "default"]) {
+        this.size = size;
+        return this;
+    }
+
+    /**
+     * 设置 UI 元素的最大大小。
+     * @param {string[]} maxSize - 最大大小，格式为 [width, height]（默认值：["default", "default"]）
+     * @returns {Layout} 返回当前实例以支持链式调用
+     */
+    setMaxSize(maxSize = ["default", "default"]) {
+        this.max_size = maxSize;
+        return this;
+    }
+
+    /**
+     * 设置 UI 元素的最小大小。
+     * @param {string[]} minSize - 最小大小，格式为 [width, height]（默认值：["default", "default"]）
+     * @returns {Layout} 返回当前实例以支持链式调用
+     */
+    setMinSize(minSize = ["default", "default"]) {
+        this.min_size = minSize;
+        return this;
+    }
+
+    /**
+     * 设置 UI 元素相对于父元素的位置。
+     * @param {number[]} offset - 偏移量，格式为 [x, y]（默认值：[0, 0]）
+     * @returns {Layout} 返回当前实例以支持链式调用
+     */
+    setOffset(offset = [0, 0]) {
+        this.offset = offset;
+        return this;
+    }
+
+    /**
+     * 设置父元素中的锚点。
+     * @param {string} anchorFrom - 锚点（可能值：top_left, top_middle, top_right, left_middle, center, right_middle, bottom_left, bottom_middle, bottom_right）（默认值：center）
+     * @returns {Layout} 返回当前实例以支持链式调用
+     */
+    setAnchorFrom(anchorFrom = "center") {
+        this.anchor_from = anchorFrom;
+        return this;
+    }
+
+    /**
+     * 设置元素自身的锚点。
+     * @param {string} anchorTo - 锚点（可能值：top_left, top_middle, top_right, left_middle, center, right_middle, bottom_left, bottom_middle, bottom_right）（默认值：center）
+     * @returns {Layout} 返回当前实例以支持链式调用
+     */
+    setAnchorTo(anchorTo = "center") {
+        this.anchor_to = anchorTo;
+        return this;
+    }
+
+    /**
+     * 设置是否使用兄弟元素的最大宽度。
+     * @param {boolean} inherit - 是否使用兄弟元素的最大宽度（默认值：false）
+     * @returns {Layout} 返回当前实例以支持链式调用
+     */
+    setInheritMaxSiblingWidth(inherit = false) {
+        this.inherit_max_sibling_width = inherit;
+        return this;
+    }
+
+    /**
+     * 设置是否使用兄弟元素的最大高度。
+     * @param {boolean} inherit - 是否使用兄弟元素的最大高度（默认值：false）
+     * @returns {Layout} 返回当前实例以支持链式调用
+     */
+    setInheritMaxSiblingHeight(inherit = false) {
+        this.inherit_max_sibling_height = inherit;
+        return this;
+    }
+
+    /**
+     * 设置是否使用基于锚点的偏移。
+     * @param {boolean} use - 是否使用基于锚点的偏移（默认值：false）
+     * @returns {Layout} 返回当前实例以支持链式调用
+     */
+    setUseAnchoredOffset(use = false) {
+        this.use_anchored_offset = use;
+        return this;
+    }
+
+    /**
+     * 设置是否限制元素在父元素边界内。
+     * @param {boolean} contained - 是否限制元素在父元素边界内（默认值：false）
+     * @returns {Layout} 返回当前实例以支持链式调用
+     */
+    setContained(contained = false) {
+        this.contained = contained;
+        return this;
+    }
+
+    /**
+     * 设置是否使元素可拖动。
+     * @param {string} draggable - 是否使元素可拖动（可能值：vertical, horizontal, both）
+     * @returns {Layout} 返回当前实例以支持链式调用
+     */
+    setDraggable(draggable) {
+        this.draggable = draggable;
+        return this;
+    }
+
+    /**
+     * 设置是否使元素跟随光标。
+     * @param {boolean} follows - 是否使元素跟随光标（默认值：false）
+     * @returns {Layout} 返回当前实例以支持链式调用
+     */
+    setFollowsCursor(follows = false) {
+        this.follows_cursor = follows;
+        return this;
+    }
+}

package/src/core/ui/Properties/ScrollView.js

@@ -0,0 +1,158 @@
+/**
+ * ScrollView 类
+ * 
+ * 该类表示一个滚动视图控件，用于管理滚动行为及其相关属性。
+ * 
+ * 属性：
+ * - scrollbar_track_button: string - 滚动条轨道按钮的 ID
+ * - scrollbar_touch_button: string - 滚动条触摸按钮的 ID
+ * - scroll_speed: number - 滚动速度
+ * - gesture_control_enabled: boolean - 是否启用手势控制
+ * - always_handle_scrolling: boolean - 是否始终处理滚动
+ * - touch_mode: boolean - 是否启用触摸模式
+ * - scrollbar_box: string - 滚动条滑块子元素的名称
+ * - scrollbar_track: string - 滚动条轨道子元素的名称
+ * - scroll_view_port: string - 视口子元素的名称
+ * - scroll_content: string - 内容根父元素的名称
+ * - scroll_box_and_track_panel: string - 包含滚动条滑块和轨道的子元素名称
+ * - jump_to_bottom_on_update: boolean - 是否在更新时跳转到底部
+ */
+
+export class ScrollView {
+    constructor() {
+        /*
+        this.scrollbar_track_button = '';
+        this.scrollbar_touch_button = '';
+        this.scroll_speed = null;
+        this.gesture_control_enabled = false;
+        this.always_handle_scrolling = false;
+        this.touch_mode = false;
+        this.scrollbar_box = '';
+        this.scrollbar_track = '';
+        this.scroll_view_port = '';
+        this.scroll_content = '';
+        this.scroll_box_and_track_panel = '';
+        this.jump_to_bottom_on_update = false;
+        */
+    }
+
+    /**
+     * 设置滚动条轨道按钮的 ID。
+     * @param {string} buttonId - 滚动条轨道按钮的 ID
+     * @returns {ScrollView} 返回当前实例以支持链式调用
+     */
+    setScrollbarTrackButton(buttonId) {
+        this.scrollbar_track_button = buttonId;
+        return this;
+    }
+
+    /**
+     * 设置滚动条触摸按钮的 ID。
+     * @param {string} buttonId - 滚动条触摸按钮的 ID
+     * @returns {ScrollView} 返回当前实例以支持链式调用
+     */
+    setScrollbarTouchButton(buttonId) {
+        this.scrollbar_touch_button = buttonId;
+        return this;
+    }
+
+    /**
+     * 设置滚动速度。
+     * @param {number} speed - 滚动速度
+     * @returns {ScrollView} 返回当前实例以支持链式调用
+     */
+    setScrollSpeed(speed) {
+        this.scroll_speed = speed;
+        return this;
+    }
+
+    /**
+     * 设置是否启用手势控制。
+     * @param {boolean} enabled - 是否启用手势控制（默认值：false）
+     * @returns {ScrollView} 返回当前实例以支持链式调用
+     */
+    setGestureControlEnabled(enabled = false) {
+        this.gesture_control_enabled = enabled;
+        return this;
+    }
+
+    /**
+     * 设置是否始终处理滚动。
+     * @param {boolean} alwaysHandle - 是否始终处理滚动（默认值：false）
+     * @returns {ScrollView} 返回当前实例以支持链式调用
+     */
+    setAlwaysHandleScrolling(alwaysHandle = false) {
+        this.always_handle_scrolling = alwaysHandle;
+        return this;
+    }
+
+    /**
+     * 设置是否启用触摸模式。
+     * @param {boolean} touchMode - 是否启用触摸模式（默认值：false）
+     * @returns {ScrollView} 返回当前实例以支持链式调用
+     */
+    setTouchMode(touchMode = false) {
+        this.touch_mode = touchMode;
+        return this;
+    }
+
+    /**
+     * 设置滚动条滑块子元素的名称。
+     * @param {string} boxName - 滚动条滑块子元素的名称
+     * @returns {ScrollView} 返回当前实例以支持链式调用
+     */
+    setScrollbarBox(boxName) {
+        this.scrollbar_box = boxName;
+        return this;
+    }
+
+    /**
+     * 设置滚动条轨道子元素的名称。
+     * @param {string} trackName - 滚动条轨道子元素的名称
+     * @returns {ScrollView} 返回当前实例以支持链式调用
+     */
+    setScrollbarTrack(trackName) {
+        this.scrollbar_track = trackName;
+        return this;
+    }
+
+    /**
+     * 设置视口子元素的名称。
+     * @param {string} viewPortName - 视口子元素的名称
+     * @returns {ScrollView} 返回当前实例以支持链式调用
+     */
+    setScrollViewPort(viewPortName) {
+        this.scroll_view_port = viewPortName;
+        return this;
+    }
+
+    /**
+     * 设置内容根父元素的名称。
+     * @param {string} contentName - 内容根父元素的名称
+     * @returns {ScrollView} 返回当前实例以支持链式调用
+     */
+    setScrollContent(contentName) {
+        this.scroll_content = contentName;
+        return this;
+    }
+
+    /**
+     * 设置包含滚动条滑块和轨道的子元素名称。
+     * @param {string} panelName - 包含滚动条滑块和轨道的子元素名称
+     * @returns {ScrollView} 返回当前实例以支持链式调用
+     */
+    setScrollBoxAndTrackPanel(panelName) {
+        this.scroll_box_and_track_panel = panelName;
+        return this;
+    }
+
+    /**
+     * 设置是否在更新时跳转到底部。
+     * @param {boolean} jump - 是否在更新时跳转到底部（默认值：false）
+     * @returns {ScrollView} 返回当前实例以支持链式调用
+     */
+    setJumpToBottomOnUpdate(jump = false) {
+        this.jump_to_bottom_on_update = jump;
+        return this;
+    }
+}