Class Dropdown

Namespace

MLEM.Ui.Elements

Assembly

MLEM.Ui.dll

A dropdown component to use inside of a UiSystem. A dropdown is a component that contains a hidden panel which is displayed upon pressing the dropdown button. Elements can be added to the dropdown's Panel through AddElement(Element, int) or one of its overloads, which additionally causes them to have correct gamepad navigation behavior.

public class Dropdown : Button, IGenericDataHolder, ILayoutItem

Inheritance

object

GenericDataHolder

Element

Button

Dropdown

Implements

IGenericDataHolder

ILayoutItem

Inherited Members

Button.Texture

Button.NormalColor

Button.HoveredTexture

Button.HoveredColor

Button.SelectedTexture

Button.SelectedColor

Button.DisabledTexture

Button.DisabledColor

Button.Text

Button.Tooltip

Button.IsDisabled

Button.TruncateTextIfLong

Button.CanSelectDisabled

Button.AutoDisableCondition

Button.CanBeSelected

Button.CanBePressed

Button.Draw(GameTime, SpriteBatch, float, SpriteBatchContext)

Element.Epsilon

Element.RecursionLimit

Element.System

Element.Controls

Element.Parent

Element.Root

Element.Scale

Element.Anchor

Element.Size

Element.ScaledSize

Element.AutoSizeAddedAbsolute

Element.ScaledAutoSizeAddedAbsolute

Element.PositionOffset

Element.ScaledOffset

Element.ScaledPadding

Element.ScaledChildPadding

Element.ChildPaddedArea

Element.UnscrolledArea

Element.Area

Element.DisplayArea

Element.ScrollOffset

Element.ScaledScrollOffset

Element.IsHidden

Element.Priority

Element.Transform

Element.CanBeMoused

Element.CanAutoAnchorsAttach

Element.SetWidthBasedOnChildren

Element.SetHeightBasedOnChildren

Element.TreatSizeAsMinimum

Element.TreatSizeAsMaximum

Element.PreventParentSpill

Element.DrawAlpha

Element.IsMouseOver

Element.IsSelected

Element.IsSelectedActive

Element.AreaDirty

Element.AutoNavGroup

Element.DebugName

Element.Style

Element.SelectionIndicator

Element.SelectionColor

Element.ActionSound

Element.SecondActionSound

Element.Padding

Element.ChildPadding

Element.MouseEnterAnimation

Element.MouseExitAnimation

Element.OnDrawn

Element.OnUpdated

Element.OnPressed

Element.OnSecondaryPressed

Element.OnSelected

Element.OnDeselected

Element.OnMouseEnter

Element.OnMouseExit

Element.OnTouchEnter

Element.OnTouchExit

Element.OnTextInput

Element.OnAreaDirty

Element.OnAreaUpdated

Element.OnStyleInit

Element.OnMousedElementChanged

Element.OnTouchedElementChanged

Element.OnSelectedElementChanged

Element.GetTabNextElement

Element.GetGamepadNextElement

Element.OnChildAdded

Element.OnChildRemoved

Element.OnAddedToUi

Element.OnRemovedFromUi

Element.Children

Element.PlayingAnimations

Element.SortedChildren

Element.Input

Element.ParentArea

Element.AddChild<T>(T, int)

Element.RemoveChild(Element)

Element.RemoveChildren(Func<Element, bool>)

Element.SetSortedChildrenDirty()

Element.UpdateSortedChildrenIfDirty()

Element.ForceUpdateSortedChildren()

Element.SetAreaDirty()

Element.UpdateAreaIfDirty()

Element.ForceUpdateArea()

Element.SetAreaAndUpdateChildren(RectangleF)

Element.CalcActualSize(RectangleF)

Element.GetAreaForAutoAnchors()

Element.GetLowestChild(Func<Element, bool>, bool)

Element.GetRightmostChild(Func<Element, bool>, bool)

Element.GetLowestOlderSibling(Func<Element, bool>, bool)

