ui - Documentation

Namespace

ui is a static object to handle anything related to user interface
ui utility belt can be accessed through window.ui or calling ui directly

ui

Description:

Handling user interface stuff

Source:

js/ui.js, line 105

Classes

CellInfoTab

Methods

(static) bumpGridScroll()

Description:

Add 20% to the grid's scroll height

Source:

js/ui.js, line 317

(static) disableButtons()

Description:

Disable buttons when no project is currently oppened

Source:

js/ui.js, line 386

(static) drawWordWrapByTagField(options)

Description:

Create wordWrapperByTag DOM element

Source:

js/ui.js, line 2175

Parameters:

Name	Type	Description
`options`

(static) log()

Description:

Log a message to the console

Source:

js/ui.log.js, line 8

(static) off(evt, fn)

Description:

Removes an event

Source:

js/ui.js, line 143

Since:

4.3.20

Example

ui.off('transLoaded', (e, opt)=> {
	// do something
})

Parameters:

Name	Type	Description
`evt`	String	Event name
`fn`	function	Function to trigger

(static) on(evt, fn)

Description:

Create a new event with JQuery eventing convenience

Source:

js/ui.js, line 129

Since:

4.3.20

Example

ui.on('transLoaded', (e, opt)=> {
	// do something
})

Parameters:

Name	Type	Description
`evt`	String	Event name
`fn`	function	Function to trigger

(static) onDOMReady(fn)

Description:

This function is called when the DOM is ready. It takes a function as a parameter and calls it immediately if the DOM is already available.
If the DOM is not available, it adds an event listener to call the function when the DOMContentLoaded event is fired.

Source:

js/ui.js, line 194

Parameters:

Name	Type	Description
`fn`	function	The function to be called when the DOM is ready.

(static) onReady(onReadyEvent)

Description:

This function is called when the UI is ready. It takes a function as a parameter and adds it to the onReadyPool if the UI is not initialized.
If the UI is already initialized, it calls all the functions in the onReadyPool and then clears the pool.

Source:

js/ui.js, line 173

Parameters:

Name	Type	Description
`onReadyEvent`	function	The function to be called when the UI is ready.

(static) one(evt, fn)

Description:

Run the event once
Trigger an event and immediately removes it

Source:

js/ui.js, line 154

Since:

4.3.20

Parameters:

Name	Type	Description
`evt`	String	Event name
`fn`	function	Function to trigger

(static) openImportTrans(transFile, optionsopt)

Description:

Open import translator dialog window

Source:

js/ui.js, line 738

Parameters:

Name	Type	Attributes	Description
`transFile`	String		Path to the file
`options`	Object	<optional>	options

(static) openOptionsWindow(options)

Description:

Open Options Window
Can handle both nwjs v2 and legacy

Source:

js/ui.js, line 3869

Example

ui.openOptionsWindow({
    focus: {
        menu: "chatGPT",
        find: "Code Escaping Algorithm"
    }
})

Parameters:

Name Type Description

options

Object

Options

Properties

Name Type Description

focus

String

Focus on specific tab

Properties

Name	Type	Description
`menu`	String	Menu to open
`find`	String	Find text in the opened menu

(static) renderExternalLinks(html)

Description:

Render HTML element to open external link in default browser.

Source:

js/ui.js, line 208

Parameters:

Name	Type	Description
`html`	jQuery	jQuery object to be rendered

(async, static) saveAs(filePath) → {Promise.<string>}

Description:

Open a modal and blocking save as dialog

Source:

js/ui.js, line 7219

Since:

4.3.16

Parameters:

Name	Type	Description
`filePath`	String	Default path of the file

Returns:

Path of the file. Empty when canceled

Type: Promise.<string>

(async, static) saveAsTPP(filePath) → {Promise.<string>}

Description:

Open a modal and blocking save as dialog

Source:

js/ui.js, line 7265

Since:

5.1.6

Parameters:

Name	Type	Description
`filePath`	String	Default path of the file

Returns:

Path of the file. Empty when canceled

Type: Promise.<string>

(static) setCurrentCellText(value, trigger)

Description:

Set Current Cell Text

Source:

js/ui.js, line 2494

Since:

4.12.11

Parameters:

Name	Type	Description
`value`	String	New value
`trigger`	Boolean	Immidiately trigger change event

(static) trigger(evt, fn)

Description:

Trigger an event

Source:

js/ui.js, line 164

Since:

4.3.20

Parameters:

Name	Type	Description
`evt`	String	Event name
`fn`	function	Function to trigger

Events

busyOverlayClosed

Description:

Triggered when busyOverlay closed

Source:

js/ui.js, line 451

Since:

4.3.20

busyOverlayOpened

Description:

Triggered when busyOverlay opened

Source:

js/ui.js, line 439

Since:

4.3.20

dialogRowPropertiesOpened

Description:

Triggered when dialog Row Properties Opened

Source:

js/ui.js, line 3450

loadingScreenIsClosed

Description:

Triggered when loading console closed

Source:

js/ui.legacylog.js, line 75

Since:

4.3.20

loadingScreenIsClosed

Description:

Triggered when loading console closed

Source:

js/ui.log.js, line 122

Since:

4.3.20

optionsWindowClosed

Description:

Triggered when option window is closed

Source:

js/options.js, line 2296

Since:

4.3.20

optionsWindowClosed

Description:

Triggered when option window is closed

Source:

addons/customParser/modelEditor/modelEditor.js, line 29

Since:

4.5.1

optionsWindowOpened

Description:

Triggered when option window is opened

Source:

js/options.js, line 43

Since:

4.3.20