mirror of
https://gitee.com/openharmony/interface_sdk-js
synced 2024-11-27 01:11:35 +00:00
1829 lines
53 KiB
TypeScript
1829 lines
53 KiB
TypeScript
/*
|
|
* Copyright (c) 2023 Huawei Device Co., Ltd.
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
* @kit ArkUI
|
|
*/
|
|
|
|
import { UIContext } from '../@ohos.arkui.UIContext';
|
|
import { RenderNode } from './RenderNode';
|
|
import { Size, Position, Edges, LengthMetrics, SizeT } from './Graphics';
|
|
import { DrawContext } from './Graphics';
|
|
import { ComponentContent } from './ComponentContent';
|
|
|
|
/**
|
|
* Layout constraint, include the max size, the min size and the reference size for children to calculate percent.
|
|
*
|
|
* @interface LayoutConstraint
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
declare interface LayoutConstraint {
|
|
/**
|
|
* MaxSize
|
|
*
|
|
* @type { Size }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
maxSize: Size;
|
|
|
|
/**
|
|
* MinSize
|
|
*
|
|
* @type { Size }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
minSize: Size;
|
|
|
|
/**
|
|
* PercentReference, if the size unit of the child nodes is percentage, then they use PercentReference to calculate
|
|
* the px size.
|
|
*
|
|
* @type { Size }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
percentReference: Size;
|
|
}
|
|
|
|
/**
|
|
* Defines FrameNode.
|
|
*
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 11
|
|
*/
|
|
/**
|
|
* Defines FrameNode.
|
|
*
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
export class FrameNode {
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param { UIContext } uiContext - uiContext used to create the FrameNode
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 11
|
|
*/
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @param { UIContext } uiContext - uiContext used to create the FrameNode
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
constructor(uiContext: UIContext);
|
|
|
|
/**
|
|
* Get the RenderNode in FrameNode.
|
|
*
|
|
* @returns { RenderNode | null } - Returns a RenderNode inside the FrameNode, or null if not contained.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @since 11
|
|
*/
|
|
/**
|
|
* Get the RenderNode in FrameNode.
|
|
*
|
|
* @returns { RenderNode | null } - Returns a RenderNode inside the FrameNode, or null if not contained.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getRenderNode(): RenderNode | null;
|
|
|
|
/**
|
|
* Return a flag to indicate whether the current FrameNode can be modified. Indicates whether the FrameNode supports appendChild, insertChildAfter, removeChild, clearChildren.
|
|
*
|
|
* @returns { boolean } - Returns true if the FrameNode can be modified, otherwise return false.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
isModifiable(): boolean;
|
|
|
|
/**
|
|
* Add child to the end of the FrameNode's children.
|
|
*
|
|
* @param { FrameNode } node - The node will be added.
|
|
* @throws { BusinessError } 100021 - The FrameNode is not modifiable.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
appendChild(node: FrameNode): void;
|
|
|
|
/**
|
|
* Add child to the current FrameNode.
|
|
*
|
|
* @param { FrameNode } child - The node will be added.
|
|
* @param { FrameNode | null } sibling - The new node is added after this node. When sibling is null, insert node as the first children of the node.
|
|
* @throws { BusinessError } 100021 - The FrameNode is not modifiable.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
insertChildAfter(child: FrameNode, sibling: FrameNode | null): void;
|
|
|
|
/**
|
|
* Remove child from the current FrameNode.
|
|
*
|
|
* @param { FrameNode } node - The node will be removed.
|
|
* @throws { BusinessError } 100021 - The FrameNode is not modifiable.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
removeChild(node: FrameNode): void;
|
|
|
|
/**
|
|
* Clear children of the current FrameNode.
|
|
*
|
|
* @throws { BusinessError } 100021 - The FrameNode is not modifiable.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
clearChildren(): void;
|
|
|
|
/**
|
|
* Get a child of the current FrameNode by index.
|
|
*
|
|
* @param { number } index - The index of the desired node in the children of FrameNode.
|
|
* @returns { FrameNode | null } - Returns a FrameNode. When the required node does not exist, returns null.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getChild(index: number): FrameNode | null;
|
|
|
|
/**
|
|
* Get the first child of the current FrameNode.
|
|
*
|
|
* @returns { FrameNode | null } - Returns a FrameNode, which is first child of the current FrameNode. If current FrameNode does not have child node, returns null.
|
|
* If current FrameNode does not have child node, returns null.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getFirstChild(): FrameNode | null;
|
|
|
|
/**
|
|
* Get the next sibling node of the current FrameNode.
|
|
*
|
|
* @returns { FrameNode | null } - Returns a FrameNode. If current FrameNode does not have next sibling node, returns null.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getNextSibling(): FrameNode | null;
|
|
|
|
/**
|
|
* Get the previous sibling node of the current FrameNode.
|
|
*
|
|
* @returns { FrameNode | null } - Returns a FrameNode. If current FrameNode does not have previous sibling node, returns null.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getPreviousSibling(): FrameNode | null;
|
|
|
|
/**
|
|
* Get the parent node of the current FrameNode.
|
|
*
|
|
* @returns { FrameNode | null } - Returns a FrameNode. If current FrameNode does not have parent node, returns null.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getParent(): FrameNode | null;
|
|
|
|
/**
|
|
* Get the children count of the current FrameNode.
|
|
*
|
|
* @returns { number } - Returns the number of the children of the current FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getChildrenCount(): number;
|
|
|
|
/**
|
|
* Dispose the FrameNode immediately.
|
|
*
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
dispose(): void;
|
|
|
|
/**
|
|
* Get the position of the node relative to window.
|
|
*
|
|
* @returns { Position } - Returns position of the node relative to window.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getPositionToWindow(): Position;
|
|
|
|
/**
|
|
* Get the position of the node relative to its parent.
|
|
*
|
|
* @returns { Position } - Returns position of the node relative to its parent.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getPositionToParent(): Position;
|
|
|
|
/**
|
|
* Get the size of the FrameNode after measure, with unit PX.
|
|
*
|
|
* @returns { Size } - Returns the size of the FrameNode after measure, with unit PX.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getMeasuredSize(): Size;
|
|
|
|
/**
|
|
* Get the offset to the parent of the FrameNode after layout, with unit PX.
|
|
*
|
|
* @returns { Position } - Returns the offset to the parent of the FrameNode after layout, with unit PX.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getLayoutPosition(): Position;
|
|
|
|
/**
|
|
* Get the user config border width of the FrameNode.
|
|
*
|
|
* @returns { Edges<LengthMetrics> } - Returns the user config border width of the FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getUserConfigBorderWidth(): Edges<LengthMetrics>;
|
|
|
|
/**
|
|
* Get the user config padding of the FrameNode.
|
|
*
|
|
* @returns { Edges<LengthMetrics> } - Returns the user config padding of the FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getUserConfigPadding(): Edges<LengthMetrics>;
|
|
|
|
/**
|
|
* Get the user config margin of the FrameNode.
|
|
*
|
|
* @returns { Edges<LengthMetrics> } - Returns the user config margin of the FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getUserConfigMargin(): Edges<LengthMetrics>;
|
|
|
|
/**
|
|
* Get the user config size of the FrameNode.
|
|
*
|
|
* @returns { SizeT<LengthMetrics> } - Returns the user config size of the FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getUserConfigSize(): SizeT<LengthMetrics>;
|
|
|
|
/**
|
|
* Get the id of the FrameNode.
|
|
*
|
|
* @returns { string } - Returns the id of the FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getId(): string;
|
|
|
|
/**
|
|
* Get the unique id of the FrameNode.
|
|
*
|
|
* @returns { number } - Returns the unique id of the FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getUniqueId(): number;
|
|
|
|
/**
|
|
* Get the type of the FrameNode. The type is the name of component, for example, the nodeType of Button is "Button",
|
|
* and the nodeType of custom component is "__Common__".
|
|
*
|
|
* @returns { string } - Returns the type of the FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getNodeType(): string;
|
|
|
|
/**
|
|
* Get the opacity of the FrameNode.
|
|
*
|
|
* @returns { number } - Returns the opacity of the FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getOpacity(): number;
|
|
|
|
/**
|
|
* Get if the FrameNode is visible.
|
|
*
|
|
* @returns { boolean } - Returns if the FrameNode is visible.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
isVisible(): boolean;
|
|
|
|
/**
|
|
* Get if the FrameNode is clip to frame.
|
|
*
|
|
* @returns { boolean } - Returns if the FrameNode is clip to frame.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
isClipToFrame(): boolean;
|
|
|
|
/**
|
|
* Get if the FrameNode is attached.
|
|
*
|
|
* @returns { boolean } - Returns if the FrameNode is attached.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
isAttached(): boolean;
|
|
|
|
/**
|
|
* Get the inspector information of the FrameNode.
|
|
*
|
|
* @returns { Object } - Returns the inspector information of the FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getInspectorInfo(): Object;
|
|
|
|
/**
|
|
* * Get the custom property of the component corresponding to this FrameNode.
|
|
*
|
|
* @param { string } name - the name of the custom property.
|
|
* @returns { Object | undefined } - Returns the value of the custom property.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getCustomProperty(name: string): Object | undefined;
|
|
|
|
/**
|
|
* Set commonEvent response to the current FrameNode.
|
|
*
|
|
* @returns { UICommonEvent } - Returns a Object inside the FrameNode, which is used to set callbacks about different events.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
get commonEvent(): UICommonEvent;
|
|
|
|
/**
|
|
* Get gestureEvent of the current FrameNode.
|
|
*
|
|
* @returns { UIGestureEvent } - Returns a Object inside the FrameNode, which is used to set callbacks about different gesture events.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
get gestureEvent(): UIGestureEvent;
|
|
|
|
/**
|
|
* Get the CommonAttribute of the current FrameNode.
|
|
*
|
|
* @returns { CommonAttribute } - Returns the CommonAttribute which is used to modify the common attributes of the FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
get commonAttribute(): CommonAttribute;
|
|
|
|
/**
|
|
* Draw Method. Executed when the current FrameNode is rendering its content.
|
|
*
|
|
* @param { DrawContext } context - The DrawContext will be used when executed draw method.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
onDraw?(context: DrawContext): void;
|
|
|
|
/**
|
|
* Method to measure the FrameNode and its content to determine the measured size. Use this method to override the
|
|
* default measure method when measuring the FrameNode.
|
|
*
|
|
* @param { LayoutConstraint } constraint - The layout constraint of the node, will be used when executed measure
|
|
* method.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
onMeasure(constraint: LayoutConstraint): void;
|
|
|
|
/**
|
|
* Method to assign a position to the FrameNode and each of its children. Use this method to override the
|
|
* default layout method.
|
|
*
|
|
* @param { Position } position - The position of the node, will be used when executed layout method.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
onLayout(position: Position): void;
|
|
|
|
/**
|
|
* Set the size of the FrameNode after measure, with unit PX.
|
|
*
|
|
* @param { Size } size - The size of the FrameNode after measure.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
setMeasuredSize(size: Size): void;
|
|
|
|
/**
|
|
* Set the position to the parent of the FrameNode after layout, with unit PX.
|
|
*
|
|
* @param { Position } position - The position to the parent of the FrameNode after layout.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
setLayoutPosition(position: Position): void;
|
|
|
|
/**
|
|
* This is called to find out how big the FrameNode should be. The parent node supplies constraint information. The
|
|
* actual measurement work of the FrameNode is performed in onMeasure or the default measure method.
|
|
*
|
|
* @param { LayoutConstraint } constraint - The layout constraint of the node, supplied by the parent node.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
measure(constraint: LayoutConstraint): void;
|
|
|
|
/**
|
|
* This is called to assign position to the FrameNode and all of its descendants. The position is used to init
|
|
* the position of the frameNode, and the actual layout work of FrameNode is performed in onLayout or the default
|
|
* layout method.
|
|
*
|
|
* @param { Position } position - The position of the node, will be used when executed the layout method.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
layout(position: Position): void;
|
|
|
|
/**
|
|
* Mark the frame node as need layout.
|
|
*
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
setNeedsLayout(): void;
|
|
|
|
/**
|
|
* Invalidate the RenderNode in the FrameNode, which will cause a re-render of the RenderNode.
|
|
*
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
invalidate(): void;
|
|
|
|
/**
|
|
* Get the position of the node relative to screen.
|
|
*
|
|
* @returns { Position } - Returns position of the node relative to screen.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getPositionToScreen(): Position;
|
|
|
|
/**
|
|
* Get the position of the node relative to window with transform.
|
|
*
|
|
* @returns { Position } - Returns position of the node relative to window with transform.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getPositionToWindowWithTransform(): Position;
|
|
|
|
/**
|
|
* Get the position of the node relative to its parent with transform.
|
|
*
|
|
* @returns { Position } - Returns position of the node relative to its parent with transform.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getPositionToParentWithTransform(): Position;
|
|
|
|
/**
|
|
* Get the position of the node relative to screen with transform.
|
|
*
|
|
* @returns { Position } - Returns position of the node relative to screen with transform.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getPositionToScreenWithTransform(): Position;
|
|
|
|
/**
|
|
* Detach from parent and dispose all child recursively.
|
|
*
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
disposeTree(): void;
|
|
|
|
/**
|
|
* Mount ComponentContent to FrameNode.
|
|
*
|
|
* @param { ComponentContent<T> } content - Newly added ComponentContent.
|
|
* @throws { BusinessError } 100021 - The FrameNode is not modifiable.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
addComponentContent<T>(content: ComponentContent<T>): void;
|
|
}
|
|
|
|
/**
|
|
* Used to define the FrameNode type.
|
|
*
|
|
* @interface TypedFrameNode
|
|
* @extends FrameNode
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
export interface TypedFrameNode<C, T> extends FrameNode {
|
|
/**
|
|
* Initialize FrameNode.
|
|
*
|
|
* @type { C }
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
initialize: C;
|
|
/**
|
|
* Get attribute instance of FrameNode to set attributes.
|
|
*
|
|
* @type { T }
|
|
* @readonly
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
readonly attribute: T;
|
|
}
|
|
|
|
/**
|
|
* Provides methods to implement FrameNode.
|
|
*
|
|
* @namespace typeNode
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
export namespace typeNode {
|
|
/**
|
|
* Define the FrameNode type for Text.
|
|
*
|
|
* @typedef { TypedFrameNode<TextInterface, TextAttribute> } Text
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type Text = TypedFrameNode<TextInterface, TextAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Text type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Text' } nodeType - node type.
|
|
* @returns { Text } - Return Text type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Text'): Text;
|
|
|
|
/**
|
|
* Define the FrameNode type for Column.
|
|
*
|
|
* @typedef { TypedFrameNode<ColumnInterface, ColumnAttribute> } Column
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type Column = TypedFrameNode<ColumnInterface, ColumnAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Column type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Column' } nodeType - node type.
|
|
* @returns { Column } - Return Column type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Column'): Column;
|
|
|
|
/**
|
|
* Define the FrameNode type for Row.
|
|
*
|
|
* @typedef { TypedFrameNode<RowInterface, RowAttribute> } Row
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type Row = TypedFrameNode<RowInterface, RowAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Row type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Row' } nodeType - node type.
|
|
* @returns { Row } - Return Row type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Row'): Row;
|
|
|
|
/**
|
|
* Define the FrameNode type for Stack.
|
|
*
|
|
* @typedef { TypedFrameNode<StackInterface, StackAttribute> } Stack
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type Stack = TypedFrameNode<StackInterface, StackAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Stack type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Stack' } nodeType - node type.
|
|
* @returns { Stack } - Return Stack type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Stack'): Stack;
|
|
|
|
/**
|
|
* Define the FrameNode type for GridRow.
|
|
*
|
|
* @typedef { TypedFrameNode<GridRowInterface, GridRowAttribute> } GridRow
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type GridRow = TypedFrameNode<GridRowInterface, GridRowAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of GridRow type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'GridRow' } nodeType - node type.
|
|
* @returns { GridRow } - Return GridRow type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'GridRow'): GridRow;
|
|
|
|
/**
|
|
* Define the FrameNode type for GridCol.
|
|
*
|
|
* @typedef { TypedFrameNode<GridColInterface, GridColAttribute> } GridCol
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type GridCol = TypedFrameNode<GridColInterface, GridColAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of GridCol type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'GridCol' } nodeType - node type.
|
|
* @returns { GridCol } - Return GridCol type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'GridCol'): GridCol;
|
|
|
|
/**
|
|
* Define the FrameNode type for Flex.
|
|
*
|
|
* @typedef { TypedFrameNode<FlexInterface, FlexAttribute> } Flex
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type Flex = TypedFrameNode<FlexInterface, FlexAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Flex type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Flex' } nodeType - node type.
|
|
* @returns { Flex } - Return Flex type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Flex'): Flex;
|
|
|
|
/**
|
|
* Define the FrameNode type for Swiper.
|
|
*
|
|
* @typedef { TypedFrameNode<SwiperInterface, SwiperAttribute> } Swiper
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type Swiper = TypedFrameNode<SwiperInterface, SwiperAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Swiper type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Swiper' } nodeType - node type.
|
|
* @returns { Swiper } - Return Swiper type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Swiper'): Swiper;
|
|
|
|
/**
|
|
* Define the FrameNode type for Progress.
|
|
*
|
|
* @typedef { TypedFrameNode<ProgressInterface, ProgressAttribute> } Progress
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type Progress = TypedFrameNode<ProgressInterface, ProgressAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Progress type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Progress' } nodeType - node type.
|
|
* @returns { Progress } - Return Progress type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Progress'): Progress;
|
|
|
|
/**
|
|
* Define the FrameNode type for Scroll.
|
|
*
|
|
* @typedef { TypedFrameNode<ScrollInterface, ScrollAttribute> } Scroll
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type Scroll = TypedFrameNode<ScrollInterface, ScrollAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Scroll type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Scroll' } nodeType - node type.
|
|
* @returns { Scroll } - Return Scroll type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Scroll'): Scroll;
|
|
|
|
/**
|
|
* Define the FrameNode type for RelativeContainer.
|
|
*
|
|
* @typedef { TypedFrameNode<RelativeContainerInterface, RelativeContainerAttribute> } RelativeContainer
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type RelativeContainer = TypedFrameNode<RelativeContainerInterface, RelativeContainerAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of RelativeContainer type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'RelativeContainer' } nodeType - node type.
|
|
* @returns { RelativeContainer } - Return RelativeContainer type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'RelativeContainer'): RelativeContainer;
|
|
|
|
/**
|
|
* Define the FrameNode type for Divider.
|
|
*
|
|
* @typedef { TypedFrameNode<DividerInterface, DividerAttribute> } Divider
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type Divider = TypedFrameNode<DividerInterface, DividerAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Divider type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Divider' } nodeType - node type.
|
|
* @returns { Divider } - Return Divider type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Divider'): Divider;
|
|
|
|
/**
|
|
* Define the FrameNode type for LoadingProgress.
|
|
*
|
|
* @typedef { TypedFrameNode<LoadingProgressInterface, LoadingProgressAttribute> } LoadingProgress
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type LoadingProgress = TypedFrameNode<LoadingProgressInterface, LoadingProgressAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of LoadingProgress type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'LoadingProgress' } nodeType - node type.
|
|
* @returns { LoadingProgress } - Return LoadingProgress type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'LoadingProgress'): LoadingProgress;
|
|
|
|
/**
|
|
* Define the FrameNode type for Search.
|
|
*
|
|
* @typedef { TypedFrameNode<SearchInterface, SearchAttribute> } Search
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type Search = TypedFrameNode<SearchInterface, SearchAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Search type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Search' } nodeType - node type.
|
|
* @returns { Search } - Return Search type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Search'): Search;
|
|
|
|
/**
|
|
* Define the FrameNode type for Blank.
|
|
*
|
|
* @typedef { TypedFrameNode<BlankInterface, BlankAttribute> } Blank
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type Blank = TypedFrameNode<BlankInterface, BlankAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Blank type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Blank' } nodeType - node type.
|
|
* @returns { Blank } - Return Blank type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Blank'): Blank;
|
|
|
|
/**
|
|
* Define the FrameNode type for Image.
|
|
*
|
|
* @typedef { TypedFrameNode<ImageInterface, ImageAttribute> } Image
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type Image = TypedFrameNode<ImageInterface, ImageAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Image type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Image' } nodeType - node type.
|
|
* @returns { Image } - Return Image type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Image'): Image;
|
|
|
|
/**
|
|
* Define the FrameNode type for List.
|
|
*
|
|
* @typedef { TypedFrameNode<ListInterface, ListAttribute> } List
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type List = TypedFrameNode<ListInterface, ListAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of List type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'List' } nodeType - node type.
|
|
* @returns { List } - Return List type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'List'): List;
|
|
|
|
/**
|
|
* Define the FrameNode type for ListItem.
|
|
*
|
|
* @typedef { TypedFrameNode<ListItemInterface, ListItemAttribute> } ListItem
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type ListItem = TypedFrameNode<ListItemInterface, ListItemAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of ListItem type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'ListItem' } nodeType - node type.
|
|
* @returns { ListItem } - Return ListItem type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'ListItem'): ListItem;
|
|
|
|
/**
|
|
* Define the FrameNode type for TextInput.
|
|
*
|
|
* @typedef { TypedFrameNode<TextInputInterface, TextInputAttribute> } TextInput
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type TextInput = TypedFrameNode<TextInputInterface, TextInputAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of TextInput type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'TextInput' } nodeType - node type.
|
|
* @returns { TextInput } - Return TextInput type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'TextInput'): TextInput;
|
|
|
|
/**
|
|
* Define the FrameNode type for Button.
|
|
*
|
|
* @typedef { TypedFrameNode<ButtonInterface, ButtonAttribute> } Button
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type Button = TypedFrameNode<ButtonInterface, ButtonAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Button type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Button' } nodeType - node type.
|
|
* @returns { Button } - Return Button type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Button'): Button;
|
|
|
|
/**
|
|
* Define the FrameNode type for ListItemGroup.
|
|
*
|
|
* @typedef { TypedFrameNode<ListItemGroupInterface, ListItemGroupAttribute> } ListItemGroup
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type ListItemGroup = TypedFrameNode<ListItemGroupInterface, ListItemGroupAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of ListItemGroup type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'ListItemGroup' } nodeType - node type.
|
|
* @returns { ListItemGroup } - Return ListItemGroup type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'ListItemGroup'): ListItemGroup;
|
|
|
|
/**
|
|
* Define the FrameNode type for WaterFlow.
|
|
*
|
|
* @typedef { TypedFrameNode<WaterFlowInterface, WaterFlowAttribute> } WaterFlow
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type WaterFlow = TypedFrameNode<WaterFlowInterface, WaterFlowAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of WaterFlow type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'WaterFlow' } nodeType - node type.
|
|
* @returns { WaterFlow } - Return WaterFlow type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'WaterFlow'): WaterFlow;
|
|
|
|
/**
|
|
* Define the FrameNode type for FlowItem.
|
|
*
|
|
* @typedef { TypedFrameNode<FlowItemInterface, FlowItemAttribute> } FlowItem
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type FlowItem = TypedFrameNode<FlowItemInterface, FlowItemAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of FlowItem type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'FlowItem' } nodeType - node type.
|
|
* @returns { FlowItem } - Return FlowItem type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'FlowItem'): FlowItem;
|
|
|
|
/**
|
|
* Define the FrameNode type for XComponent.
|
|
*
|
|
* @typedef { TypedFrameNode<XComponentInterface, XComponentAttribute> } XComponent
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
type XComponent = TypedFrameNode<XComponentInterface, XComponentAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of XComponent type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'XComponent' } nodeType - node type.
|
|
* @returns { XComponent } - Return XComponent type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'XComponent'): XComponent;
|
|
|
|
/**
|
|
* Create a FrameNode of XComponent type with options.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'XComponent' } nodeType - node type.
|
|
* @param { XComponentOptions } options - initialization parameters.
|
|
* @returns { XComponent } - Return XComponent type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'XComponent', options: XComponentOptions): XComponent;
|
|
|
|
/**
|
|
* Define the FrameNode type for Checkbox.
|
|
*
|
|
* @typedef { TypedFrameNode<CheckboxInterface, CheckboxAttribute> } Checkbox
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
type Checkbox = TypedFrameNode<CheckboxInterface, CheckboxAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Checkbox type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Checkbox' } nodeType - node type.
|
|
* @returns { Checkbox } - Return Checkbox type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Checkbox'): Checkbox;
|
|
|
|
/**
|
|
* Define the FrameNode type for CheckboxGroup.
|
|
*
|
|
* @typedef { TypedFrameNode<CheckboxGroupInterface, CheckboxGroupAttribute> } CheckboxGroup
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
type CheckboxGroup = TypedFrameNode<CheckboxGroupInterface, CheckboxGroupAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of CheckboxGroup type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'CheckboxGroup' } nodeType - node type.
|
|
* @returns { CheckboxGroup } - Return CheckboxGroup type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'CheckboxGroup'): CheckboxGroup;
|
|
|
|
/**
|
|
* Define the FrameNode type for Radio.
|
|
*
|
|
* @typedef { TypedFrameNode<RadioInterface, RadioAttribute> } Radio
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
type Radio = TypedFrameNode<RadioInterface, RadioAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Radio type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Radio' } nodeType - node type.
|
|
* @returns { Radio } - Return Radio type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Radio'): Radio;
|
|
|
|
/**
|
|
* Define the FrameNode type for Rating.
|
|
*
|
|
* @typedef { TypedFrameNode<RatingInterface, RatingAttribute> } Rating
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
type Rating = TypedFrameNode<RatingInterface, RatingAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Rating type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Rating' } nodeType - node type.
|
|
* @returns { Rating } - Return Rating type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Rating'): Rating;
|
|
|
|
/**
|
|
* Define the FrameNode type for Select.
|
|
*
|
|
* @typedef { TypedFrameNode<SelectInterface, SelectAttribute> } Select
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
type Select = TypedFrameNode<SelectInterface, SelectAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Select type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Select' } nodeType - node type.
|
|
* @returns { Select } - Return Select type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Select'): Select;
|
|
|
|
/**
|
|
* Define the FrameNode type for Slider.
|
|
*
|
|
* @typedef { TypedFrameNode<SliderInterface, SliderAttribute> } Slider
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
type Slider = TypedFrameNode<SliderInterface, SliderAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Slider type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Slider' } nodeType - node type.
|
|
* @returns { Slider } - Return Slider type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Slider'): Slider;
|
|
|
|
/**
|
|
* Define the FrameNode type for Toggle.
|
|
*
|
|
* @typedef { TypedFrameNode<ToggleInterface, ToggleAttribute> } Toggle
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
type Toggle = TypedFrameNode<ToggleInterface, ToggleAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Toggle type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Toggle' } nodeType - node type.
|
|
* @param { ToggleOptions } options - ToggleOptions.
|
|
* @returns { Toggle } - Return Toggle type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Toggle', options?: ToggleOptions): Toggle;
|
|
|
|
/**
|
|
* Define the FrameNode type for Marquee.
|
|
*
|
|
* @typedef { TypedFrameNode<MarqueeInterface, MarqueeAttribute> } Marquee
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
type Marquee = TypedFrameNode<MarqueeInterface, MarqueeAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Marquee type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Marquee' } nodeType - node type.
|
|
* @returns { Marquee } - Return Marquee type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Marquee'): Marquee;
|
|
|
|
/**
|
|
* Define the FrameNode type for TextArea.
|
|
*
|
|
* @typedef { TypedFrameNode<TextAreaInterface, TextAreaAttribute> } TextArea
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
type TextArea = TypedFrameNode<TextAreaInterface, TextAreaAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of TextArea type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'TextArea' } nodeType - node type.
|
|
* @returns { TextArea } - Return TextArea type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'TextArea'): TextArea;
|
|
|
|
/**
|
|
* Define the FrameNode type for SymbolGlyph.
|
|
*
|
|
* @typedef { TypedFrameNode<SymbolGlyphInterface, SymbolGlyphAttribute> } SymbolGlyph
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
type SymbolGlyph = TypedFrameNode<SymbolGlyphInterface, SymbolGlyphAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of SymbolGlyph type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'SymbolGlyph' } nodeType - node type.
|
|
* @returns { SymbolGlyph } - Return SymbolGlyph type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 13
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'SymbolGlyph'): SymbolGlyph;
|
|
|
|
/**
|
|
* Define the FrameNode type for QRCode.
|
|
*
|
|
* @typedef { TypedFrameNode<QRCodeInterface, QRCodeAttribute> } QRCode
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
type QRCode = TypedFrameNode<QRCodeInterface, QRCodeAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of QRCode type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'QRCode' } nodeType - node type.
|
|
* @returns { QRCode } - Return QRCode type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'QRCode'): QRCode;
|
|
|
|
/**
|
|
* Define the FrameNode type for Badge.
|
|
*
|
|
* @typedef { TypedFrameNode<BadgeInterface, BadgeAttribute> } Badge
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
type Badge = TypedFrameNode<BadgeInterface, BadgeAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Badge type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Badge' } nodeType - node type.
|
|
* @returns { Badge } - Return Badge type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Badge'): Badge;
|
|
|
|
/**
|
|
* Define the FrameNode type for TextClock.
|
|
*
|
|
* @typedef { TypedFrameNode<TextClockInterface, TextClockAttribute> } TextClock
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
type TextClock = TypedFrameNode<TextClockInterface, TextClockAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of TextClock type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'TextClock' } nodeType - node type.
|
|
* @returns { TextClock } - Return TextClock type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'TextClock'): TextClock;
|
|
|
|
/**
|
|
* Define the FrameNode type for TextTimer.
|
|
*
|
|
* @typedef { TypedFrameNode<TextTimerInterface, TextTimerAttribute> } TextTimer
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
type TextTimer = TypedFrameNode<TextTimerInterface, TextTimerAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of TextTimer type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'TextTimer' } nodeType - node type.
|
|
* @returns { TextTimer } - Return TextTimer type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'TextTimer'): TextTimer;
|
|
|
|
/**
|
|
* Define the FrameNode type for Grid.
|
|
*
|
|
* @typedef { TypedFrameNode<GridInterface, GridAttribute> } Grid
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
type Grid = TypedFrameNode<GridInterface, GridAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of Grid type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'Grid' } nodeType - node type.
|
|
* @returns { Grid } - Return Grid type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'Grid'): Grid;
|
|
|
|
/**
|
|
* Define the FrameNode type for GridItem.
|
|
*
|
|
* @typedef { TypedFrameNode<GridItemInterface, GridItemAttribute> } GridItem
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
type GridItem = TypedFrameNode<GridItemInterface, GridItemAttribute>;
|
|
|
|
/**
|
|
* Create a FrameNode of GridItem type.
|
|
*
|
|
* @param { UIContext } context - uiContext used to create the FrameNode.
|
|
* @param { 'GridItem' } nodeType - node type.
|
|
* @returns { GridItem } - Return GridItem type FrameNode.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @atomicservice
|
|
* @since 14
|
|
*/
|
|
function createNode(context: UIContext, nodeType: 'GridItem'): GridItem;
|
|
}
|
|
|
|
/**
|
|
* Used for lazy loading of typeNode.
|
|
*
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
declare class NodeAdapter {
|
|
/**
|
|
* Constructor.
|
|
*
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
constructor();
|
|
/**
|
|
* Dispose the NodeAdapter immediately.
|
|
*
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
dispose(): void;
|
|
/**
|
|
* Set the total number of node count.
|
|
*
|
|
* @param { number } count - The total number of node count.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
set totalNodeCount(count: number);
|
|
/**
|
|
* Get the total number of node count.
|
|
*
|
|
* @returns { number } - Return the total number of node count.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
get totalNodeCount(): number;
|
|
/**
|
|
* Define the operation of reloading all data.
|
|
*
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
reloadAllItems(): void;
|
|
/**
|
|
* Define the data reload operation.Reload a specified amount of data starting from the index value.
|
|
*
|
|
* @param { number } start - Start loading index values for data.
|
|
* @param { number } count - Load the number of data.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
reloadItem(start: number, count: number): void;
|
|
/**
|
|
* Define data deletion operations.Delete a specified amount of data starting from the index value.
|
|
*
|
|
* @param { number } start - Start deleting index values for data.
|
|
* @param { number } count - Delete the number of data.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
removeItem(start: number, count: number): void;
|
|
/**
|
|
* Define data insertion operations.Insert a specified amount of data starting from the index value.
|
|
*
|
|
* @param { number } start - Start Insert index values for data.
|
|
* @param { number } count - Insert the number of data.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
insertItem(start: number, count: number): void;
|
|
/**
|
|
* Define data movement operations. Move data from the starting index to the ending index.
|
|
*
|
|
* @param { number } from - Starting index value.
|
|
* @param { number } to - End index value.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
moveItem(from: number, to: number): void;
|
|
/**
|
|
* Obtain all data results.
|
|
*
|
|
* @returns { Array<FrameNode> } - Return all valid FrameNode collections.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
getAllAvailableItems(): Array<FrameNode>;
|
|
/**
|
|
* This callback will be triggered when a FrameNode is bound.
|
|
*
|
|
* @param { FrameNode } target - The bound FrameNode node.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
onAttachToNode?(target: FrameNode): void;
|
|
/**
|
|
* This callback will be triggered when the binding is released.
|
|
*
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
onDetachFromNode?(): void;
|
|
/**
|
|
* Call this callback when loading for the first time or when a new node slides in.Used to generate custom IDs, developers need to ensure the uniqueness of the IDs themselves.
|
|
*
|
|
* @param { number } index - Load the index value of the data.
|
|
* @returns { number } - Returning the developer's custom ID requires the developer to ensure its uniqueness.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
onGetChildId?(index: number): number;
|
|
/**
|
|
* Call this callback when loading for the first time or when a new node slides in.
|
|
*
|
|
* @param { number } index - Load the index value of the data.
|
|
* @returns { FrameNode } - Returns the FrameNode node that loads the node.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
onCreateChild?(index: number): FrameNode;
|
|
/**
|
|
* Called when the child node is about to be destroyed.
|
|
*
|
|
* @param { number } id - The child node ID that is about to be destroyed.
|
|
* @param { FrameNode } node - The FrameNode node that is about to be destroyed.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
onDisposeChild?(id: number, node: FrameNode): void;
|
|
/**
|
|
* Call this callback when reloading or reusing.
|
|
*
|
|
* @param { number } id - The index value of the reloaded data.
|
|
* @param { FrameNode } node - Reused FrameNode nodes.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
onUpdateChild?(id: number, node: FrameNode): void;
|
|
/**
|
|
* Add a NodeAdapter to bind to the node.A node can only be bound to one NodeAdapter. Binding failure returns false.
|
|
*
|
|
* @param { NodeAdapter } adapter - Define lazy loading classes.
|
|
* @param { FrameNode } node - The bound FrameNode node.
|
|
* @returns { boolean } Return the binding result.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
static attachNodeAdapter(adapter: NodeAdapter, node: FrameNode): boolean;
|
|
/**
|
|
* Remove the bound NodeAdapter from the node.A node can only be bound to one NodeAdapter.
|
|
*
|
|
* @param { FrameNode } node - Unbind the FrameNode node.
|
|
* @syscap SystemCapability.ArkUI.ArkUI.Full
|
|
* @crossplatform
|
|
* @atomicservice
|
|
* @since 12
|
|
*/
|
|
static detachNodeAdapter(node: FrameNode): void;
|
|
} |