Class SharedNode

Undocumented

Hierarchy (view full)

SharedObservable
- SharedNode

Constructors

constructor

new SharedNode(): SharedNode
Returns SharedNode
Inherited from SharedObservable.constructor

Properties

asJSON

asJSON: string

Gets the object as serialized JSON string. Or sets serialized JSON (to fill this object's metadata by the metadata included within the JSON)

canceled

canceled: boolean

Undocumented

checkboxVisible

checkboxVisible: boolean

Undocumented

checked

checked: boolean

Undocumented

children

children: SharedNodeList

Undocumented

collection

collection: SharedObservable

Undocumented

dataSource

dataSource: any

Undocumented

deleted

deleted: boolean

Set to true after deletion so that 'change' event is called and item is removed from UI lists.

dontNotify

dontNotify: boolean

Undocumented

expandCount

expandCount: number

Undocumented

expanded

expanded: boolean

Undocumented

expanding

expanding: boolean

Undocumented

globalIndex

globalIndex: number

Undocumented

handlerID

handlerID: string

Undocumented

hidden

hidden: boolean

Undocumented

id

id: number

Gets integer id of the object

isObservable

isObservable: boolean

Whether this object can be listened (e.g. for 'change' event)

isStatusBarSource

isStatusBarSource: boolean

Is source for status bar informations.

level

level: number

Undocumented

loadPromise

loadPromise: Promise<any>

Undocumented

loadUpdateTm

loadUpdateTm: number

Undocumented

modified

modified: boolean

Undocumented

nodePath

nodePath: string

Undocumented

objectType

objectType: string

Gets the object type as string

parent

parent: SharedNode

Undocumented

partlyChecked

partlyChecked: boolean

Undocumented

persistentID

persistentID: string

Undocumented

pos

pos: number

Undocumented

priority

priority: number

Undocumented

statusInfo

statusInfo: Promise<any>

Undocumented

title

title: string

Undocumented

Methods

addChild

addChild(...params): SharedNode
Parameters
- Rest ...params: any[]
Returns SharedNode
Undocumented
- Defined in src/types/Native.ts:6132

addChildren

addChildren(aDataSourceList, aHandlerID): void
Parameters
- aDataSourceList: SharedList<SharedObservable>
- aHandlerID: string
Returns void
Undocumented
- Defined in src/types/Native.ts:6133

beginUpdate

beginUpdate(): void
Returns void
Undocumented
Overrides SharedObservable.beginUpdate
- Defined in src/types/Native.ts:6153

checkUpdate

checkUpdate(interval): void
Parameters
- interval: number
Returns void
Undocumented
Overrides SharedObservable.checkUpdate
- Defined in src/types/Native.ts:6156

clear

clear(): void
Returns void
Undocumented
- Defined in src/types/Native.ts:6138

collapse

collapse(): void
Returns void
Undocumented
- Defined in src/types/Native.ts:6126

containsChild

containsChild(child): boolean
Parameters
- child: SharedNode
Returns boolean
Undocumented
- Defined in src/types/Native.ts:6136

doCut

doCut(data): Promise<any>
Parameters
- data: Base
Returns Promise<any>
Undocumented
Inherited from SharedObservable.doCut
- Defined in src/types/Native.ts:213

endUpdate

endUpdate(): boolean
Returns boolean
Undocumented
Overrides SharedObservable.endUpdate
- Defined in src/types/Native.ts:6154

endUpdateAndGetDeleted

endUpdateAndGetDeleted(): SharedNodeList
Returns SharedNodeList
Undocumented
- Defined in src/types/Native.ts:6155

findChild

findChild(persistentID): SharedNode
Parameters
- persistentID: string
Returns SharedNode
Undocumented
- Defined in src/types/Native.ts:6134

getChildNode

getChildNode(...params): SharedNode
Parameters
- Rest ...params: any[]
Returns SharedNode
Undocumented
- Defined in src/types/Native.ts:6131

getClassName

getClassName(): string
Gets class name of the object.

Returns string
Inherited from SharedObservable.getClassName
- Defined in src/types/Native.ts:198

getCopy

getCopy(): SharedNode
Returns SharedNode
Undocumented
- Defined in src/types/Native.ts:6152

getExpandedChildren

getExpandedChildren(): SharedNodeList
Returns SharedNodeList
Undocumented
- Defined in src/types/Native.ts:6129

getModifiedChildrenDataSources

getModifiedChildrenDataSources(): SharedList<SharedObservable>
Returns SharedList<SharedObservable>
Undocumented
- Defined in src/types/Native.ts:6137

getPersistentJSON

getPersistentJSON(): string
Returns string
Undocumented
Inherited from SharedObservable.getPersistentJSON
- Defined in src/types/Native.ts:214

getTree

getTree(): SharedTree
Returns SharedTree
Undocumented
- Defined in src/types/Native.ts:6116

getVisibleDescendantCount

getVisibleDescendantCount(): number
Returns number
Undocumented
- Defined in src/types/Native.ts:6127

hideUnselectedAsync

hideUnselectedAsync(hide): Promise<any>
Parameters
- hide: boolean
Returns Promise<any>
Undocumented
- Defined in src/types/Native.ts:6158

isMarked

isMarked(id): boolean
Parameters
- id: number
Returns boolean
Undocumented
Inherited from SharedObservable.isMarked
- Defined in src/types/Native.ts:212

locked

locked(func): void
Call defined method with locked data so user can access them.
Parameters
- func: (() => any)
  Method to call
  - - (): any
    - Returns any
Returns void
Inherited from SharedObservable.locked
- Defined in src/types/Native.ts:192

modifyAsync

modifyAsync(...params): Promise<any>
Call defined method with the item locked for modifications.
Parameters
- Rest ...params: any[]
Returns Promise<any>
Inherited from SharedObservable.modifyAsync
- Defined in src/types/Native.ts:262

notifyChanged

notifyChanged(...params): void
Notifies that the object was changed (e.g. to force visual update etc.)
Parameters
- Rest ...params: any[]
Returns void
Inherited from SharedObservable.notifyChanged
- Defined in src/types/Native.ts:308

remove

remove(idx): boolean
Parameters
- idx: number
Returns boolean
Undocumented
- Defined in src/types/Native.ts:6135

setMarked

setMarked(id, value): void
Parameters
- id: number
- value: boolean
Returns void
Undocumented
Inherited from SharedObservable.setMarked
- Defined in src/types/Native.ts:211

toString

toString(): string
Returns string
Undocumented
Overrides SharedObservable.toString
- Defined in src/types/Native.ts:6157

toUriString

toUriString(): string
Returns string
Undocumented
Inherited from SharedObservable.toUriString
- Defined in src/types/Native.ts:263

updateStatus

updateStatus(): void
Returns void
Undocumented
Inherited from SharedObservable.updateStatus
- Defined in src/types/Native.ts:297

Events

event_change

event_change: ((changeType, ...additionalArgs) => void)

Event is called when object is somehow changed

See App.listen

Type declaration

- (changeType, ...additionalArgs): void
- Parameters
  - changeType: string
    additional change type (can have values like 'tracklist', 'deleted', 'title' or undefined)
  - Rest ...additionalArgs: any[]
  Returns void

Example

app.listen(object, 'change', (changeType) => {  });

event_destroying

event_destroying: (() => void)

Event is called when object is going to destroy

See App.listen

Type declaration

- (): void
- Returns void

event_statuschange

event_statuschange: (() => void)

Event is called when status info of the object is changed

See App.listen

Type declaration

- (): void
- Returns void

Class SharedNode

Undocumented

Hierarchy (view full)

Index

Constructors

Properties

Methods

Events

Constructors

constructor

Returns SharedNode

Properties

asJSON

canceled

Undocumented

checkboxVisible

Undocumented

checked

Undocumented

children

Undocumented

collection

Undocumented

dataSource

Undocumented

deleted

dontNotify

Undocumented

expandCount

Undocumented

expanded

Undocumented

expanding

Undocumented

globalIndex

Undocumented

handlerID

Undocumented

hidden

Undocumented

id

isObservable

isStatusBarSource

level

Undocumented

loadPromise

Undocumented

loadUpdateTm

Undocumented

modified

Undocumented

nodePath

Undocumented

objectType

parent

Undocumented

partlyChecked

Undocumented

persistentID

Undocumented

pos

Undocumented

priority

Undocumented

statusInfo

Undocumented

tag

Undocumented

title

Undocumented

Methods

addChild

Parameters

Returns SharedNode

Undocumented

addChildren

Parameters

Returns void

Undocumented

beginUpdate