Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Widget

Stores and manipulate the anchoring based on its parent. Widget are used for GUI but can also be used for other things. Widget will adjust current node's position and size automatically, but the results after adjustment can not be obtained until the next frame unless you call updateAlignment manually.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • newWidget(name?: string): Widget

Properties

Private _alignFlags

_alignFlags: number = 0

Private _alignMode

_alignMode: AlignMode = AlignMode.ON_WINDOW_RESIZE

Private _bottom

_bottom: number = 0

_dirty

_dirty: boolean = true

Private _enabled

_enabled: boolean = true

Private _horizontalCenter

_horizontalCenter: number = 0

Private _id

_id: string = idGenerator.getNewId()

For internal usage.

Private _isAbsBottom

_isAbsBottom: boolean = true

Private _isAbsHorizontalCenter

_isAbsHorizontalCenter: boolean = true

Private _isAbsLeft

_isAbsLeft: boolean = true

Private _isAbsRight

_isAbsRight: boolean = true

Private _isAbsTop

_isAbsTop: boolean = true

Private _isAbsVerticalCenter

_isAbsVerticalCenter: boolean = true

_lastPos

_lastPos: Vec3 = new Vec3()

_lastSize

_lastSize: Size = new Size()

Private _left

_left: number = 0

Private _lockFlags

_lockFlags: number = 0

Protected _name

_name: string

_objFlags

_objFlags: number

Private _originalHeight

_originalHeight: number = 0

Private _originalWidth

_originalWidth: number = 0

Private _right

_right: number = 0

Private sceneGetter

sceneGetter: null | (() => RenderScene) = null

Private _target

_target: Node | null = null

Private _top

_top: number = 0

Private _verticalCenter

_verticalCenter: number = 0

node

node: Node = NullNode

The node this component is attached to. A component is always attached to a node.

example
import { log } from 'cc';
log(comp.node);

Static AlignMode

AlignMode: EnumAlias<typeof AlignMode> = AlignMode

Static system

system: null = null

Accessors

scriptAsset

  • get scriptAsset(): null

isOnLoadCalled

  • get isOnLoadCalled(): number

alignFlags

  • get alignFlags(): number
  • set alignFlags(value: number): void

alignMode

  • Specifies the alignment mode of the Widget, which determines when the widget should refresh.

    example
    import { Widget } from 'cc';
    widget.alignMode = Widget.AlignMode.ON_WINDOW_RESIZE;

    Returns AlignMode

  • Specifies the alignment mode of the Widget, which determines when the widget should refresh.

    example
    import { Widget } from 'cc';
    widget.alignMode = Widget.AlignMode.ON_WINDOW_RESIZE;

    Parameters

    Returns void

bottom

  • get bottom(): number
  • set bottom(value: number): void
  • The margins between the bottom of this node and the bottom of parent node, the value can be negative, Only available in 'isAlignBottom' open.

    Returns number

  • The margins between the bottom of this node and the bottom of parent node, the value can be negative, Only available in 'isAlignBottom' open.

    Parameters

    • value: number

    Returns void

editorBottom

  • get editorBottom(): number
  • set editorBottom(value: number): void

editorHorizontalCenter

  • get editorHorizontalCenter(): number
  • set editorHorizontalCenter(value: number): void

editorLeft

  • get editorLeft(): number
  • set editorLeft(value: number): void

editorRight

  • get editorRight(): number
  • set editorRight(value: number): void

editorTop

  • get editorTop(): number
  • set editorTop(value: number): void

editorVerticalCenter

  • get editorVerticalCenter(): number
  • set editorVerticalCenter(value: number): void

enabled

  • get enabled(): boolean
  • set enabled(value: boolean): void

enabledInHierarchy

  • get enabledInHierarchy(): boolean

horizontalCenter

  • get horizontalCenter(): number
  • set horizontalCenter(value: number): void
  • Horizontally aligns the midpoint offset value, the value can be negative, Only available in 'isAlignHorizontalCenter' open.

    Returns number

  • Horizontally aligns the midpoint offset value, the value can be negative, Only available in 'isAlignHorizontalCenter' open.

    Parameters

    • value: number

    Returns void

