Class Application<P, E>

Represents an x4 application, which is typically a single page app. You should inherit Application to define yours. Application derives from BaseComponent so you can use that to implement a global messaging system.

Example


// in yout main caode
let app = new Application( );

app.events.close.on( ( ev ) => {
    ... do something
});

// somewhere else in the source
function xxx( ) {
    let app = Application.instance( );
    app.events.close.emit( new Events.close() );
}

Type Parameters

P extends ApplicationProps = ApplicationProps
E extends ApplicationEventMap = ApplicationEventMap

Hierarchy

BaseComponent<P, E>
- Application

Constructors

constructor

new Application<P, E>(props): Application<P, E>
Type Parameters
- P extends ApplicationProps<P> = ApplicationProps
- E extends ApplicationEventMap = ApplicationEventMap
Parameters
- props: P
Returns Application<P, E>
Overrides BaseComponent.constructor
- Defined in src/application.ts:104

Properties

`Private` #m_timers

#m_timers: Map<string, Function>

`Private` m_app_name

m_app_name: string

`Private` m_app_uid

m_app_uid: string

`Private` m_app_version

m_app_version: string

`Private` m_local_storage

m_local_storage: Settings

`Private` m_mainView

m_mainView: Component<CProps<CEventMap>, CEventMap>

`Protected` m_props

m_props: P

`Private` m_router

m_router: Router

`Private` m_touch_count

m_touch_count: number

`Private` m_touch_time

m_touch_time: number

`Private` m_user_data

m_user_data: any

`Static` `Private` self

self: Application<ApplicationProps, ApplicationEventMap> = null

Accessors

app_name

get app_name(): string
Returns string
- Defined in src/application.ts:143

app_uid

get app_uid(): string
Returns string
- Defined in src/application.ts:147

app_version

get app_version(): string
Returns string
- Defined in src/application.ts:151

history

get history(): any
Returns any
- Defined in src/application.ts:163

local_storage

get local_storage(): Settings
Returns Settings
- Defined in src/application.ts:155

mainView

get mainView(): Component<CProps<CEventMap>, CEventMap>
Returns Component<CProps<CEventMap>, CEventMap>
- Defined in src/application.ts:208
set mainView(root): void
Parameters
- root: Component<CProps<CEventMap>, CEventMap>
Returns void
- Defined in src/application.ts:204

router

get router(): Router
Returns Router
- Defined in src/application.ts:136

user_data

get user_data(): any
Returns any
- Defined in src/application.ts:159

Methods

ApplicationCreated

ApplicationCreated(): void
Returns void
- Defined in src/application.ts:132

_emit

_emit(eventName, e): void
Parameters
- eventName: string
- e: BasicEvent
Returns void
Inherited from BaseComponent._emit
- Defined in src/x4events.ts:291

_off

_off(eventName, callback): void
Parameters
- eventName: string
- callback: EventCallback<BasicEvent>
Returns void
Inherited from BaseComponent._off
- Defined in src/x4events.ts:550

_on

_on(eventName, callback, capturing?): EventDisposer
Parameters
- eventName: string
- callback: EventCallback<BasicEvent>
- capturing: boolean = false
Returns EventDisposer
Inherited from BaseComponent._on
- Defined in src/x4events.ts:513

_once

_once(eventName, callback): Promise<unknown>
Parameters
- eventName: string
- callback: EventCallback<BasicEvent>
Returns Promise<unknown>
Inherited from BaseComponent._once
- Defined in src/x4events.ts:412

_signal

_signal(eventName, e, delay?): void
Parameters
- eventName: string
- e: BasicEvent
- delay: number = -1
Returns void
Inherited from BaseComponent._signal
- Defined in src/x4events.ts:348

defaults

defaults(events): void
define a set of default handlers in one call
Parameters
- events: MapEvents<E>
Returns void
Inherited from BaseComponent.defaults
- Defined in src/x4events.ts:495

disableZoomWheel

disableZoomWheel(): void
Returns void
- Defined in src/application.ts:216

disposeTimers

disposeTimers(): void
stop all timers

Returns void
Inherited from BaseComponent.disposeTimers
- Defined in src/base_component.ts:122

emit

emit<K>(type, event?): void
emit an event you can stop propagation of event or prevent default
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- Optional event: E[K]
  
  event data
Returns void
Inherited from BaseComponent.emit
- Defined in src/x4events.ts:287

enableTouchDblClick

enableTouchDblClick(): void
Returns void
- Defined in src/application.ts:230

enterModal

enterModal(enter): void
Parameters
- enter: boolean
Returns void
- Defined in src/application.ts:227

listen

listen(events): void
define a set of listeners in one call
Parameters
- events: MapEvents<E>
Returns void
Inherited from BaseComponent.listen
- Defined in src/x4events.ts:484

mapPropEvents

mapPropEvents<N>(props, ...elements): void
Type Parameters
- N extends string | number | symbol
Parameters
- props: P
- Rest ...elements: N[]
Returns void
Inherited from BaseComponent.mapPropEvents
- Defined in src/base_component.ts:143

off

off<K>(type, callback): void
stop listening to an event
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- callback: ((ev) => any)
  
  callback to remove (must be the same as in on )
  - - (ev): any
    - Parameters
      
      ev: E[K]
      
      Returns any
