Interface IContextAPI

The context interface to be used in components

interface IContextAPI {
    Builder?: TGetContextBuilder;
    ContextKey: IProperty<string>;
    Event: IEvent<IContext>;
    AddHandler(handler: TContextHandler, itemtype?: ContextItemType): void;
    Fire(cobj?: IContext): void;
    Get(): IContext;
    IsMine(cobj: IContext): boolean;
    Own(cobj: IContext): void;
    RemoveHandler(handler: TContextHandler): void;
    Set(cobj: IContext, callhandlers?: boolean): void;
}

Index

Properties

Builder? ContextKey Event

Methods

AddHandler Fire Get IsMine Own RemoveHandler Set

Properties

`Optional`Builder

Builder?: TGetContextBuilder

The builder for data context from the current component. Can be assigned by the owner component.

`Readonly`ContextKey

ContextKey: IProperty<string>

A context key added to the context produced by the current component

`Readonly`Event

Event: IEvent<IContext>

The context event.

Methods

AddHandler

AddHandler(handler: TContextHandler, itemtype?: ContextItemType): void
Add a context handler for receiving context from other widgets.
Parameters
- handler: TContextHandler
  The context handler callback.
- Optionalitemtype: ContextItemType
  Is specified adds a handler only for specific context item type.
Returns void
- Defined in mia/ts/componentbase/context.ts:90

Fire

Fire(cobj?: IContext): void
Raises the context event. When called with null event data Context.GetBuilder is called in the owner component.
Parameters
- Optionalcobj: IContext
  The context object - if left undefined or null event data Context.GetBuilder is called in the owner component.
Returns void
- Defined in mia/ts/componentbase/context.ts:84

Get

Get(): IContext
Gets the context object of the current component - NOTE: uses primarily the context builder, secondarily the currently stored context object.

Returns IContext
- Defined in mia/ts/componentbase/context.ts:79

IsMine

IsMine(cobj: IContext): boolean
Checks if the current component is the owner of the context object.
Parameters
- cobj: IContext
  The context object
Returns boolean
- Defined in mia/ts/componentbase/context.ts:69

Own

Own(cobj: IContext): void
Makes the current component the owner of the context object.
Parameters
- cobj: IContext
  The context object.
Returns void
- Defined in mia/ts/componentbase/context.ts:64

RemoveHandler

RemoveHandler(handler: TContextHandler): void
Remove a context handler.
Parameters
- handler: TContextHandler
  The context handler callback.
Returns void
- Defined in mia/ts/componentbase/context.ts:95

Set

Set(cobj: IContext, callhandlers?: boolean): void
Sets the context object for the current component - NOTE: does not fire the Context event.
Parameters
- cobj: IContext
  The context object
- Optionalcallhandlers: boolean
  Call context handlers in the owner component.
Returns void
- Defined in mia/ts/componentbase/context.ts:77