Class UITreeViewBaseAbstract

UI element that displays some contents in a tree-view where elements are placed vertically above/beneath each other, and different elements may be nested within other elements.

Elements may be selected, renamed, dragged and re-parented.

This class is abstract and meant to be extended by an implementation specific to some content type (for example scene object hierarchy).

Hierarchy (view full)

Constructors

constructor

Properties

Accessors

backgroundColor borderColor borderRadiusBottomLeft borderRadiusBottomRight borderRadiusTopLeft borderRadiusTopRight borderWidth bounds boundsInPixels clippedBoundsInPixels clippedVisibleBounds clippedVisibleBoundsInPixels clippedVisibleScreenBounds clippedVisibleScreenBoundsInPixels contentPaddingBottom contentPaddingLeft contentPaddingRight contentPaddingTop contextMenu debugFlags debugName disabled displayType dpiScale elementDepth elementHeight fixedHeight fixedHeightInPixels fixedWidth fixedWidthInPixels focusProxy isAcceptingKeyFocus isActive isDestroyed isDragEnabled isEditable isEventPassThrough isFocused isHovered isHoverEventPassThrough isIgnoreFocus isIgnoringCommandEvents isInteractiveFill isInteractiveStroke isLayoutBarrier isOn isReceivingHoverEvents isReceivingMouseMoveEvents isReservingFoldoutSpace isRootDisplayedSeparate isRootVisible isSortedByName isUpdating isVisible layoutHorizontalAlignment layoutVerticalAlignment mainElement minimumHeight minimumWidth multiSelectionAllowed navigationGroup paddingBottom paddingLeft paddingRight paddingTop parent position positionInteger readOnly screen screenBounds screenBoundsInPixels searchQuery selectedElements sizeHint sizeHintInPixels style tint visibleBounds visibleBoundsInPixels window

Methods

animateWithAction animateWithProperty animateWithSetter animationDelay clear clearCustomCursor clearPing collapseElement collapseSelected commandEvent convertElementLocalPositionToLocalPosition convertElementLocalPositionToLocalPositionInPixels convertWindowPositionToLocalInPixels convertWindowPositionToLocalInPoints convertWindowPositionToScreenInPixels convertWindowPositionToScreenInPoints deleteSelection deselectAll deselectElement destroy ensureLayoutCurrent expandElement expandSelected expandToSelected getBlockEvents getBoundsInPixels getMainElement getStyle isAnySelectedEntryExpandable isInBounds isSelectedEntryALeaf isSelectedEntryCollapsed isSelectedEntryExpanded isSelectingEditableEntries markElementDirty mouseEvent onActivate onDeactivate onRegister onTooltipRequested onUnregister onUpdate ping rebuild renameElement renameSelected resetDimensions scrollToElement selectAbove selectBelow selectElement setBlockEvents setBorderRadius setBounds setContentPadding setCustomCursor setFixedHeight setFixedWidth setFlexibleHeight setFlexibleWidth setFocus setPadding shortcutActionEvent stopAnimations textInputEvent toPixels toPixelsVector2 toPoints toPointsVector2 virtualButtonEvent withBlockedEvents renderToTexture

Events

onElementLeftClick onElementRightClick onElementDoubleClick onTreeElementHoverChange onSelectionChanged onTreeElementRename onSearchQueryChanged onFocusGained onFocusLost onMouseEnter onMouseLeave onClickUp onCustomContextMenuRequested onStateChanged onLayoutSizeChanged onRegistrationChanged onActiveSurfaceChanged

Constructors

Protectedconstructor

Accessors

backgroundColor

  • get backgroundColor(): Immutable<Color>

  • Sets new background color to be used by the element.

    Returns Immutable<Color>

  • set backgroundColor(value): void

  • Parameters

    Returns void

borderColor

  • get borderColor(): Immutable<Color>

  • Sets new border color to be used by the element.

    Returns Immutable<Color>

  • set borderColor(value): void

  • Parameters

    Returns void

borderRadiusBottomLeft

  • get borderRadiusBottomLeft(): number

  • Sets the border radius of the style used by this element.

    Returns number

  • set borderRadiusBottomLeft(value): void

  • Parameters

    • value: number

    Returns void

borderRadiusBottomRight

  • get borderRadiusBottomRight(): number

  • Sets the border radius of the style used by this element.

    Returns number

  • set borderRadiusBottomRight(value): void

  • Parameters

    • value: number

    Returns void

borderRadiusTopLeft

  • get borderRadiusTopLeft(): number

  • Sets the border radius of the style used by this element.

    Returns number

  • set borderRadiusTopLeft(value): void

  • Parameters

    • value: number

    Returns void

borderRadiusTopRight

  • get borderRadiusTopRight(): number

  • Sets the border radius of the style used by this element.

    Returns number

  • set borderRadiusTopRight(value): void

  • Parameters

    • value: number

    Returns void

borderWidth

  • get borderWidth(): number

  • Sets new border width to be used by the element.

    Returns number

  • set borderWidth(value): void

  • Parameters

    • value: number

    Returns void

bounds

  • get bounds(): Immutable<Rect2>

  • Sets the bounds of the UI element. Relative to a parent UI panel. Equivalent to calling setPosition(), setWidth() and setHeight().

    If scalable is set to true, the size will be scaled linearly with the DPI scaling factor of the surface the elements gets attached. It false, the element will have this exact size no matter the DPI scaling factor.

    Returns Immutable<Rect2>

  • set bounds(value): void

  • Parameters

    Returns void

