public class | source

ElectronApp

You can directly use an instance of this class. electronApp

Constructor Summary

Public Constructor
public	constructor()

Member Summary

Public Members
public	appIcon: *
public	appName: *
public	editorWindow: *

Private Members
private	_contentChanged: *
private	_defaultWindowBounds: {"width": number, "height": number}
private	_initialPatchFile: *
private	_log: *
private	_npm: *
private	_unsavedContentLeave: boolean

Method Summary

Public Methods
public	async addOpPackage(targetDir: , opPackageLocation: ): *
public	cycleFullscreen()
public	async exportProjectFileDialog(exportName: ):
public	init()
public	async installPackages(targetDir: , packageNames: , opName: undefined): *
public	isDocumentEdited(): *
public	openFile(patchFile: *)
public	async openPatch(patchFile: *, rebuildCache: boolean)
public	async pickDirDialog(defaultPath: undefined): *
public	async pickFileDialog(filePath: , asUrl: boolean, filter: []): *
public	async pickOpDirDialog(): *
public	async pickProjectFileDialog(): *
public	reload()
public	async saveFileDialog(defaultPath: , title: undefined, properties: [], filters: []):
public	async saveProjectFileDialog(defaultPath: ):
public	sendTalkerMessage(cmd: , data: )
public	setDocumentEdited(edited: *)
public	updateTitle()

Private Methods
private	_createMenu()
private	_createWindow()
private	_dirDialog(title: , properties: , defaultPath: undefined): *
private	_fileDialog(title: , filePath: undefined, asUrl: boolean, extensions: string[], properties: undefined):
private	_handleError(title: , error: )
private	_initCaches(cb: *)
private	_inspectElements()
private	async _installNpmPackages(packageNames: , targetDir: , opName: undefined): *
private	_loadNpm(cb: undefined)
private	_projectFileDialog(title: , properties: ): *
private	_registerListeners()
private	_registerShortcuts()
private	_reloadWindow()
private	_resetSizeAndPostion()
private	_resetZoom()
private	_showAbout()
private	_toggleDevTools()
private	_unsavedContentDialog(): *
private	_zoomIn()
private	_zoomOut()

Public Constructors

public constructor() source

Public Members

public appIcon: * source

public appName: * source

public editorWindow: * source

Private Members

private _contentChanged: * source

private _defaultWindowBounds: {"width": number, "height": number} source

private _initialPatchFile: * source

private _log: * source

private _npm: * source

private _unsavedContentLeave: boolean source

Public Methods

public async addOpPackage(targetDir: , opPackageLocation: ): * source

Params:

Name	Type	Attribute	Description
targetDir	*
opPackageLocation	*

Return:

public cycleFullscreen() source

public async exportProjectFileDialog(exportName: ): source

Params:

Name	Type	Attribute	Description
exportName	*

Return:

public init() source

public async installPackages(targetDir: , packageNames: , opName: undefined): * source

Params:

Name	Type	Attribute	Description
targetDir	*
packageNames	*
opName	undefined	optional default: undefined

Return:

public isDocumentEdited(): * source

Return:

public openFile(patchFile: *) source

Params:

Name	Type	Attribute	Description
patchFile	*

public async openPatch(patchFile: *, rebuildCache: boolean) source

Params:

Name	Type	Attribute	Description
patchFile	*
rebuildCache	boolean	optional default: true

public async pickDirDialog(defaultPath: undefined): * source

Params:

Name	Type	Attribute	Description
defaultPath	undefined	optional default: undefined

Return:

public async pickFileDialog(filePath: , asUrl: boolean, filter: []): * source

Params:

Name	Type	Attribute	Description
filePath	*
asUrl	boolean	optional default: false
filter	*[]	optional default: []

Return:

public async pickOpDirDialog(): * source

Return:

public async pickProjectFileDialog(): * source

Return:

public reload() source

public async saveFileDialog(defaultPath: , title: undefined, properties: [], filters: []): source

Params:

Name	Type	Attribute	Description
defaultPath	*
title	undefined	optional default: undefined
properties	*[]	optional default: []
filters	*[]	optional default: []

Return:

public async saveProjectFileDialog(defaultPath: ): source

Params:

Name	Type	Attribute	Description
defaultPath	*

Return:

public sendTalkerMessage(cmd: , data: ) source

Params:

Name	Type	Attribute	Description
cmd	*
data	*

public setDocumentEdited(edited: *) source

