Class WidgetBuilder
A utility class for building complex pages of interactive widgets in Socially Distant. This class is used by the System Settings screen to generate settings fields.
Inherited Members
Namespace: SociallyDistant.Core.UI.Recycling
Assembly: SociallyDistant.Framework.dll
Syntax
public sealed class WidgetBuilderProperties
ShowUncategorizedFirst
Gets or sets a value indicating whether uncategorized widgets should be shown first, before any categories.
Declaration
public bool ShowUncategorizedFirst { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
SkipEmptySections
Gets or sets a value indicating whether empty sections should have their section headers generated.
Declaration
public bool SkipEmptySections { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
AddImage(Texture2D, Color?, SectionWidgetBuilder?)
Add a picture to the page.
Declaration
public WidgetBuilder AddImage(Texture2D texture, Color? color = null, SectionWidgetBuilder? section = null)Parameters
| Type | Name | Description |
|---|---|---|
| Texture2D | texture | A Microsoft.Xna.Framework.Graphics.Texture2D instance to render. |
| Color? | color | A color tint to apply to the image. |
| SectionWidgetBuilder | section | An optional section to add the image to. |
Returns
| Type | Description |
|---|---|
| WidgetBuilder | This. |
AddLabel(string, SectionWidgetBuilder?)
Create a text widget.
Declaration
public WidgetBuilder AddLabel(string text, SectionWidgetBuilder? section = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | text | The text to display in the text widget. |
| SectionWidgetBuilder | section | An pptional section to assign the widget to. |
Returns
| Type | Description |
|---|---|
| WidgetBuilder | This. |
AddSection(string, out SectionWidgetBuilder)
Add a section to the page.
Declaration
public WidgetBuilder AddSection(string title, out SectionWidgetBuilder section)Parameters
| Type | Name | Description |
|---|---|---|
| string | title | Text to display as the section's title. |
| SectionWidgetBuilder | section | A SectionWidgetBuilder instance representing this section. |
Returns
| Type | Description |
|---|---|
| WidgetBuilder | This. |
AddSection<TSection>(out TSection)
Adds a new custom section widget to the page
Declaration
public WidgetBuilder AddSection<TSection>(out TSection section) where TSection : SectionWidgetBuilder, new()Parameters
| Type | Name | Description |
|---|---|---|
| TSection | section | An instance of |
Returns
| Type | Description |
|---|---|
| WidgetBuilder | This. |
Type Parameters
| Name | Description |
|---|---|
| TSection | Any class deriving SectionWidgetBuilder with a public default constructor. |
AddWidget(IRecyclableWidgetBuilder, ISectionWidgetBuilder?)
Add a widget to the page, or to a specific section in the page.
Declaration
public WidgetBuilder AddWidget(IRecyclableWidgetBuilder recyclableWidgetBuilder, ISectionWidgetBuilder? section)Parameters
| Type | Name | Description |
|---|---|---|
| IRecyclableWidgetBuilder | recyclableWidgetBuilder | A widget to add to the page. |
| ISectionWidgetBuilder | section | An optional ISectionWidgetBuilder to add the widget to. If none is provided, the widget will be added to a default section. |
Returns
| Type | Description |
|---|---|
| WidgetBuilder | This. |
AddWidget(IRecyclableWidgetBuilder, SectionWidgetBuilder?)
Add a widget to the page, or to a specific section in the page.
Declaration
public WidgetBuilder AddWidget(IRecyclableWidgetBuilder recyclableWidgetBuilder, SectionWidgetBuilder? section = null)Parameters
| Type | Name | Description |
|---|---|---|
| IRecyclableWidgetBuilder | recyclableWidgetBuilder | A widget to add to the page. |
| SectionWidgetBuilder | section | An optional SectionWidgetBuilder to add the widget to. If none is provided, the widget will be added to a default section. |
Returns
| Type | Description |
|---|---|
| WidgetBuilder | This. |
Begin()
Start building a new page.
Declaration
public void Begin()Build()
Build the current page into a list of RecyclableWidgetController instances that can be rendered with the RecyclableWidgetList<TContainerWidget> list adapter.
Declaration
public IList<RecyclableWidgetController> Build()Returns
| Type | Description |
|---|---|
| IList<RecyclableWidgetController> | A list of RecyclableWidgetController instances representing this page. |
PopDefaultSection()
Pops the current default section widget off the section stack.
Declaration
public WidgetBuilder PopDefaultSection()Returns
| Type | Description |
|---|---|
| WidgetBuilder | This. |
PushDefaultSection(string, out SectionWidgetBuilder)
Creates a new section and sets it as the default section for new widgets.
Declaration
public WidgetBuilder PushDefaultSection(string sectionTitle, out SectionWidgetBuilder widgetBuilder)Parameters
| Type | Name | Description |
|---|---|---|
| string | sectionTitle | Text to display as the section's title. |
| SectionWidgetBuilder | widgetBuilder | A SectionWidgetBuilder instance representing this section. |
Returns
| Type | Description |
|---|---|
| WidgetBuilder | This. |