boundsInPixels

  • get boundsInPixels(): Immutable<Rect2>

  • Gets or sets non-clipped bounds of the UI element in pixels. Relative to a parent UI panel.

    Returns Immutable<Rect2>

  • set boundsInPixels(value): void

  • Parameters

    Returns void

clippedBoundsInPixels

  • get clippedBoundsInPixels(): Immutable<Rect2>

  • Gets UI element bounds relative to parent widget, clipped by specified clip rect.

    Returns Immutable<Rect2>

clippedVisibleBounds

  • get clippedVisibleBounds(): Immutable<Rect2>

  • Returns the clipped bounds of the UI element including the margins. Relative to a parent UI panel.

    Returns Immutable<Rect2>

clippedVisibleBoundsInPixels

  • get clippedVisibleBoundsInPixels(): Immutable<Rect2>

  • Returns the clipped bounds of the UI element including the margins. Relative to a parent UI panel.

    Returns Immutable<Rect2>

clippedVisibleScreenBounds

  • get clippedVisibleScreenBounds(): Immutable<Rect2>

  • Returns the clipped bounds of the UI element including the margins. In Screenspace.

    Returns Immutable<Rect2>

clippedVisibleScreenBoundsInPixels

  • get clippedVisibleScreenBoundsInPixels(): Immutable<Rect2>

  • Returns the clipped bounds of the UI element including the margins. In Screenspace.

    Returns Immutable<Rect2>

contentPaddingBottom

  • get contentPaddingBottom(): number

  • Sets the content padding of the style used by this element.

    Returns number

  • set contentPaddingBottom(value): void

  • Parameters

    • value: number

    Returns void

contentPaddingLeft

  • get contentPaddingLeft(): number

  • Sets the content padding of the style used by this element.

    Returns number

  • set contentPaddingLeft(value): void

  • Parameters

    • value: number

    Returns void

contentPaddingRight

  • get contentPaddingRight(): number

  • Sets the content padding of the style used by this element.

    Returns number

  • set contentPaddingRight(value): void

  • Parameters

    • value: number

    Returns void

contentPaddingTop

  • get contentPaddingTop(): number

  • Sets the content padding of the style used by this element.

    Returns number

  • set contentPaddingTop(value): void

  • Parameters

    • value: number

    Returns void

contextMenu

  • get contextMenu(): UIContextMenu

  • Assigns a new context menu that will be opened when the element is right clicked. Null is allowed in case no context menu is wanted.

    Returns UIContextMenu

  • set contextMenu(value): void

  • Parameters

    Returns void

debugFlags

debugName

  • get debugName(): string

  • Sets the debug name for the UI element.

    Returns string

  • set debugName(value): void

  • Parameters

    • value: string

    Returns void

disabled

  • get disabled(): boolean

  • Disables or enables the element. Disabled elements cannot be interacted with and have a faded out appearance.

    Returns boolean

  • set disabled(value): void

  • Parameters

    • value: boolean

    Returns void

displayType

  • get displayType(): EnumValue<UIDisplayType, number>

  • Hides or shows this element and recursively applies the same state to all the child elements. This will not remove the element from the layout, the room for it will still be reserved but it just won't be visible.

    Returns EnumValue<UIDisplayType, number>

  • set displayType(value): void

  • Parameters

    Returns void

dpiScale

  • get dpiScale(): number

  • Gets the scaling factor for the element's parent surface. This element must be attached to a valid surface in order to retrieve the scale factor. If the element is not attached to a surface, 1.0 is returned.

    Returns number

    The scale factor for the element's parent surface.

elementDepth

  • get elementDepth(): number

  • Set element part of element depth. Less significant than both widget and area depth.

    Returns number

  • set elementDepth(value): void

  • Parameters

    • value: number

    Returns void

elementHeight

  • get elementHeight(): number

  • Defines a query to be used when filtering the results.

    Returns number

  • set elementHeight(value): void

  • Parameters

    • value: number

    Returns void

fixedHeight

  • get fixedHeight(): number

  • Sets the element size to be fixed using the specified value.

    Returns number

  • set fixedHeight(value): void

  • Parameters

    • value: number

    Returns void

fixedHeightInPixels

  • set fixedHeightInPixels(value): void

  • Sets the element size to be fixed using the specified value in pixels.

    Parameters

    • value: number

    Returns void

fixedWidth

  • get fixedWidth(): number

  • Sets the element size to be fixed using the specified value.

    Returns number

  • set fixedWidth(value): void

  • Parameters

    • value: number

    Returns void

fixedWidthInPixels

  • set fixedWidthInPixels(value): void

  • Sets the element size to be fixed using the specified value in pixels.

    Parameters

    • value: number

    Returns void

focusProxy

  • get focusProxy(): UIElement

  • Gets the focus proxy element.

    Returns UIElement

  • set focusProxy(value): void

  • Parameters

    Returns void

