Class TopCollectionWithBottomViewLayoutGenerator<T>
A default layout generator that creates a standard IBaseGrid view of type T
on the top, and a child view of the grid on the bottom
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.DefaultLayouts.Core
Assembly: LemonEdge.ClientCore.dll
Syntax
public abstract class TopCollectionWithBottomViewLayoutGenerator<T> : DefaultLayoutGenerator, ILayoutGenerator where T : IBaseEntity
Type Parameters
Name | Description |
---|---|
T | The type of entity that is in the grid on the top of this layout |
Constructors
TopCollectionWithBottomViewLayoutGenerator(IRootController)
Creates a new default generator that creates a grid on the top with a child view of that grid on the bottom
Declaration
protected TopCollectionWithBottomViewLayoutGenerator(IRootController rootController)
Parameters
Type | Name | Description |
---|---|---|
IRootController | rootController |
Properties
Descriptor
The entity descriptor for type T
Declaration
protected EntityDescriptor Descriptor { get; }
Property Value
Type | Description |
---|---|
EntityDescriptor |
TopViewPercentHeight
Indicates the percentage of the vertical available screen space the top collection grid should take up.
The default is 20
Declaration
protected virtual int TopViewPercentHeight { get; }
Property Value
Type | Description |
---|---|
int |
Methods
CanGenerateLayout(string, string)
Returns true if this is the default layout generator for displaying a collection of type T
Declaration
public override bool CanGenerateLayout(string uniqueLayoutName, string layoutParam)
Parameters
Type | Name | Description |
---|---|---|
string | uniqueLayoutName | The unique layout name to see if it matches the
SetName of entity type |
string | layoutParam | Optionally parameters for this layout |
Returns
Type | Description |
---|---|
bool | True if this is the default layout generator for displaying a collection of type |
Overrides
GenerateAdditionalTabsForLayout(LayoutDescriptor)
Provides any inheriting implementation the option to generate additional tabs for the layout before it is returned
Declaration
protected virtual Task GenerateAdditionalTabsForLayout(LayoutDescriptor rootDescriptor)
Parameters
Type | Name | Description |
---|---|---|
LayoutDescriptor | rootDescriptor | The top level descriptor to add additional tabs to |
Returns
Type | Description |
---|---|
Task | A task indicating the completion of the operation |
GenerateLayout(string, string)
Generates a layout with a grid for the collection of entities of type T
on the top, with a
sub view of the specified GetChildView(ViewDescriptorInstance) on the bottom
Declaration
public override Task<LayoutDescriptor> GenerateLayout(string uniqueLayoutName, string layoutParam)
Parameters
Type | Name | Description |
---|---|---|
string | uniqueLayoutName | The unique layout name of the layout to be generated |
string | layoutParam | ANy optional parameters for generating the layout with |
Returns
Type | Description |
---|---|
Task<LayoutDescriptor> | A layout with a grid for the collection of entities of type |
Overrides
GetBottomView(ViewDescriptorInstance)
Provides the inheriting implementation the ability to create the type of view that will be a child to the collection grid on the bottom of this layout
Declaration
protected abstract Task<ViewDescriptorInstance> GetBottomView(ViewDescriptorInstance topView)
Parameters
Type | Name | Description |
---|---|---|
ViewDescriptorInstance | topView | The top view collection grid |
Returns
Type | Description |
---|---|
Task<ViewDescriptorInstance> | The view that should be a child of the |