Home Reference Source
import {Area} from './scripts/screen/ScreenArea.js'
public class | source

Area

Extends:

scripts/core/ui_base.js~ui_base.UIBase → Area

Direct Subclass:

Editor

Indirect Subclass:

MenuBarEditor

Base class for all editors

Static Method Summary

Static Public Methods
public static

define(): {"tagname": string, "areaname": *, "flag": *, "uiname": *, "icon": *}

public static

getActiveArea(type: *): *

Get active area as defined by push_ctx_active and pop_ctx_active.

public static
public static

newSTRUCT(): *

public static

register(cls: *)

public static

unregister(cls: *)

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public
public
public

flag: *

public get
public set
public
public
public
public
public
public

pos: *

public
public

size: *

public
Private Members
private

Method Summary

Public Methods
public
public
public

copy(): *

public

draw()

public
public

Return a list of keymaps used by this editor

public
public

init()

public

loadData(obj: *)

public

loadJSON(obj: *): *

public

loadSTRUCT(reader: *)

public

loadSTRUCT(reader: *)

public

makeAreaSwitcher(container: *): *

public

makeHeader(container: *, add_note_area: boolean, make_draggable: boolean): *

public

called when editors are swapped with another editor type

public
public
public

called when editors are swapped with another editor type

public

on_fileload(isActiveEditor: *)

public

on_resize(size: *, oldsize: *)

public

pop_ctx_active(dontSetLastRef: boolean)

see push_ctx_active

public

push_ctx_active(dontSetLastRef: boolean)

public

saveData(): {"_area_id": *, "areaName": *}

public

setCSS()

public

toJSON(): *

public

update()

Private Methods
private
private
private

Static Public Methods

public static define(): {"tagname": string, "areaname": *, "flag": *, "uiname": *, "icon": *} source

Return:

{"tagname": string, "areaname": *, "flag": *, "uiname": *, "icon": *}

public static getActiveArea(type: *): * source

Get active area as defined by push_ctx_active and pop_ctx_active.

Type should be an Area subclass, if undefined the last accessed area will be returned.

Params:

NameTypeAttributeDescription
type *

Return:

*

public static makeAreasEnum(): * source

Return:

*

public static newSTRUCT(): * source

Return:

*

public static register(cls: *) source

Params:

NameTypeAttributeDescription
cls *

public static unregister(cls: *) source

Params:

NameTypeAttributeDescription
cls *

Public Constructors

public constructor() source

Public Members

public areaDragToolEnabled: boolean source

public borderLock: * source

public flag: * source

public get floating: * source

public set floating source

public helppicker: * source

public inactive: boolean source

public maxSize: undefined[] source

public minSize: number[] source

public owning_sarea: * source

public pos: * source

public saved_uidata: * source

public size: * source

public switcher: * source

Private Members

private _area_id: * source

Public Methods

public afterSTRUCT() source

public buildDataPath(): * source

Return:

*

public copy(): * source

Return:

*

public draw() source

public getBarHeight(): * source

Return:

*

public getKeyMaps(): Array<KeyMap> source

Return a list of keymaps used by this editor

Return:

Array<KeyMap>

public getScreen() source

public init() source

public loadData(obj: *) source

Params:

NameTypeAttributeDescription
obj *

public loadJSON(obj: *): * source

Params:

NameTypeAttributeDescription
obj *

Return:

*

public loadSTRUCT(reader: *) source

Params:

NameTypeAttributeDescription
reader *

public loadSTRUCT(reader: *) source

Params:

NameTypeAttributeDescription
reader *

public makeAreaSwitcher(container: *): * source

Params:

NameTypeAttributeDescription
container *

Return:

*

public makeHeader(container: *, add_note_area: boolean, make_draggable: boolean): * source

Params:

NameTypeAttributeDescription
container *
add_note_area boolean
  • optional
  • default: true
make_draggable boolean
  • optional
  • default: true

Return:

*

public on_area_active() source

called when editors are swapped with another editor type

public on_area_blur() source

public on_area_focus() source

public on_area_inactive() source

called when editors are swapped with another editor type

public on_fileload(isActiveEditor: *) source

Params:

NameTypeAttributeDescription
isActiveEditor *

public on_resize(size: *, oldsize: *) source

Params:

NameTypeAttributeDescription
size *
oldsize *

public pop_ctx_active(dontSetLastRef: boolean) source

see push_ctx_active

Params:

NameTypeAttributeDescription
dontSetLastRef boolean
  • optional
  • default: false

public push_ctx_active(dontSetLastRef: boolean) source

Params:

NameTypeAttributeDescription
dontSetLastRef boolean
  • optional
  • default: false

public saveData(): {"_area_id": *, "areaName": *} source

Return:

{"_area_id": *, "areaName": *}

public setCSS() source

public toJSON(): * source

Return:

*

public update() source

Private Methods

private _getSavedUIData(): * source

Return:

*

private _get_v_suffix(): string source

Return:

string

private _isDead(): boolean source

Return:

boolean