Params:

Name	Type	Attribute	Description
edited	*

public updateTitle() source

Private Methods

private _createMenu() source

private _createWindow() source

private _dirDialog(title: , properties: , defaultPath: undefined): * source

Params:

Name	Type	Attribute	Description
title	*
properties	*
defaultPath	undefined	optional default: undefined

Return:

private _fileDialog(title: , filePath: undefined, asUrl: boolean, extensions: string[], properties: undefined): source

Params:

Name	Type	Attribute	Description
title	*
filePath	undefined	optional default: undefined
asUrl	boolean	optional default: false
extensions	string[]	optional default: ["*"]
properties	undefined	optional default: undefined

Return:

private _handleError(title: , error: ) source

Params:

Name	Type	Attribute	Description
title	*
error	*

private _initCaches(cb: *) source

Params:

Name	Type	Attribute	Description
cb	*

private _inspectElements() source

private async _installNpmPackages(packageNames: , targetDir: , opName: undefined): * source

Params:

Name	Type	Attribute	Description
packageNames	*
targetDir	*
opName	undefined	optional default: undefined

Return:

private _loadNpm(cb: undefined) source

Params:

Name	Type	Attribute	Description
cb	undefined	optional default: undefined

private _projectFileDialog(title: , properties: ): * source

Params:

Name	Type	Attribute	Description
title	*
properties	*

ElectronApp

Constructor Summary

Member Summary

Method Summary

Public Constructors

public constructor() source

Public Members

public appIcon: * source

public appName: * source

public editorWindow: * source

Private Members

private _contentChanged: * source

private _defaultWindowBounds: {"width": number, "height": number} source

private _initialPatchFile: * source

private _log: * source

private _npm: * source

private _unsavedContentLeave: boolean source

Public Methods

public async addOpPackage(targetDir: *, opPackageLocation: *): * source

Params:

Return:

public cycleFullscreen() source

public async exportProjectFileDialog(exportName: *): * source

Params:

Return:

public init() source

public async installPackages(targetDir: *, packageNames: *, opName: undefined): * source

Params:

Return:

public isDocumentEdited(): * source

Return:

public openFile(patchFile: *) source

Params:

public async openPatch(patchFile: *, rebuildCache: boolean) source

Params:

public async pickDirDialog(defaultPath: undefined): * source

Params:

Return:

public async pickFileDialog(filePath: *, asUrl: boolean, filter: *[]): * source

Params:

Return:

public async pickOpDirDialog(): * source

Return:

public async pickProjectFileDialog(): * source

Return:

public reload() source

public async saveFileDialog(defaultPath: *, title: undefined, properties: *[], filters: *[]): * source

Params:

Return:

public async saveProjectFileDialog(defaultPath: *): * source

Params:

Return:

public sendTalkerMessage(cmd: *, data: *) source

Params:

public setDocumentEdited(edited: *) source

Params:

public updateTitle() source

Private Methods

private _createMenu() source

private _createWindow() source

private _dirDialog(title: *, properties: *, defaultPath: undefined): * source

Params:

Return:

private _fileDialog(title: *, filePath: undefined, asUrl: boolean, extensions: string[], properties: undefined): * source

Params:

Return:

private _handleError(title: *, error: *) source

Params:

private _initCaches(cb: *) source

Params:

private _inspectElements() source

private async _installNpmPackages(packageNames: *, targetDir: *, opName: undefined): * source

Params:

Return:

private _loadNpm(cb: undefined) source

Params:

private _projectFileDialog(title: *, properties: *): * source

Params:

Return:

private _registerListeners() source

public async addOpPackage(targetDir: , opPackageLocation: ): * source

public async exportProjectFileDialog(exportName: ): source

public async installPackages(targetDir: , packageNames: , opName: undefined): * source

public async pickFileDialog(filePath: , asUrl: boolean, filter: []): * source

public async saveFileDialog(defaultPath: , title: undefined, properties: [], filters: []): source

public async saveProjectFileDialog(defaultPath: ): source

public sendTalkerMessage(cmd: , data: ) source

private _dirDialog(title: , properties: , defaultPath: undefined): * source

private _fileDialog(title: , filePath: undefined, asUrl: boolean, extensions: string[], properties: undefined): source

private _handleError(title: , error: ) source

private async _installNpmPackages(packageNames: , targetDir: , opName: undefined): * source

private _projectFileDialog(title: , properties: ): * source