Returns void
Inherited from BaseComponent.off
- Defined in src/x4events.ts:545

on

on<K>(type, callback): EventDisposer
listen for an event
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- callback: ((ev) => any)
  
  callback to call
  - - (ev): any
    - Parameters
      
      ev: E[K]
      
      Returns any
Returns EventDisposer
Inherited from BaseComponent.on
- Defined in src/x4events.ts:508

once

once<K>(type, callback): void
handle an event one time
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- callback: ((ev) => any)
  
  callback to call when event is signaled
  - - (ev): any
    - Parameters
      
      ev: E[K]
      
      Returns any
Returns void
Promise if callback is null

take care with that because if the event is never fired and you await it, the system may overflow
Inherited from BaseComponent.once
- Defined in src/x4events.ts:407

removeAllListeners

removeAllListeners(eventName): void
remove all listeners for an event
Parameters
- eventName: string
  
  event name
Returns void
Inherited from BaseComponent.removeAllListeners
- Defined in src/x4events.ts:571

removeDefaultHandler

removeDefaultHandler(eventName, callback): void
remove the previous default handler installed for an event
Parameters
- eventName: string
  
  event name
- callback: EventCallback<BasicEvent>
  
  callback handler to remove (must be the same as in setDefaultHandler)
Returns void
Inherited from BaseComponent.removeDefaultHandler
- Defined in src/x4events.ts:464

setDefaultHandler

setDefaultHandler(eventName, callback): void
set the event default handler
Parameters
- eventName: string
  
  name of the event
- callback: EventCallback<BasicEvent>
  
  callback to call when the event is not handled (and preventDeault has not been called)
Returns void
Inherited from BaseComponent.setDefaultHandler
- Defined in src/x4events.ts:434

setMainView

setMainView(root, clearBefore): void
define the application root object (MainView)

Example
```
let myApp = new Application( ... );
let mainView = new VLayout( ... );
myApp.mainView = mainView;
```
Parameters
- root: Component<CProps<CEventMap>, CEventMap>
- clearBefore: boolean
Returns void
- Defined in src/application.ts:182

setTitle

setTitle(title): void
Parameters
- title: string
Returns void
- Defined in src/application.ts:212

signal

signal<K>(type, event, delay?): void
signal en event signaled event are notification : no way to prevent default not stop propagation
Type Parameters
- K extends string | number | symbol
Parameters
- type: K
- event: E[K]
  
  event data
- delay: number = -1
Returns void
Inherited from BaseComponent.signal
- Defined in src/x4events.ts:344

singleShot

singleShot(callback, timeout?): void
Parameters
- callback: TimerCallback
- timeout: number = 0
Returns void
Inherited from BaseComponent.singleShot
- Defined in src/base_component.ts:133

startTimer

startTimer(name, timeout, repeat?, callback?): void
start a new timer
Parameters
- name: string
  
  timer name
- timeout: number
  
  time out in ms
- repeat: boolean = true
  
  if true this is an auto repeat timer
- callback: TimerCallback = null
  
  if !null, the callback to call else a EvTimer is fired
Returns void
Inherited from BaseComponent.startTimer
- Defined in src/base_component.ts:88

stopTimer

stopTimer(name): void
stop the given timer
Parameters
- name: string
Returns void
Inherited from BaseComponent.stopTimer
- Defined in src/base_component.ts:113

`Static` instance

instance(): Application<ApplicationProps, ApplicationEventMap>
the application singleton

Returns Application<ApplicationProps, ApplicationEventMap>
- Defined in src/application.ts:86

Class Application<P, E>

Example

Type Parameters

P extends ApplicationProps = ApplicationProps

E extends ApplicationEventMap = ApplicationEventMap

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

P extends ApplicationProps<P> = ApplicationProps

E extends ApplicationEventMap = ApplicationEventMap

Parameters

props: P

Returns Application<P, E>

Properties

Private #m_timers

Private m_app_name

Private m_app_uid

Private m_app_version

Private m_local_storage

Private m_mainView

Protected m_props

Private m_router

Private m_touch_count

Private m_touch_time

Private m_user_data

Static Private self

Accessors

app_name

Returns string

app_uid

Returns string

app_version

Returns string

history

Returns any

local_storage

Returns Settings

mainView

Returns Component<CProps<CEventMap>, CEventMap>

Parameters

root: Component<CProps<CEventMap>, CEventMap>

Returns void

router

Returns Router

user_data

Returns any

Methods

ApplicationCreated

Returns void

_emit

Parameters

eventName: string

e: BasicEvent

Returns void

_off

Parameters

eventName: string

callback: EventCallback<BasicEvent>

Returns void

_on

Parameters

eventName: string

callback: EventCallback<BasicEvent>

capturing: boolean = false

Returns EventDisposer

_once

Parameters

eventName: string

callback: EventCallback<BasicEvent>

Returns Promise<unknown>

_signal

Parameters

eventName: string

e: BasicEvent

`Private` #m_timers

`Private` m_app_name

`Private` m_app_uid

`Private` m_app_version

`Private` m_local_storage

`Private` m_mainView

`Protected` m_props

`Private` m_router

`Private` m_touch_count

`Private` m_touch_time

`Private` m_user_data

`Static` `Private` self

`Optional` event: E[K]

`Rest` ...elements: N[]