⁘ data.core.catalog

CatalogWatcher

go to → Members

Extends

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) → {common.pool.DisposableObjectEx}

Inherited From:

Watch(p_signal, p_fn, p_listener) → {common.pool.DisposableObjectEx}

Inherited From:

WatchOnce(p_signalId, p_fn, p_listener) → {common.pool.DisposableObjectEx}

Inherited From:

protected_Broadcast(p_signal, …args)

Inherited From:
Initialization

Methods

protectedoverride-me_Init()

Inherited From:

protectedoverride-me_PostInit()

Inherited From:
Utils

Methods

protected_Bind(p_func)

Inherited From:
Pooling

Group of methods related to the NKMjs pooling system.

Members

read-onlyisReleasing :boolean

Inherited From:

Methods

Release()

Inherited From:

protectedoverride-me_CleanUp()

Inherited From:
Misc

Members

catalog :data.core.catalog.Catalog

TODO

read-onlycount :number

TODO

write-onlydeepWatch :boolean

TODO

write-onlyenabled :boolean

TODO

read-onlyisDeepWatchEnabled :boolean

TODO

read-onlyisEnabled :boolean

TODO

owner :*

TODO

Methods

Disable()

Disable this watcher. If a catalog is set, it will be processed and removal signals will be broadcasted.

Enable()

Enable this watcher. If a catalog is set, it will be processed and addition signals will be broadcasted.

Get(p_item) → {*}

TODO

Parameters:
Name Type Description
p_item data.core.catalog.CatalogItem

GetAt(p_index) → {*}

TODO

Parameters:
Name Type Description
p_index number

GetValueKeys(p_value) → {array}

TODO

Parameters:
Name Type Description
p_value *

PreventRelease()

Inherited From:

Set(p_item, p_mappedValue) → {*}

TODO

Parameters:
Name Type Description
p_item data.core.catalog.CatalogItem
p_mappedValue *

protected_AddCatalogContent(p_catalog, p_deepopt)

Goes over the content of a given catalog and calls _OnCatalogItemAdded for each encountered item. This function is useful when the watcher is enabled with a set catalog to go through.

Parameters:
Name Type Attributes Default Description
p_catalog data.core.catalog.Catalog
p_deep boolean <optional>
 false

protectedoverride-me_OnCatalogChanged(p_oldValue)

TODO

Parameters:
Name Type Description
p_oldValue data.core.catalog.Catalog

previously assigned catalog, if any

protectedoverride-me_OnCatalogItemAdded(p_catalog, p_item)

TODO

Parameters:
Name Type Description
p_catalog data.core.catalog.Catalog
p_item data.core.catalog.CatalogItem

protectedoverride-me_OnCatalogItemRemoved(p_catalog, p_item)

TODO

Parameters:
Name Type Description
p_catalog data.core.catalog.Catalog
p_item data.core.catalog.CatalogItem

protectedoverride-me_OnCatalogSorted(p_catalog)

TODO

Parameters:
Name Type Description
p_catalog data.core.catalog.Catalog

protectedoverride-me_OnItemDataReleased(p_item, p_data)

TODO

Parameters:
Name Type Description
p_item data.core.catalog.CatalogItem
p_data *

protected_RemoveCatalogContent(p_catalog, p_deepopt)

Goes over the content of a given catalog and calls _OnCatalogItemRemoved for each encountered item. This function is useful when the watcher is disabled with a set catalog to go through.

Parameters:
Name Type Attributes Default Description
p_catalog data.core.catalog.Catalog
p_deep boolean <optional>
 false