projects/wms-framework/src/lib/regionsframework/AllActiveRegion.ts
AllActive region
Properties |
Methods |
|
Accessors |
| activeViews |
Type : IViewsCollection
|
|
Inherited from
Region
|
|
Defined in
Region:43
|
| Behaviors |
Type : IRegionBehaviorCollection
|
Default value : new RegionBehaviorCollection(this)
|
|
Inherited from
Region
|
|
Defined in
Region:76
|
|
The region behaviors in the region |
| Name |
Type : string
|
Default value : null
|
|
Inherited from
Region
|
|
Defined in
Region:52
|
|
The region name |
| RegionManager |
Type : IRegionManager
|
|
Inherited from
Region
|
|
Defined in
Region:60
|
|
The region manager of the region |
| viewNames |
Type : SimpleDictionary<string | unknown>
|
Default value : new SimpleDictionary()
|
|
Inherited from
Region
|
|
Defined in
Region:68
|
|
The registered view by name in the region |
| views |
Type : IViewsCollection
|
|
Inherited from
Region
|
|
Defined in
Region:44
|
| Deactivate | ||||||
Deactivate(view: any)
|
||||||
|
Inherited from
Region
|
||||||
|
Defined in
Region:23
|
||||||
|
Deactivate view in region
Parameters :
Returns :
void
|
| Remove | ||||||
Remove(view: unknown)
|
||||||
|
Inherited from
Region
|
||||||
|
Defined in
Region:36
|
||||||
|
Remove view from region Since both Active an Views are the same collection it is only required to remove from ActiveViews.
Parameters :
Returns :
void
|
| Activate | ||||||
Activate(view: unknown)
|
||||||
|
Inherited from
Region
|
||||||
|
Defined in
Region:116
|
||||||
|
Activate a view in the region
Parameters :
Returns :
void
|
| Add |
Add(view: unknown, viewName?: string, flag?: boolean)
|
|
Inherited from
Region
|
|
Defined in
Region:132
|
|
Adds a new view to the region.
Returns :
IRegionManager
{IRegionManager} |
| GetView | ||||||
GetView(name: string)
|
||||||
|
Inherited from
Region
|
||||||
|
Defined in
Region:171
|
||||||
|
Returns a view registered with the given name
Parameters :
Returns :
unknown
{unknown} |
| Private GetViewInRegion | ||||||
GetViewInRegion(view: unknown)
|
||||||
|
Inherited from
Region
|
||||||
|
Defined in
Region:197
|
||||||
|
Parameters :
Returns :
any
|
| ActiveViews |
getActiveViews()
|
import { Region, ViewsCollection } from './Region';
import { IViewsCollection } from './IViewsCollection';
/**
* AllActive region
*
* @export
* @class AllActiveRegion
* @extends {Region}
* @wType Microsoft.Practices.Prism.Regions.AllActiveRegion
*/
export class AllActiveRegion extends Region {
public get ActiveViews(): IViewsCollection {
return this.Views;
}
/**
* Deactivate view in region
*
* @param {*} view
* @memberof Region
*/
Deactivate(view: any): void {
throw new Error('Unable to deactivate a view in a AllActiveRegion');
}
/**
* Remove view from region
* Since both Active an Views are the same collection
* it is only required to remove from ActiveViews.
*
* @param {unknown} view
* @memberof Region
* @wIgnore
*/
Remove(view: unknown): void {
(this.Views as ViewsCollection).remove(view);
}
}