Skip to main content

Class: WindowNamespace

Hierarchy​

  • NamespaceBase

    ↳ WindowNamespace

Methods​

closeAllFloatingWidgets​

▸ closeAllFloatingWidgets(): Promise<void>

Returns​

Promise<void>


closeFloatingWidget​

▸ closeFloatingWidget(floatingWidgetId): Promise<void>

Parameters​

NameType
floatingWidgetIdstring

Returns​

Promise<void>


getCurrentWindowTree​

▸ getCurrentWindowTree(): Promise<PaneRemWindowTree>

Returns​

Promise<PaneRemWindowTree>


getFocusedPaneId​

▸ getFocusedPaneId(): Promise<string>

Returns​

Promise<string>


getLastFocusedPane​

▸ getLastFocusedPane(): Promise<undefined | string>

Returns​

Promise<undefined | string>


getOpenPaneIds​

▸ getOpenPaneIds(): Promise<string[]>

Returns​

Promise<string[]>


getOpenPaneRemId​

▸ getOpenPaneRemId(paneId): Promise<undefined | string>

Parameters​

NameType
paneIdundefined | string

Returns​

Promise<undefined | string>


getOpenPaneRemIds​

▸ getOpenPaneRemIds(): Promise<string[]>

Returns​

Promise<string[]>


getURL​

▸ getURL(): Promise<string>

Returns​

Promise<string>


isFloatingWidgetOpen​

▸ isFloatingWidgetOpen(floatingWidgetId): Promise<boolean>

Parameters​

NameType
floatingWidgetIdstring

Returns​

Promise<boolean>


isOnPage​

▸ isOnPage(page): Promise<boolean>

Parameters​

NameType
pageQueue

Returns​

Promise<boolean>


openFloatingWidget​

▸ openFloatingWidget(fileName, position, classContainer?, closeWhenClickOutside?): Promise<string>

Parameters​

NameType
fileNamestring
positionObject
position.bottom?number
position.left?number
position.right?number
position.top?number
classContainer?string
closeWhenClickOutside?boolean

Returns​

Promise<string>


openRem​

▸ openRem(rem): Promise<void>

Parameters​

NameType
remRem

Returns​

Promise<void>


openWidgetInPane​

▸ openWidgetInPane(fileName, contextData?): Promise<string[]>

Parameters​

NameType
fileNamestring
contextData?Record<string, any>

Returns​

Promise<string[]>


openWidgetInRightSidebar​

▸ openWidgetInRightSidebar(fileName, contextData?): Promise<string[]>

Parameters​

NameType
fileNamestring
contextData?Record<string, any>

Returns​

Promise<string[]>


releaseKeys​

▸ releaseKeys(floatingWidgetId, keys): Promise<void>

Parameters​

NameType
floatingWidgetIdstring
keysstring[]

Returns​

Promise<void>


setCurrentWindowTreeFromString​

▸ setCurrentWindowTreeFromString(treeString): Promise<void>

Parameters​

NameType
treeStringstring

Returns​

Promise<void>


setFloatingWidgetPosition​

▸ setFloatingWidgetPosition(floatingWidgetId, position): Promise<void>

Parameters​

NameType
floatingWidgetIdstring
positionObject
position.bottom?number
position.left?number
position.right?number
position.top?number

Returns​

Promise<void>


setFocusedPaneId​

▸ setFocusedPaneId(paneId): Promise<void>

Parameters​

NameType
paneIdstring

Returns​

Promise<void>


setRemWindowTree​

▸ setRemWindowTree(tree): Promise<void>

Parameters​

NameType
treeRemIdWindowTree

Returns​

Promise<void>


setURL​

▸ setURL(url): Promise<void>

Parameters​

NameType
urlstring

Returns​

Promise<void>


stealKeys​

▸ stealKeys(floatingWidgetId, keys): Promise<void>

Parameters​

NameType
floatingWidgetIdstring
keysstring[]

Returns​

Promise<void>