isAbsoluteBottom

  • get isAbsoluteBottom(): boolean
  • set isAbsoluteBottom(value: boolean): void
  • If true, bottom is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's height.

    Returns boolean

  • If true, bottom is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's height.

    Parameters

    • value: boolean

    Returns void

isAbsoluteHorizontalCenter

  • get isAbsoluteHorizontalCenter(): boolean
  • set isAbsoluteHorizontalCenter(value: boolean): void

isAbsoluteLeft

  • get isAbsoluteLeft(): boolean
  • set isAbsoluteLeft(value: boolean): void
  • If true, left is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's width.

    Returns boolean

  • If true, left is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's width.

    Parameters

    • value: boolean

    Returns void

isAbsoluteRight

  • get isAbsoluteRight(): boolean
  • set isAbsoluteRight(value: boolean): void
  • If true, right is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's width.

    Returns boolean

  • If true, right is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's width.

    Parameters

    • value: boolean

    Returns void

isAbsoluteTop

  • get isAbsoluteTop(): boolean
  • set isAbsoluteTop(value: boolean): void
  • If true, top is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's height.

    Returns boolean

  • If true, top is pixel margin, otherwise is percentage (0 - 1) margin relative to the parent's height.

    Parameters

    • value: boolean

    Returns void

isAbsoluteVerticalCenter

  • get isAbsoluteVerticalCenter(): boolean
  • set isAbsoluteVerticalCenter(value: boolean): void

isAlignBottom

  • get isAlignBottom(): boolean
  • set isAlignBottom(value: boolean): void

isAlignHorizontalCenter

  • get isAlignHorizontalCenter(): boolean
  • set isAlignHorizontalCenter(value: boolean): void

isAlignLeft

  • get isAlignLeft(): boolean
  • set isAlignLeft(value: boolean): void

isAlignRight

  • get isAlignRight(): boolean
  • set isAlignRight(value: boolean): void

isAlignTop

  • get isAlignTop(): boolean
  • set isAlignTop(value: boolean): void

isAlignVerticalCenter

  • get isAlignVerticalCenter(): boolean
  • set isAlignVerticalCenter(value: boolean): void

isStretchHeight

  • get isStretchHeight(): boolean
  • Whether to stretch vertically, when enable the left and right alignment will be stretched vertically, then height setting is invalid (read only).

    Returns boolean

isStretchWidth

  • get isStretchWidth(): boolean
  • Whether to stretch horizontally, when enable the left and right alignment will be stretched horizontally, the width setting is invalid (read only).

    Returns boolean

isValid

  • get isValid(): boolean
  • Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
    When an object's destroy is called, it is actually destroyed after the end of this frame. So isValid will return false from the next frame, while isValid in the current frame will still be true. If you want to determine whether the current frame has called destroy, use isValid(obj, true), but this is often caused by a particular logical requirements, which is not normally required.

    default

    true

    readonly
    example
    import { Node, log } from 'cc';
    const node = new Node();
    log(node.isValid);    // true
    node.destroy();
    log(node.isValid);    // true, still valid in this frame
    // after a frame...
    log(node.isValid);    // false, destroyed in the end of last frame

    Returns boolean

left

  • get left(): number
  • set left(value: number): void
  • The margins between the left of this node and the left of parent node, the value can be negative, Only available in 'isAlignLeft' open.

    Returns number

  • The margins between the left of this node and the left of parent node, the value can be negative, Only available in 'isAlignLeft' open.

    Parameters

    • value: number

    Returns void

name

  • get name(): string
  • set name(value: string): void

right

  • get right(): number
  • set right(value: number): void
  • The margins between the right of this node and the right of parent node, the value can be negative, Only available in 'isAlignRight' open.

    Returns number

  • The margins between the right of this node and the right of parent node, the value can be negative, Only available in 'isAlignRight' open.

    Parameters

    • value: number

    Returns void

target

  • get target(): null | Node
  • set target(value: null | Node): void
  • Specifies an alignment target that can only be one of the parent nodes of the current node. The default value is null, and when null, indicates the current parent.

    Returns null | Node

  • Specifies an alignment target that can only be one of the parent nodes of the current node. The default value is null, and when null, indicates the current parent.

    Parameters

    • value: null | Node

    Returns void

