import {BasicApplication} from '@osjs/client/src/basic-application.js'

public class | source

BasicApplication

Extends:

@osjs/event-emitter~EventEmitter → BasicApplication

Basic Application Helper

A class for helping creating basic applications with open/load/create functionality. Also sets the internal proc args for sessions.

Constructor Summary

Public Constructor
public	constructor(core: Core, proc: Application, win: Window, options: BasicApplicationOptions) Basic Application Constructor

Member Summary

Public Members
public	core: Core Core instance reference
public	options: BasicApplicationOptions Basic Application Options
public	proc: Application Application instance reference
public	win: Window Window instance reference

Method Summary

Public Methods
public	create() Create new file
public	createDialog(type: string, cb: Function, options: object) Creates a new dialog of a type
public	createNew() Create new file
public	createOpenDialog(options: object) Creates a new load dialog
public	createSaveDialog(options: object) Creates a new save dialog
public	destroy() Destroys all Basic Application internals
public	getDialogOptions(type: string): object Gets options for a dialog
public	init(): Promise<boolean> Initializes the application
public	open(file: VFSFile) Opens given file
public	save(file: VFSFile) Saves given file
public	updateWindowTitle() Updates the window title to match open file

Private Methods
private	_createTitle(prefix: string): string Creates the window title
private	_setFile(item: VFSFile, eventName: string) Sets file from open/save action

Public Constructors

public constructor(core: Core, proc: Application, win: Window, options: BasicApplicationOptions) source

Basic Application Constructor

Params:

Name	Type	Attribute	Description
core	Core		OS.js Core API
proc	Application		The application process
win	Window		The main application window
options	BasicApplicationOptions	optional default: {}	Basic application options

Public Members

public core: Core source

Core instance reference

public options: BasicApplicationOptions source

Basic Application Options

public proc: Application source

Application instance reference

public win: Window source

Window instance reference

Public Methods

public create() source

Create new file

Does not do any actual VFS operation

public createDialog(type: string, cb: Function, options: object) source

Creates a new dialog of a type

Params:

Name	Type	Attribute	Description
type	string		Dialog type
cb	Function		Callback
options	object	optional	Override options

public createNew() source

Create new file

See:

BasicApplication#create

public createOpenDialog(options: object) source

Creates a new load dialog

Params:

Name	Type	Attribute	Description
options	object	optional	Dialog options

public createSaveDialog(options: object) source

Creates a new save dialog

Params:

Name	Type	Attribute	Description
options	object	optional	Dialog options

public destroy() source

Destroys all Basic Application internals

public getDialogOptions(type: string): object source

Gets options for a dialog

Params:

Name	Type	Attribute	Description
type	string		Dialog type

Return:

object

public init(): Promise<boolean> source

Initializes the application

Return:

Promise<boolean>

public open(file: VFSFile) source

Opens given file

Does not do any actual VFS operation

Params:

Name	Type	Attribute	Description
file	VFSFile		A file

public save(file: VFSFile) source

Saves given file

Does not do any actual VFS operation

Params:

Name	Type	Attribute	Description
file	VFSFile		A file

public updateWindowTitle() source

Updates the window title to match open file

Private Methods

private _createTitle(prefix: string): string source

Creates the window title

Params:

Name	Type	Attribute	Description
prefix	string		Title prefix

Return:

string

private _setFile(item: VFSFile, eventName: string) source

Sets file from open/save action

Params:

Name	Type	Attribute	Description
item	VFSFile		File
eventName	string		Event to fire