isAcceptingKeyFocus

  • get isAcceptingKeyFocus(): boolean

  • Determines if the element can be navigated to by using keys/buttons (e.g. the 'Tab' button on the keyboard.

    Returns boolean

  • set isAcceptingKeyFocus(value): void

  • Parameters

    • value: boolean

    Returns void

isActive

  • get isActive(): boolean

  • Determines if the element is currently being "clicked" by a pointer device or keyboard input.

    Returns boolean

  • set isActive(value): void

  • Parameters

    • value: boolean

    Returns void

isDestroyed

  • get isDestroyed(): boolean

  • Checks if the underlying native UIElement has been destroyed.

    Returns boolean

isDragEnabled

  • get isDragEnabled(): boolean

  • Determines if the tree allows for internal dragging.

    Returns boolean

  • set isDragEnabled(value): void

  • Parameters

    • value: boolean

    Returns void

isEditable

  • get isEditable(): boolean

  • Determines if the tree view elements are editable.

    Returns boolean

  • set isEditable(value): void

  • Parameters

    • value: boolean

    Returns void

isEventPassThrough

  • get isEventPassThrough(): boolean

  • Determines will this element block elements underneath it from receiving events like pointer click, hover on/off or be able to gain focus. True by default.

    Returns boolean

  • set isEventPassThrough(value): void

  • Parameters

    • value: boolean

    Returns void

isFocused

  • get isFocused(): boolean

  • Determines if the element is currently being focused, typically in a state to accept for keyboard input.

    Returns boolean

  • set isFocused(value): void

  • Parameters

    • value: boolean

    Returns void

isHovered

  • get isHovered(): boolean

  • Determines if the element is currently hovered by a pointer device.

    Returns boolean

  • set isHovered(value): void

  • Parameters

    • value: boolean

    Returns void

isHoverEventPassThrough

  • get isHoverEventPassThrough(): boolean

  • Determines if the element is receives hover events.

    Returns boolean

  • set isHoverEventPassThrough(value): void

  • Parameters

    • value: boolean

    Returns void

isIgnoreFocus

  • get isIgnoreFocus(): boolean

  • Determines if the element can be focused by clicking on it.

    Returns boolean

  • set isIgnoreFocus(value): void

  • Parameters

    • value: boolean

    Returns void

isIgnoringCommandEvents

  • get isIgnoringCommandEvents(): boolean

  • Determines if command events such as NavigateUp are ignored.

    Returns boolean

  • set isIgnoringCommandEvents(value): void

  • Parameters

    • value: boolean

    Returns void

isInteractiveFill

  • get isInteractiveFill(): boolean

  • Determines if the element fill is interactive based on mouse events. This requires mouse-move events to be enabled.

    Returns boolean

  • set isInteractiveFill(value): void

  • Parameters

    • value: boolean

    Returns void

isInteractiveStroke

  • get isInteractiveStroke(): boolean

  • Determines if the element stroke is interactive based on mouse events. This requires mouse-move events to be enabled.

    Returns boolean

  • set isInteractiveStroke(value): void

  • Parameters

    • value: boolean

    Returns void

isLayoutBarrier

  • get isLayoutBarrier(): boolean

  • Specifies that layout passes of children elements should start from this element.

    Returns boolean

  • set isLayoutBarrier(value): void

  • Parameters

    • value: boolean

    Returns void

isOn

  • get isOn(): boolean

  • Determines if the element is currently being "clicked" by a pointer device or keyboard input.

    Returns boolean

  • set isOn(value): void

  • Parameters

    • value: boolean

    Returns void

isReceivingHoverEvents

  • get isReceivingHoverEvents(): boolean

  • Determines if the element is receives hover events.

    Returns boolean

  • set isReceivingHoverEvents(value): void

  • Parameters

    • value: boolean

    Returns void

isReceivingMouseMoveEvents

  • get isReceivingMouseMoveEvents(): boolean

  • Determines if the element is receives hover events.

    Returns boolean

  • set isReceivingMouseMoveEvents(value): void

  • Parameters

    • value: boolean

    Returns void

isReservingFoldoutSpace

  • get isReservingFoldoutSpace(): boolean

  • Determines if the space for the foldout should be reserved, even when invisible.

    Returns boolean

  • set isReservingFoldoutSpace(value): void

  • Parameters

    • value: boolean

    Returns void

isRootDisplayedSeparate

  • get isRootDisplayedSeparate(): boolean

  • Determines if the root entry is visible as a separate entry at the end of the table.

    Returns boolean

    Note

    This can provide a helpful UX to control global settings for the context that is being displayed in the tree view.

  • set isRootDisplayedSeparate(value): void

  • Parameters

    • value: boolean

    Returns void

isRootVisible

  • get isRootVisible(): boolean

  • Determines if the root entry is visible.

    Returns boolean

  • set isRootVisible(value): void

  • Parameters

    • value: boolean

    Returns void

isSortedByName

  • get isSortedByName(): boolean

  • Determines if the treeview elements are automatically sorted by name.

    Returns boolean

    Note

    Must be set before elements are inserted.

  • set isSortedByName(value): void

  • Parameters

    • value: boolean

    Returns void

isUpdating

  • get isUpdating(): boolean

  • Specifies that per-frame updates are enabled. If enabled, the element's onUpdate method will be called every frame.

    Returns boolean

    Note

    Per-frame updates are expensive and most UI elements should be built using a fully event-driven approach. Do not enable per-frame updates unless there is no event available that can be used to drive the required behavior.

  • set isUpdating(value): void

  • Parameters

    • value: boolean

    Returns void

isVisible

  • get isVisible(): boolean

  • Activates or deactivates this element and recursively applies the same state to all the child elements. This has the same effect as SetDisplayType(UIDisplayType::Hidden), but when disabled it will also remove the element from the layout, essentially having the same effect is if you destroyed the element.

    Returns boolean

  • set isVisible(value): void

  • Parameters

    • value: boolean

    Returns void

layoutHorizontalAlignment

layoutVerticalAlignment

mainElement

minimumHeight

  • get minimumHeight(): number

  • Sets the minimum height in points of the element when used in a layout.

    Returns number

  • set minimumHeight(value): void

  • Parameters

    • value: number

    Returns void

minimumWidth

  • get minimumWidth(): number

  • Sets the minimum width in points of the element when used in a layout.

    Returns number

  • set minimumWidth(value): void

  • Parameters

    • value: number

    Returns void

multiSelectionAllowed

  • get multiSelectionAllowed(): boolean

  • Determines if the tree view allows multiple elements to be selected.

    Returns boolean

  • set multiSelectionAllowed(value): void

  • Parameters

    • value: boolean

    Returns void

navigationGroup

  • Sets a navigation group that determines in what order are UI elements visited when using a keyboard or gamepad to switch between the elements. If you don't set a navigation group the elements will inherit the default navigation group from their parent UISurface. Also see SetNavigationGroupIndex().

    Returns UINavGroup

  • Parameters

    Returns void

paddingBottom

  • get paddingBottom(): number

  • Sets the padding of the style used by this element.

    Returns number

  • set paddingBottom(value): void

  • Parameters

    • value: number

    Returns void

paddingLeft

  • get paddingLeft(): number

  • Sets the padding of the style used by this element.

    Returns number

  • set paddingLeft(value): void

  • Parameters

    • value: number

    Returns void

paddingRight

  • get paddingRight(): number

  • Sets the padding of the style used by this element.

    Returns number

  • set paddingRight(value): void

  • Parameters

    • value: number

    Returns void

paddingTop

  • get paddingTop(): number

  • Sets the padding of the style used by this element.

    Returns number

  • set paddingTop(value): void

  • Parameters

    • value: number

    Returns void

parent

  • get parent(): UIElementBase

  • Returns the layout this element belongs to, if any.

    Returns UIElementBase

position

  • get position(): Immutable<Vector2>

  • Sets element position relative to parent UI panel in points.

    Returns Immutable<Vector2>

    Note

    Be aware that this value will be ignored if UI element is part of a layout since then the layout controls its placement.

  • set position(value): void

  • Parameters

    Returns void

positionInteger

  • set positionInteger(value): void

  • Sets element position relative to parent UI panel in pixels.

    Parameters

    Returns void

    Note

    Be aware that this value will be ignored if UI element is part of a layout since then the layout controls its placement.

readOnly

  • get readOnly(): boolean

  • Disables or enables the element. Disabled elements cannot be interacted with and have a faded out appearance.

    Returns boolean

  • set readOnly(value): void

  • Parameters

    • value: boolean

    Returns void

screen

  • get screen(): Screen

  • Returns the screen on which the element is displayed, if any.

    Returns Screen

screenBounds

  • get screenBounds(): Immutable<Rect2>

  • Returns non-clipped bounds of the UI element in screenspace.

    Returns Immutable<Rect2>

    Note

    This call can be potentially expensive if the UI state is dirty.

screenBoundsInPixels

  • get screenBoundsInPixels(): Immutable<Rect2>

  • Returns non-clipped bounds of the UI element in screenspace.

    Returns Immutable<Rect2>

    Note

    This call can be potentially expensive if the UI state is dirty.

searchQuery

  • get searchQuery(): string

  • Defines a query to be used when filtering the results.

    Returns string

  • set searchQuery(value): void

  • Parameters

    • value: string

    Returns void

selectedElements

sizeHint

  • get sizeHint(): Immutable<Size2>

  • Gets the size hint for this element.

    Returns Immutable<Size2>

    Note

    The size hint represents an approximation of the size. The actual size depends on the layouting that is done by the parent element. Layouts typically use the size hint to calculate the intial size of the element when distributing the available layout space.

sizeHintInPixels

  • get sizeHintInPixels(): Immutable<Vector2>

  • Gets the size hint for this element.

    Returns Immutable<Vector2>

    Note

    The size hint represents an approximation of the size. The actual size depends on the layouting that is done by the parent element. Layouts typically use the size hint to calculate the intial size of the element when distributing the available layout space.

style

  • get style(): string

  • Sets new style to be used by the element.

    Returns string

  • set style(value): void

  • Parameters

    • value: string

    Returns void

tint

visibleBounds

  • get visibleBounds(): Immutable<Rect2>

  • Returns non-clipped visible bounds of the UI element (bounds exclude the margins). Relative to the parent UI panel.

    Returns Immutable<Rect2>

    Note

    This call can be potentially expensive as the bounds need to be calculated based on current UI state.

visibleBoundsInPixels

  • get visibleBoundsInPixels(): Immutable<Rect2>

  • Returns non-clipped visible bounds of the UI element (bounds exclude the margins). Relative to the parent UI panel.

    Returns Immutable<Rect2>

    Note

    This call can be potentially expensive as the bounds need to be calculated based on current UI state.

window

  • get window(): RenderWindow

  • Get the window in which the element is positioned.

    Returns RenderWindow

Methods

animateWithAction

  • animateWithAction(action, delay?, repeating?): EditorAnimation

  • Creates an animation that executes an action lambda once the delay elapsed.

    Parameters

    • action: (() => void)

      The action to execute.

        • (): void

        • Returns void

    • Optionaldelay: number

      The delay until the action is executed. Defaults to no delay.

    • Optionalrepeating: number | boolean

      Whether the animation should repeat or not. Defaults to false. Set to true, to repeat forever. Set to false, to never repeat. Set to a number, to indicate the repeat count.

    Returns EditorAnimation

    The created animation.

animateWithProperty

  • animateWithProperty<T>(propertyName, starting, ending, duration?, easingCurve?, repeating?): EditorAnimation

  • Animates a property of the UIElement. The animation is automatically started.

    Type Parameters

    • T

      The type of property to be animated.

    Parameters

    • propertyName: string

      The name of the property to be animated on the UIElement.

    • starting: T

      The starting value of the property.

    • ending: T

      The ending value of the property.

    • Optionalduration: number

      The animation duration in seconds. Defaults to 1 seconds.

    • OptionaleasingCurve: Const<EasingCurve>

      The easing curve to be used. Defaults to

    • Optionalrepeating: number | boolean

      Whether the animation should repeat or not. Defaults to false. Set to true, to repeat forever. Set to false, to never repeat. Set to a number, to indicate the repeat count.

    Returns EditorAnimation

    The created animation.

    See

    EasingCurve.inOutQuadratic.

animateWithSetter

  • animateWithSetter<T>(setter, starting, ending, duration?, easingCurve?, repeating?): EditorAnimation

  • Animates a property of the UIElement using a generic lambda function. The animation is automatically started.

    Type Parameters

    • T

    Parameters

    • setter: ((value: T) => void)

      The lambda that is called when the value is updated. The lambda should be used to assign the value on the u

        • (value): void

        • Parameters

          • value: T

          Returns void

    • starting: T

      The starting value of the property.

    • ending: T

      The ending value of the property.

    • Optionalduration: number

      The animation duration in seconds. Defaults to 1 seconds.

    • OptionaleasingCurve: Const<EasingCurve>

      The easing curve to be used. Defaults to

    • Optionalrepeating: number | boolean

      Whether the animation should repeat or not. Defaults to false. Set to true, to repeat forever. Set to false, to never repeat. Set to a number, to indicate the repeat count.

    Returns EditorAnimation

    The created animation.

    See

    EasingCurve.inOutQuadratic.

animationDelay

  • animationDelay(delay): EditorAnimation

  • Creates an animation that takes delay seconds to execute.

    Parameters

    • delay: number

      The delay in seconds.

    Returns EditorAnimation

    The created animation.

    Note

    This animation is usedful when creating compound animations that are chained together by calls to then. This is helpful to create an animation that performs an action, waits and performs another action.

clear

  • clear(): void

  • Removes all items from the root element, essentially clearing the tree view.

    Returns void

clearCustomCursor

clearPing

  • clearPing(): void

  • Clears the ping highlight on the currently highlighted element.

    Returns void

collapseElement

  • collapseElement(element): void

  • Collapses the provided element making its children hidden and not interactable.

    Parameters

    Returns void

collapseSelected

  • collapseSelected(): void

  • Collapse the current selected entries.

    Returns void

commandEvent

  • commandEvent(ev): boolean
  • Virtual

    Called when a command event is triggered. Return true if you have processed the event and don't want other elements to process it.

    Parameters

    Returns boolean

convertElementLocalPositionToLocalPosition

convertElementLocalPositionToLocalPositionInPixels

convertWindowPositionToLocalInPixels

convertWindowPositionToLocalInPoints

convertWindowPositionToScreenInPixels

convertWindowPositionToScreenInPoints

deleteSelection

  • deleteSelection(): void

  • Deletes all currently selected elements.

    Returns void

deselectAll

  • deselectAll(): void

  • Deselects all currently selected elements.

    Returns void

deselectElement

  • deselectElement(element): void

  • Deselects the provided TreeElement.

    Parameters

    Returns void

destroy

  • destroy(): void
  • Virtual

    Destroys this element and all its children. Removes the element from parent layout/panel.

    Returns void

    Note

    Calling methods on a destroyed element is a no-operation. Destroyed elements aren't allowed to be assigned as children of other elements, or be parents of other elements.

ensureLayoutCurrent

  • ensureLayoutCurrent(): void

  • Updates the layout of the UI element. Updates child elements positions, sizes, clip rectangles and depths so they fit into the provided bounds, while respecting their layout options.

    Returns void

    Note

    This may trigger the layout of more than this element and it's children! It can potentially update the layout of the whole UI tree.

expandElement

  • expandElement(element): void

  • Expands the provided element making its children interactable.

    Parameters

    Returns void

expandSelected

  • expandSelected(): void

  • Expands the current selected entries.

    Returns void

expandToSelected

  • expandToSelected(): void

  • Expands all parent elements of the current selected entries.

    Returns void

getBlockEvents

  • getBlockEvents(): boolean

  • If isBlocking is true, events emitted by this object are blocked. If isBlocking is false, no blocking will occur and events will be triggered normally.

    Events emitted while being blocked are not buffered.

    Returns boolean

    whether the element is already blocking events or not.

getBoundsInPixels

  • getBoundsInPixels(relativeTo?): Rect2

  • Returns non-clipped bounds of the UI element. Relative to a parent UI panel.

    Parameters

    • OptionalrelativeTo: UIElementBase

      Parent panel of the provided element relative to which to return the bounds. If null the bounds relative to the first parent panel are returned. Behavior is undefined if provided panel is not a parent of the element.

    Returns Rect2

    Note

    This call can be potentially expensive if the UI state is dirty.

getMainElement

getStyle

isAnySelectedEntryExpandable

  • isAnySelectedEntryExpandable(): boolean

  • Checks if at least one of the selected entries is expandable.

    Returns boolean

isInBounds

  • isInBounds(position): boolean
  • Virtual

    Checks is the specified position within UI element bounds. Position is relative to parent UI widget.

    Parameters

    Returns boolean

isSelectedEntryALeaf

  • isSelectedEntryALeaf(): boolean

  • Checks if the selected entry contains any children or if its a leaf.

    Returns boolean

isSelectedEntryCollapsed

  • isSelectedEntryCollapsed(): boolean

  • Checks if all the selected entries are collapsed. True if all entries are collapsed, false if at least one is expanded.

    Returns boolean

isSelectedEntryExpanded

  • isSelectedEntryExpanded(): boolean

  • Checks if all the selected entries are expanded. True if all entries are expanded, false if at least one is collapsed.

    Returns boolean

isSelectingEditableEntries

  • isSelectingEditableEntries(): boolean

  • Returns whether all selected entries are editable or not.

    Returns boolean

markElementDirty

  • markElementDirty(element, isRecursive?): void

  • Marks the provided TreeElement as dirty and synchronizes the visual content to the element data.

    Parameters

    • element: TreeViewDataElement

      The element to mark dirty.

    • OptionalisRecursive: boolean

      True to mark all child elements as dirty.

    Returns void

mouseEvent

  • mouseEvent(ev): boolean
  • Virtual

    Called when a mouse event is received on any UI element the mouse is interacting with. Return true if you have processed the event and don't want other elements to process it.

    Parameters

    Returns boolean

onActivate

  • onActivate(): void
  • Virtual

    Called when the element has been added to a surface or window.

    Returns void

    Note

    This event allows to immediately access the layout data and bounds of the element and it's immediate parents and children. The event is helpful to perform initialization and registration to events. Implementing classes must call super.

onDeactivate

  • onDeactivate(): void
  • Virtual

    Called when the element has been removed from a surface or window.

    Returns void

    Note

    Layout data and bounds will no longer be available at this point. The event is helpful to perform cleanup and unregistration from events. Implementing classes must call super.

onRegister

  • onRegister(): void
  • Virtual

    Called when the element has been registered with its parent.

    Returns void

onTooltipRequested

  • onTooltipRequested(): UIElementBase
  • Virtual

    Invoked when the UI requests the UIElement to create a custom tooltip.

    Returns UIElementBase

    A UIElement that contains the tooltip content.

    Note

    An element must be returned that is not yet added to a UI hierarchy. If the element is already added to a hierachy, it will be removed and disposed once the tooltip finished. However, it is acceptable to preallocate a UIElement and always return the same UIElement.

onUnregister

  • onUnregister(): void
  • Virtual

    Called when the element is about to be unregistered from its parent.

    Returns void

onUpdate

  • onUpdate(): void
  • Virtual

    Called when the element is updating.

    Returns void

    Note

    This is method is only called if the element has been marked as requiring updates.

    Note

    Per-frame updates are expensive and most UI elements should be built using a fully event-driven approach. Do not enable per-frame updates unless there is no event available that can be used to drive the required behavior.

ping

  • ping(element): void

  • Scrolls the tree view to the specified element and highlights it.

    Parameters

    Returns void

rebuild

  • rebuild(): void
  • Virtual

    Rebuilds the contents of the tree view.

    Returns void

renameElement

  • renameElement(element): void

  • Starts rename operation on the given element.

    Parameters

    Returns void

renameSelected

  • renameSelected(): void

  • Starts rename operation on the currently selected element.

    Returns void

resetDimensions

  • resetDimensions(): void
  • Virtual

    Resets element dimensions to their initial values dictated by the element's style.

    Returns void

scrollToElement

  • scrollToElement(element, center): void

  • Scrolls the parent UIScrollArea (if any) so that the specified TreeElement is visible.

    Parameters

    • element: TreeViewDataElement

      Element to scroll to.

    • center: boolean

      If true the element will be centered in the scroll view, otherwise it will be at the top.

    Returns void

selectAbove

  • selectAbove(deselectOthers?): void

  • Selects an entry above the current selected entry, if any.

    Parameters

    • OptionaldeselectOthers: boolean

      Whether or not the selection should first deselect the other ones.

    Returns void

selectBelow

  • selectBelow(deselectOthers?): void

  • Selects an entry below the current selected entry, if any.

    Parameters

    • OptionaldeselectOthers: boolean

      Whether or not the selection should first deselect the other ones.

    Returns void

selectElement

  • selectElement(element): void

  • Selects the specified

    Parameters

    Returns void

setBlockEvents

  • setBlockEvents(isBlocking): boolean

  • If isBlocking is true, events emitted by this object are blocked. If isBlocking is false, no blocking will occur and events will be triggered normally.

    Events emitted while being blocked are not buffered.

    Parameters

    • isBlocking: boolean

      Should the element block events

    Returns boolean

    whether the element is already blocking events or not.

setBorderRadius

  • setBorderRadius(value): void

  • Sets the border radius of the style used by this element.

    Parameters

    • value: number

    Returns void

setBounds

  • setBounds(bounds, scalable?): void

  • Sets the bounds of the UI element. Relative to a parent UI panel. Equivalent to calling setPosition(), setWidth() and setHeight().

    If scalable is set to true, the size will be scaled linearly with the DPI scaling factor of the surface the elements gets attached. It false, the element will have this exact size no matter the DPI scaling factor.

    Parameters

    Returns void

setContentPadding

  • setContentPadding(value): void

  • Sets the content padding of the style used by this element.

    Parameters

    • value: number

    Returns void

setCustomCursor

  • setCustomCursor(options): void

  • Assigns a custom cursor type.

    Parameters

    • options: {
          type: EnumValue<CursorType, number>;
      } | {
          name: string;
      }

      Options object for the function call.

    Returns void

setFixedHeight

setFixedWidth

setFlexibleHeight

  • setFlexibleHeight(minHeight?, maxHeight?, scalable?): void

  • Sets element height in pixels. Element will be resized according to its contents and parent layout but will always stay within the provided range. If maximum height is zero, the element is allowed to expand as much as it needs.

    If scalable is set to true, the minimum and maximum heights will be scaled linearly with the DPI scaling factor of the surface the elements gets attached. It false, the element will have this exact size no matter the DPI scaling factor.

    Parameters

    • OptionalminHeight: number
    • OptionalmaxHeight: number
    • Optionalscalable: boolean

    Returns void

setFlexibleWidth

  • setFlexibleWidth(minWidth?, maxWidth?, scalable?): void

  • Sets element width in pixels. Element will be resized according to its contents and parent layout but will always stay within the provided range. If maximum width is zero, the element is allowed to expand as much as it needs.

    If scalable is set to true, the minimum and maximum widths will be scaled linearly with the DPI scaling factor of the surface the elements gets attached. It false, the element will have this exact size no matter the DPI scaling factor.

    Parameters

    • OptionalminWidth: number
    • OptionalmaxWidth: number
    • Optionalscalable: boolean

    Returns void

setFocus

  • setFocus(isEnabled): void

  • Change the UI element focus state, will clear focus of any currently focussed element.

    Parameters

    • isEnabled: boolean

      Give the element focus or take it away.

    Returns void

setPadding

  • setPadding(value): void

  • Sets the padding of the style used by this element.

    Parameters

    • value: number

    Returns void

shortcutActionEvent

  • shortcutActionEvent(shortcutAction): boolean
  • Virtual

    Called when a shortcut action is triggered and the UI element has input focus. Return true if you have processed the event and don't want other elements to process it.

    Parameters

    Returns boolean

stopAnimations

  • stopAnimations(): number

  • Unregisters all running animations for the UIElement.

    Returns number

    The number of animations that were unregistered.

textInputEvent

  • textInputEvent(ev): boolean
  • Virtual

    Called when some text is input and the UI element has input focus. Return true if you have processed the event and don't want other elements to process it.

    Parameters

    Returns boolean

toPixels

  • toPixels(valueInPoints): number

  • Scales a point value by using the element's DPI scale to the current pixel value.

    Parameters

    • valueInPoints: number

      The element to scale a value for. This element must be attached to a valid widget in order to retrieve the scale factor. If the element is not attached to a widget, no scaling is performed.

    Returns number

    The value in pixels.

toPixelsVector2

  • toPixelsVector2(valueInPoints): Vector2

  • Scales a point value by using the element's DPI scale to the current pixel value.

    Parameters

    • valueInPoints: Immutable<Vector2>

      The element used to get the DPI scaling factor.

    Returns Vector2

    Result value in pixels.

toPoints

  • toPoints(valueInPixels): number

  • Converts a pixel value to points by using the element's DPI scale.

    Parameters

    • valueInPixels: number

      The element to scale a value for. This element must be attached to a valid widget in order to retrieve the scale factor. If the element is not attached to a widget, no scaling is performed.

    Returns number

    The value in points.

toPointsVector2

  • toPointsVector2(valueInPixels): Vector2

  • Scales a point value by using the element's DPI scale to the current point value.

    Parameters

    • valueInPixels: Immutable<Vector2>

      The element used to get the DPI scaling factor.

    Returns Vector2

    Result value in points.

virtualButtonEvent

  • virtualButtonEvent(ev): boolean
  • Virtual

    Called when a virtual button is pressed/released and the UI element has input focus. Return true if you have processed the event and don't want other elements to process it.

    Parameters

    Returns boolean

withBlockedEvents

  • withBlockedEvents(action): void
  • Virtual

    Executes the given action with blocked events on the UI element. The events are restored before returning.

    Parameters

    • action: (() => void)

      The action to be executed while events are blocked.

        • (): void

        • Returns void

    Returns void

StaticrenderToTexture

  • renderToTexture(element, skin, sizeInPixels, scalingFactor?, clearColor?): AsyncOp<ResourceHandle<Texture>, void>

  • Renders a UI element into a texture.

    Parameters

    • element: UIElementBase

      The UI element to be drawn to a texture.

    • skin: UISkin | ResourceHandle<UISkin>

      The UI skin to be used to render the element.

    • sizeInPixels: Immutable<Size2>

      The size of the UI texture to draw.

    • OptionalscalingFactor: number

      The DPI scaling factor of the RenderTarget. Can be used to linearly scale the entire UI, including text.

    • OptionalclearColor: Immutable<SRGBColor>

      The clear color. (Default: [0, 0, 0, 0])

    Returns AsyncOp<ResourceHandle<Texture>, void>

    An async operation that returns the rendered texture once rendering has been completed by the GPU.

    Note

    Calling this method will detach the given element from it's current parent.

Events

ReadonlyonElementLeftClick

onElementLeftClick: Event<[Immutable<Vector2>, TreeViewDataElement], void>

Triggered when the user left clicks a data element on the list.

ReadonlyonElementRightClick

onElementRightClick: Event<[Immutable<Vector2>, TreeViewDataElement], void>

Triggered when the user right clicks a data element on the list.

ReadonlyonElementDoubleClick

onElementDoubleClick: Event<[Immutable<Vector2>, TreeViewDataElement], void>

Triggered when the user double-clicks a data element on the list.

ReadonlyonTreeElementHoverChange

onTreeElementHoverChange: Event<[Immutable<Vector2>, TreeViewDataElement, boolean], void>

Triggered when the hover state of an element changed.

ReadonlyonSelectionChanged

onSelectionChanged: Event<[], void>

Triggered when the selection changed.

ReadonlyonTreeElementRename

onTreeElementRename: Event<[TreeViewDataElement, string, string], void>

Triggered when an element of the tree finishes a rename. Provided with the element, old name and new written name.

ReadonlyonSearchQueryChanged

onSearchQueryChanged: Event<[string], void>

Gets called whenever the search query changed.

ReadonlyonFocusGained

onFocusGained: Event<[], void>

Triggered when the element gains focus.

ReadonlyonFocusLost

onFocusLost: Event<[], void>

Triggered when the element loses focus.

ReadonlyonMouseEnter

onMouseEnter: Event<[], void>

Triggered when the mouse enters over the UI element.

ReadonlyonMouseLeave

onMouseLeave: Event<[], void>

Triggered when the mouse leaves the UI element.

ReadonlyonClickUp

onClickUp: Event<[], void>

Triggered when the element was clicked.

ReadonlyonCustomContextMenuRequested

onCustomContextMenuRequested: Event<[], UIContextMenu>

Triggered when the widget requests the creation of a context menu.

ReadonlyonStateChanged

onStateChanged: Event<[EnumValue<UIElementState, number>, EnumValue<UIElementState, number>], void>

Triggered when the element state changes.

ReadonlyonLayoutSizeChanged

onLayoutSizeChanged: Event<[Immutable<Size2>, Immutable<Size2>], void>

Event fired whenever the UI element size changes from a layout update.

Param: oldSize

The old size of the UI element, in points.

Param: newSize

The new size of the UI element, in points.

ReadonlyonRegistrationChanged

onRegistrationChanged: Event<[boolean], void>

Event fired whenever the UI element is registered with or unregistered from a parent element.

Note

This does not mean that the element is currently visible on screen or that it is part of a layout. Use onActiveSurfaceChanged to determine if the element is part of a layout that is currently rendered.

Param: isRegistered

True if the new state is registered in a parent element.

ReadonlyonActiveSurfaceChanged

onActiveSurfaceChanged: Event<[boolean], void>

Event fired whenever the UI element is registered with or unregistered from a surface.

Param: isRegistered

True if the new state is registered in a surface.

Settings

Member Visibility

On This Page

Constructors
Accessors
backgroundColorborderColorborderRadiusBottomLeftborderRadiusBottomRightborderRadiusTopLeftborderRadiusTopRightborderWidthboundsboundsInPixelsclippedBoundsInPixelsclippedVisibleBoundsclippedVisibleBoundsInPixelsclippedVisibleScreenBoundsclippedVisibleScreenBoundsInPixelscontentPaddingBottomcontentPaddingLeftcontentPaddingRightcontentPaddingTopcontextMenudebugFlagsdebugNamedisableddisplayTypedpiScaleelementDepthelementHeightfixedHeightfixedHeightInPixelsfixedWidthfixedWidthInPixelsfocusProxyisAcceptingKeyFocusisActiveisDestroyedisDragEnabledisEditableisEventPassThroughisFocusedisHoveredisHoverEventPassThroughisIgnoreFocusisIgnoringCommandEventsisInteractiveFillisInteractiveStrokeisLayoutBarrierisOnisReceivingHoverEventsisReceivingMouseMoveEventsisReservingFoldoutSpaceisRootDisplayedSeparateisRootVisibleisSortedByNameisUpdatingisVisiblelayoutHorizontalAlignmentlayoutVerticalAlignmentmainElementminimumHeightminimumWidthmultiSelectionAllowednavigationGrouppaddingBottompaddingLeftpaddingRightpaddingTopparentpositionpositionIntegerreadOnlyscreenscreenBoundsscreenBoundsInPixelssearchQueryselectedElementssizeHintsizeHintInPixelsstyletintvisibleBoundsvisibleBoundsInPixelswindow
Methods
animateWithActionanimateWithPropertyanimateWithSetteranimationDelayclearclearCustomCursorclearPingcollapseElementcollapseSelectedcommandEventconvertElementLocalPositionToLocalPositionconvertElementLocalPositionToLocalPositionInPixelsconvertWindowPositionToLocalInPixelsconvertWindowPositionToLocalInPointsconvertWindowPositionToScreenInPixelsconvertWindowPositionToScreenInPointsdeleteSelectiondeselectAlldeselectElementdestroyensureLayoutCurrentexpandElementexpandSelectedexpandToSelectedgetBlockEventsgetBoundsInPixelsgetMainElementgetStyleisAnySelectedEntryExpandableisInBoundsisSelectedEntryALeafisSelectedEntryCollapsedisSelectedEntryExpandedisSelectingEditableEntriesmarkElementDirtymouseEventonActivateonDeactivateonRegisteronTooltipRequestedonUnregisteronUpdatepingrebuildrenameElementrenameSelectedresetDimensionsscrollToElementselectAboveselectBelowselectElementsetBlockEventssetBorderRadiussetBoundssetContentPaddingsetCustomCursorsetFixedHeightsetFixedWidthsetFlexibleHeightsetFlexibleWidthsetFocussetPaddingshortcutActionEventstopAnimationstextInputEventtoPixelstoPixelsVector2toPointstoPointsVector2virtualButtonEventwithBlockedEventsrenderToTexture
Events