Class TopSingleWithBottomViewLayoutGenerator<T>
A default layout generator that creates a standard IBaseDefaultSingleView<T> view of type T
on the top, and another view on the bottom
If T
implements IHasVersion, then this creates the top view on the left 75%, and adds a HasVersion view on the top right 25%
Inheritance
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views.DefaultLayouts
Assembly: ClientCore.dll
Syntax
public abstract class TopSingleWithBottomViewLayoutGenerator<T> : DefaultLayoutGenerator, ILayoutGenerator where T : IBaseEntity
Type Parameters
Name | Description |
---|---|
T | The type of entity that is in the grid on the left of this layout |
Constructors
TopSingleWithBottomViewLayoutGenerator()
Creates a new default generator that creates a single view on the top with a custom view on the bottom
Declaration
public TopSingleWithBottomViewLayoutGenerator()
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 view should take up.
The default is 20
Declaration
protected virtual int TopViewPercentHeight { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
Methods
CanGenerateLayout(String, String)
Returns true if this is the default layout generator for displaying an instance of type T
Declaration
public override bool CanGenerateLayout(string uniqueLayoutName, string layoutParam)
Parameters
Type | Name | Description |
---|---|---|
System.String | uniqueLayoutName | The unique layout name to see if it matches the ItemName of entity type |
System.String | layoutParam | Optionaly parameters for this layout |
Returns
Type | Description |
---|---|
System.Boolean | True if this is the default layout generator for displaying an instance 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 |
---|---|
System.Threading.Tasks.Task | A task indicating the completion of the operation |
GenerateLayout(String, String)
Generates a layout with a standard IBaseDefaultSingleView<T> view of type T
on the top, and another view on the bottom
Declaration
public override Task<LayoutDescriptor> GenerateLayout(string uniqueLayoutName, string layoutParam)
Parameters
Type | Name | Description |
---|---|---|
System.String | uniqueLayoutName | The unique layout name of the layout to be generated |
System.String | layoutParam | ANy optional parameters for generating the layout with |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LayoutDescriptor> | A layout with a standard IBaseDefaultSingleView<T> view of type |
Overrides
GetBottomView(ViewDescriptorInstance)
Provides the inheriting implementation the ability to create the type of view that will be created on the bottom of this layout
Declaration
protected abstract Task<ViewDescriptorInstance> GetBottomView(ViewDescriptorInstance topView)
Parameters
Type | Name | Description |
---|---|---|
ViewDescriptorInstance | topView |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ViewDescriptorInstance> | The view that should be at thebottom of this layout |