⁘ ui.core.helpers

PopIn

A PopIn is a lightweight container with absolute positioning added to an object. It is attached to a specific position in parent screen-space, and can follow an object if attached to one. Use cases :

  • input field feedback
  • overlay search box (closable)
  • informational popins
  • contextual menu

If used at document level, the PopIn will attempt to find the best possible placement to stay visible (moving left/right/up/down)

go to → Members

Extends

Signals

common.SIGNALRELEASING

Inherited From:

common.SIGNALRELEASED

Inherited From:

ui.core.UI_SIGNALFIRST_PAINT

Inherited From:

ui.core.UI_SIGNALPAINTED

Inherited From:

ui.core.UI_SIGNALUNPAINTED

Inherited From:

ui.core.UI_SIGNALCHILD_ADDED

Inherited From:

ui.core.UI_SIGNALCHILD_MOVED

Inherited From:

ui.core.UI_SIGNALCHILD_REMOVED

Inherited From:
Mode

Members

mode :string

TODO

read-onlyMODE_ANCHOR :string

TODO

read-onlyMODE_FLOAT_INSIDE :string

TODO

read-onlyMODE_FLOAT_OUTSIDE :string

TODO

Placement

Members

read-onlyBOTTOM :object

TODO

read-onlyBOTTOM_LEFT :object

TODO

read-onlyBOTTOM_RIGHT :object

TODO

read-onlyCENTER :object

TODO

read-onlyLEFT :object

TODO

origin :object

Point inside the pop-in to pin at position

placement :object

TODO

TODO

read-onlyTOP :object

TODO

read-onlyTOP_LEFT :object

TODO

read-onlyTOP_RIGHT :object

TODO

Child Management

Members

read-onlycount :number

Inherited From:

read-onlydisplayList :array

Inherited From:

Methods

Add(p_displayObject, p_containeropt, p_cssClassopt, p_indexopt)

Inherited From:

At(p_index) → {ui.core.DisplayObject|ui.core.DisplayObject}

Inherited From:

Move(p_displayObject, p_index)

Inherited From:

Remove(p_displayObject)

Inherited From:

RemoveAt(p_index) → {ui.core.DisplayObject}

Inherited From:

protectedoverride-me_OnChildAdded(p_displayObject, p_index)

Inherited From:

protectedoverride-me_OnChildMoved(p_displayObject, p_index, p_oldIndex)

Inherited From:

protectedoverride-me_OnChildRemoved(p_displayObject, p_index)

Inherited From:
Styling

Methods

protectedoverride-me_Style()

Inherited From:
Rendering

Members

read-onlyisPainted

Inherited From:

visible :boolean

Inherited From:

staticprotected__usePaintCallback

Inherited From:

Methods

protectedoverride-me_OnPaintChange()

Inherited From:

protectedoverride-me_PostRender()

Inherited From:

protectedoverride-me_Render()

Inherited From:
Hierarchy

Members

parent :ui.core.DisplayObjectContainer

Inherited From:

Methods

BringToFront()

Inherited From:

protectedoverride-me_OnParentChanged(p_oldParent)

Inherited From:
Broadcasting

This section list the main methods used to watch/unwatch signals on this object. For more info on signals, see signals

Methods

Unwatch(p_signal, p_fn, p_listener) → {ui.core.DisposableHTMLElement}

Inherited From:

Watch(p_signal, p_fn, p_listener) → {ui.core.DisposableHTMLElement}

Inherited From:

WatchOnce(p_signalId, p_fn, p_listener) → {ui.core.DisposableHTMLElement}

Inherited From:

protected_Broadcast(p_signal, …args)

Inherited From:
Pooling

Group of methods related to the NKMjs pooling system.

Members

read-onlyisReleasing :boolean

Inherited From:

Methods

override-me_Wake()

Inherited From:

PreventRelease()

Inherited From:

Release()

Inherited From:

protectedoverride-me_CleanUp()

Inherited From:
Misc

Members

anchor :Element

TODO

content :function|ui.core.DisplayObject

TODO

context :Element

TODO

read-onlyflags

Inherited From:

read-onlyhost

Inherited From:

options :object

TODO

order :number

Inherited From:

read-onlywrapper

Inherited From:

Methods

protected_OnOptionsProcessed(p_options)

TODO

Parameters:
Name Type Description
p_options object

protected_RegisterLocalRequestHandler(p_requestType, p_fn)

Inherited From:

protected_UnregisterLocalRequestHandler(p_requestType, p_fn)

Inherited From:

staticPop(p_options)

TODO

Parameters:
Name Type Description
p_options object
Properties
Name Type Description
context Element
content function | ui.core.DisplayObject
anchor Element