Element.GetOlderSibling(Func<Element, bool>)

Element.GetSiblings(Func<Element, bool>)

Element.GetChildren<T>(Func<T, bool>, bool, bool)

Element.GetChildren(Func<Element, bool>, bool, bool)

Element.GetParentTree()

Element.GetTotalCoveredArea(bool)

Element.GetRelevantChildren()

Element.Update(GameTime)

Element.DrawTransformed(GameTime, SpriteBatch, float, SpriteBatchContext)

Element.GetElementUnderPos(Vector2)

Element.PlayAnimation(UiAnimation)

Element.StopAnimation(UiAnimation)

Element.ToString()

Element.AndChildren(Action<Element>)

Element.ReorderChildren(Comparison<Element>)

Element.ReverseChildren(int, int?)

Element.ScaleTransform(float, Vector2?)

Element.OnChildAreaDirty(Element, bool)

Element.OnParentAreaDirty(Element, bool)

Element.TransformInverse(Vector2)

Element.TransformInverseAll(Vector2)

Element.OnLayoutRecursion(int, ILayoutItem)

Element.OnLayoutRecursionSettled(int, bool)

Element.AddedToUi(UiSystem, RootElement)

Element.RemovedFromUi()

GenericDataHolder.SetData<T>(string, T)

GenericDataHolder.GetData<T>(string)

GenericDataHolder.GetDataKeys()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

ElementExtensions.AddTooltip(Element, Paragraph.TextCallback)

ElementExtensions.AddTooltip(Element, Tooltip)

ElementExtensions.AddTooltip(Element, string)

Constructors

Dropdown(Anchor, Vector2, TextCallback, TextCallback, float, bool, bool)

Creates a new dropdown with the given settings

public Dropdown(Anchor anchor, Vector2 size, Paragraph.TextCallback textCallback = null, Paragraph.TextCallback tooltipTextCallback = null, float panelHeight = 0, bool scrollPanel = false, bool autoHidePanelScrollbar = true)

Parameters

anchor Anchor

The dropdown's anchor

size Vector2

The dropdown button's size

textCallback Paragraph.TextCallback

The text displayed on the dropdown button

tooltipTextCallback Paragraph.TextCallback

The text displayed as a tooltip when hovering over the dropdown button

panelHeight float

The height of the Panel. If this is 0, the panel will be set to SetHeightBasedOnChildren.

scrollPanel bool

Whether this dropdown's Panel should automatically add a scroll bar to scroll towards elements that are beyond the area it covers.

autoHidePanelScrollbar bool

Whether this dropdown's Panel's scroll bar should be hidden automatically if the panel does not contain enough children to allow for scrolling. This only has an effect if scrollPanel is true.

Dropdown(Anchor, Vector2, float, bool, bool)

Creates a new dropdown with the given settings and no text or tooltip.

public Dropdown(Anchor anchor, Vector2 size, float panelHeight = 0, bool scrollPanel = false, bool autoHidePanelScrollbar = true)

Parameters

anchor Anchor

The dropdown's anchor

size Vector2

The dropdown button's size

panelHeight float

The height of the Panel. If this is 0, the panel will be set to SetHeightBasedOnChildren.

scrollPanel bool

Whether this dropdown's Panel should automatically add a scroll bar to scroll towards elements that are beyond the area it covers.

autoHidePanelScrollbar bool

Whether this dropdown's Panel's scroll bar should be hidden automatically if the panel does not contain enough children to allow for scrolling. This only has an effect if scrollPanel is true.

Dropdown(Anchor, Vector2, string, string, float, bool, bool)

Creates a new dropdown with the given settings

public Dropdown(Anchor anchor, Vector2 size, string text = null, string tooltipText = null, float panelHeight = 0, bool scrollPanel = false, bool autoHidePanelScrollbar = true)

Parameters

anchor Anchor

The dropdown's anchor

size Vector2

The dropdown button's size

text string

The text displayed on the dropdown button

tooltipText string

The text displayed as a tooltip when hovering over the dropdown button

