Class EntityStructureController

A standard base structure controller that uses the IEntityStructureView to visually display the structure of an IEntitySetBase and all the IAllocationPath setup within it

The view includes an instrument/path filter control to highlight paths within the structure

These are dynamically locked/visible depending on what this view is operating against. It may be working against a transaction, instrument, entity, entity set, etc.
Inheritance
System.Object
ModelViewController
EntityStructureController
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: LemonEdge.Client.Core.Views
Assembly: ClientCore.dll
Syntax
public class EntityStructureController : ModelViewController, IModelViewController

Constructors

EntityStructureController(IEntityStructureView)

Creates a new EntityStructureController

Declaration
public EntityStructureController(IEntityStructureView view)
Parameters
Type Name Description
IEntityStructureView view

The IEntityStructureView view implementation using the UI components of the client application. Som clients, like the console, will not implement this view as they can not visualize the structure to the user.

Properties

Controls

Adds two filtering controls to the IEntityStructureView for the type of instrument or path.

These are dynamically locked/visible depending on what this view is operating against. It may be working against a transaction, instrument, entity, entity set, etc.

Declaration
public IEnumerable<ControlDisplayInfo> Controls { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<ControlDisplayInfo>

SelectedItemForSubViews

Returns the currently selected entity

Declaration
public override object SelectedItemForSubViews { get; }
Property Value
Type Description
System.Object
Overrides

StructureView

The IEntityStructureView this controller uses

Declaration
public IEntityStructureView StructureView { get; }
Property Value
Type Description
IEntityStructureView

Methods

Clear()

Resets and clears the structure diagram view

Declaration
public override Task Clear()
Returns
Type Description
System.Threading.Tasks.Task
Overrides

DisplayUI()

Determins the IEntitySetBase this structure is for and uses the EntitySetStructure helper to load the diagram information for visualizing by the IEntityStructureView

Declaration
public override Task DisplayUI()
Returns
Type Description
System.Threading.Tasks.Task

A task indicating the completion of the operation
Overrides

GetInstrumentFilter(IBaseEntity, IBaseEntity, IEntityRetriever)

Returns a queryable filter that ensures the instruments that this diagram can be filtered to are only those within this IEntitySet itself

Declaration
public Task<QueryableFilter> GetInstrumentFilter(IBaseEntity currentItem, IBaseEntity parentItem, IEntityRetriever context)
Parameters
Type Name Description
IBaseEntity currentItem

The current item being displayed that this filter is for
IBaseEntity parentItem

The parent item of this entity
IEntityRetriever context

The context this is operating so we can include any pending changes in the filter
Returns
Type Description
System.Threading.Tasks.Task<QueryableFilter>

A queryable filter that ensures the instruments that this diagram can be filtered to are only those within this IEntitySet itself

GetPathFilter(IBaseEntity, IBaseEntity, IEntityRetriever)

Returns a queryable filter that ensures the paths that this diagram can be filtered to are only those within this IEntitySet itself

Declaration
public Task<QueryableFilter> GetPathFilter(IBaseEntity currentItem, IBaseEntity parentItem, IEntityRetriever context)
Parameters
Type Name Description
IBaseEntity currentItem

The current item being displayed that this filter is for
IBaseEntity parentItem

The parent item of this entity
IEntityRetriever context

The context this is operating so we can include any pending changes in the filter
Returns
Type Description
System.Threading.Tasks.Task<QueryableFilter>

A queryable filter that ensures the paths that this diagram can be filtered to are only those within this IEntitySet itself

GetSet()

The parent IEntitySet this structure diagram is of

Declaration
public IEntitySetBase GetSet()
Returns
Type Description
IEntitySetBase

The parent IEntitySet this structure diagram is of

InitAsync()

Resets the structure diagram view and initializes the filters allowed

Declaration
public override Task InitAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides

InitCommands(IList<ViewCommand>)

Declaration
protected override void InitCommands(IList<ViewCommand> commands)
Parameters
Type Name Description
System.Collections.Generic.IList<ViewCommand> commands
Overrides

OnSelectedItemUpdated()

Indicates the views selected item has changed

Declaration
public Task OnSelectedItemUpdated()
Returns
Type Description
System.Threading.Tasks.Task

OnValuePropertyChanged(Object, PropertyChangedEventArgs)

Redisplays the structure highlighting the selected filtered path on the structure

Declaration
protected void OnValuePropertyChanged(object sender, PropertyChangedEventArgs e)
Parameters
Type Name Description
System.Object sender

The EntityStructureController.FilterValues that have changed
System.ComponentModel.PropertyChangedEventArgs e

The filter value property that has changed

Implements

Extension Methods