top

  • get top(): number
  • set top(value: number): void
  • The margins between the top of this node and the top of parent node, the value can be negative, Only available in 'isAlignTop' open.

    Returns number

  • The margins between the top of this node and the top of parent node, the value can be negative, Only available in 'isAlignTop' open.

    Parameters

    • value: number

    Returns void

uuid

  • get uuid(): string

verticalCenter

  • get verticalCenter(): number
  • set verticalCenter(value: number): void
  • Vertically aligns the midpoint offset value, the value can be negative, Only available in 'isAlignVerticalCenter' open.

    Returns number

  • Vertically aligns the midpoint offset value, the value can be negative, Only available in 'isAlignVerticalCenter' open.

    Parameters

    • value: number

    Returns void

Methods

Optional Private preload

  • __preload(): void
  • __preload is called before every onLoad.
    It is used to initialize the builtin components internally,
    to avoid checking whether onLoad is called before every public method calls.
    This method should be removed if script priority is supported.

    Returns void

adjustTargetToParentChanged

  • adjustTargetToParentChanged(oldParent: Node): void

adjustWidgetToAllowMovingInEditor

  • adjustWidgetToAllowMovingInEditor(eventType: TransformBit): void

adjustWidgetToAllowResizingInEditor

  • _adjustWidgetToAllowResizingInEditor(): void

adjustWidgetToAnchorChanged

  • _adjustWidgetToAnchorChanged(): void

Protected autoChangedValue

  • autoChangedValue(flag: AlignFlags, isAbs: boolean): void

destroyImmediate

  • _destroyImmediate(): void

destruct

  • _destruct(): void
  • Clear all references in the instance.

    NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

    Returns void

Optional Private getLocalBounds

  • getLocalBounds(out_rect: Rect): void
  • If the component's bounding box is different from the node's, you can implement this method to supply a custom axis aligned bounding box (AABB), so the editor's scene view can perform hit test properly.

    Parameters

    • out_rect: Rect

      The rect to store the result bounding rect

    Returns void

Private getRenderScene

  • _getRenderScene(): RenderScene

instantiate

  • instantiate(cloned: any): any

onPreDestroy

  • _onPreDestroy(): void

Private recursiveDirty

  • _recursiveDirty(): void

Protected registerEvent

  • _registerEvent(): void

Protected registerTargetEvents

  • _registerTargetEvents(): void

Protected removeParentEvent

  • _removeParentEvent(): void

Private setAlign

  • setAlign(flag: AlignFlags, isAlign: boolean): void

Protected targetChangedOperation

  • _targetChangedOperation(): void

Protected unregisterEvent

  • _unregisterEvent(): void

Protected unregisterOldParentEvents

  • unregisterOldParentEvents(oldParent: Node): void

Protected unregisterTargetEvents

  • _unregisterTargetEvents(): void

validateTargetInDEV

  • _validateTargetInDEV(): void

addComponent

  • addComponent<T>(classConstructor: Constructor<T>): T | null
  • addComponent(className: string): Component | null

destroy

  • destroy(): boolean

getComponent

  • getComponent<T>(classConstructor: Constructor<T>): T | null
  • getComponent(className: string): Component | null
  • Returns the component of supplied type if the node has one attached, null if it doesn't.
    You can also get component in the node by passing in the name of the script.

    example
    // get custom test calss.
    var test = node.getComponent("Test");

    Type parameters

    Parameters

    • classConstructor: Constructor<T>

      The class of component to be retrieved or to be created

    Returns T | null

  • Returns the component of supplied type if the node has one attached, null if it doesn't.
    You can also get component in the node by passing in the name of the script.

    example
    // get custom test calss.
    var test = node.getComponent("Test");

    Parameters

    • className: string

      A string for the class name of the component

    Returns Component | null

getComponentInChildren

  • getComponentInChildren<T>(classConstructor: Constructor<T>): T | null
  • getComponentInChildren(className: string): Component | null

getComponents

  • getComponents<T>(classConstructor: Constructor<T>): T[]
  • getComponents(className: string): Component[]

getComponentsInChildren

  • getComponentsInChildren<T>(classConstructor: Constructor<T>): T[]
  • getComponentsInChildren(className: string): Component[]