panelHeight float

The height of the Panel. If this is 0, the panel will be set to SetHeightBasedOnChildren.

scrollPanel bool

Whether this dropdown's Panel should automatically add a scroll bar to scroll towards elements that are beyond the area it covers.

autoHidePanelScrollbar bool

Whether this dropdown's Panel's scroll bar should be hidden automatically if the panel does not contain enough children to allow for scrolling. This only has an effect if scrollPanel is true.

Fields

HoveredTextColor

A style property containing the Microsoft.Xna.Framework.Color that a paragraph added to this dropdown through AddElement(TextCallback, GenericCallback, int) should have when hovered. For elements added through other overloads of AddElement(Element, int), this property has no effect.

public StyleProp<Color> HoveredTextColor

Field Value

StyleProp<Color>

OnOpenedOrClosed

An event that is invoked when IsOpen changes

public Element.GenericCallback OnOpenedOrClosed

Field Value

Element.GenericCallback

TextColor

A style property containing the Microsoft.Xna.Framework.Color that a paragraph added to this dropdown through AddElement(TextCallback, GenericCallback, int) should have by default. For elements added through other overloads of AddElement(Element, int), this property has no effect.

public StyleProp<Color> TextColor

Field Value

StyleProp<Color>

Properties

Arrow

The Image that contains the currently active arrow texture for this dropdown, which is either ClosedArrowTexture or OpenedArrowTexture.

public Image Arrow { get; }

Property Value

Image

ArrowPadding

A style property containing the Padding that should be passed to the Arrow child element.

public StyleProp<Padding> ArrowPadding { get; set; }

Property Value

StyleProp<Padding>

ClosedArrowTexture

A style property containing the TextureRegion that should be displayed on this dropdown's Arrow when the dropdown is closed (IsOpen is false).

public StyleProp<TextureRegion> ClosedArrowTexture { get; set; }

Property Value

StyleProp<TextureRegion>

IsOpen

This property stores whether the dropdown is currently opened or not

public bool IsOpen { get; set; }

Property Value

bool

OpenedArrowTexture

A style property containing the TextureRegion that should be displayed on this dropdown's Arrow when the dropdown is open (IsOpen is true).

public StyleProp<TextureRegion> OpenedArrowTexture { get; set; }

Property Value

StyleProp<TextureRegion>

Panel

The panel that this dropdown contains. It will be displayed upon pressing the dropdown button. To add elements to this panel, you can use AddElement(Element, int) or one of its overloads, which additionally causes them to have correct gamepad navigation behavior.

public Panel Panel { get; }

Property Value

Panel

Methods

AddElement(Element, int)

Adds an element to this dropdown's Panel

public Element AddElement(Element element, int index = -1)

Parameters

element Element

The element to add

index int

The index to add the child at, or -1 to add it to the end of the Children list

Returns

Element

AddElement(TextCallback, GenericCallback, int)

Adds a pressable Paragraph element to this dropdown's Panel. By default, the paragraph's text color will change from TextColor to HoveredTextColor when hovering over it.

public Paragraph AddElement(Paragraph.TextCallback text, Element.GenericCallback pressed = null, int index = -1)

Parameters

text Paragraph.TextCallback

The text to display

pressed Element.GenericCallback

The resulting paragraph's OnPressed event

index int

The index to add the child at, or -1 to add it to the end of the Children list

Returns

Paragraph

AddElement(string, GenericCallback, int)

Adds a pressable Paragraph element to this dropdown's Panel

public Paragraph AddElement(string text, Element.GenericCallback pressed = null, int index = -1)

Parameters

text string

The text to display

pressed Element.GenericCallback

The resulting paragraph's OnPressed event

index int

The index to add the child at, or -1 to add it to the end of the Children list

Returns

Paragraph

InitStyle(UiStyle)

Initializes this element's StyleProp<T> instances using the ui system's UiStyle.

protected override void InitStyle(UiStyle style)

Parameters

style UiStyle

The new style