Protected Optional lateUpdate

  • lateUpdate(dt: number): void
  • LateUpdate is called every frame, if the Component is enabled.
    This is a lifecycle method. It may not be implemented in the super class.
    You can only call its super class method inside it. It should not be called manually elsewhere.

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

onDestroy

  • onDestroy(): void

onDisable

  • onDisable(): void

onEnable

  • onEnable(): void

Optional onFocusInEditor

  • onFocusInEditor(): void

Protected Optional onLoad

  • onLoad(): void
  • When attaching to an active node or its node first activated.
    onLoad is always called before any start functions, this allows you to order initialization of scripts.
    This is a lifecycle method. It may not be implemented in the super class.
    You can only call its super class method inside it. It should not be called manually elsewhere.

    Returns void

Optional onLostFocusInEditor

  • onLostFocusInEditor(): void

Protected Optional onRestore

  • onRestore(): void
  • onRestore is called after the user clicks the Reset item in the Inspector's context menu or performs an undo operation on this component.

    If the component contains the "internal state", short for "temporary member variables which not included
    in its CCClass properties", then you may need to implement this function.

    The editor will call the getset accessors of your component to record/restore the component's state
    for undo/redo operation. However, in extreme cases, it may not works well. Then you should implement
    this function to manually synchronize your component's "internal states" with its public properties.
    Once you implement this function, all the getset accessors of your component will not be called when
    the user performs an undo/redo operation. Which means that only the properties with default value
    will be recorded or restored by editor.

    Similarly, the editor may failed to reset your component correctly in extreme cases. Then if you need
    to support the reset menu, you should manually synchronize your component's "internal states" with its
    properties in this function. Once you implement this function, all the getset accessors of your component
    will not be called during reset operation. Which means that only the properties with default value
    will be reset by editor.

    This function is only called in editor mode.

    Returns void

Optional resetInEditor

  • resetInEditor(): void

schedule

  • schedule(callback: any, interval?: number, repeat?: number, delay?: number): void
  • Schedules a custom task.
    If the task is already scheduled, then the interval parameter will be updated without scheduling it again.

    example
    import { log } from 'cc';
    this.schedule((dt) => void log(`time: ${dt}`), 1);

    Parameters

    • callback: any

      The callback function of the task

    • Default value interval: number = 0

      The time interval between each invocation

    • Default value repeat: number = legacyCC.macro.REPEAT_FOREVER

      The repeat count of this task, the task will be invoked (repeat + 1) times, use macro.REPEAT_FOREVER to repeat a task forever

    • Default value delay: number = 0

      The delay time for the first invocation

    Returns void

scheduleOnce

  • scheduleOnce(callback: any, delay?: number): void
  • Schedules a task that runs only once, with a delay of 0 or larger.

    method

    scheduleOnce

    see

    schedule

    example
    import { log } from 'cc';
    this.scheduleOnce((dt) => void log(`time: ${dt}`), 2);

    Parameters

    • callback: any

      The callback function of the task

    • Default value delay: number = 0

      The delay time for the first invocation

    Returns void

setDirty

  • setDirty(): void

Protected Optional start

  • start(): void
  • Called before all scripts' update if the Component is enabled the first time.
    Usually used to initialize some logic which need to be called after all components' onload methods called.
    This is a lifecycle method. It may not be implemented in the super class.
    You can only call its super class method inside it. It should not be called manually elsewhere.

    Returns void

unschedule

  • unschedule(callback_fn: any): void

unscheduleAllCallbacks

  • unscheduleAllCallbacks(): void

Protected Optional update

  • update(dt: number): void
  • Update is called every frame, if the Component is enabled.
    This is a lifecycle method. It may not be implemented in the super class.
    You can only call its super class method inside it. It should not be called manually elsewhere.

    Parameters

    • dt: number

      the delta time in seconds it took to complete the last frame

    Returns void

updateAlignment

  • updateAlignment(): void
  • Immediately perform the widget alignment. You need to manually call this method only if you need to get the latest results after the alignment before the end of current frame.

    example
    import { log } from 'cc';
    widget.top = 10;       // change top margin
    log(widget.node.y); // not yet changed
    widget.updateAlignment();
    log(widget.node.y); // changed

    Returns void

Static deferredDestroy

  • _deferredDestroy(): void

Generated using TypeDoc