Class Tray

The Tray Popup class.

Inheritance

object

Popup

Popup<Tray>

Tray

Inherited Members

Popup<Tray>.shown

Popup<Tray>.dismissed

Popup<Tray>.SetContainerView(VisualElement)

Popup<Tray>.SetKeyboardDismiss(bool)

Popup<Tray>.SetLastFocusedElement(Focusable)

Popup.keyboardDismissEnabled

Popup.view

Popup.containerView

Popup.referenceView

Popup.contentView

Popup.rootView

Popup.Dismiss()

Popup.Dismiss(DismissType)

Popup.Show()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.AppUI.UI

Assembly: Unity.AppUI.dll

Syntax

public sealed class Tray : Popup<Tray>

Methods

AnimateViewIn()

Start the animation for this popup.

Declaration

protected override void AnimateViewIn()

Overrides

Popup.AnimateViewIn()

AnimateViewOut(DismissType)

Start the hide animation for this popup.

Declaration

protected override void AnimateViewOut(DismissType reason)

Parameters

Type	Name	Description
DismissType	reason	The reason why the popup should be dismissed.

Overrides

Popup.AnimateViewOut(DismissType)

Build(VisualElement, VisualElement)

Build a new Tray component.

Declaration

public static Tray Build(VisualElement referenceView, VisualElement content)

Parameters

Type	Name	Description
VisualElement	referenceView	An arbitrary UI element inside the UI panel.
VisualElement	content	The content to display inside this Tray.

Returns

Type	Description
Tray	The Tray instance.

Exceptions

Type	Condition
ArgumentNullException	If referenceView is null.

GetFocusableElement()

Returns the element that will be focused when the view will become visible.

The default value is `null`.

Declaration

protected override VisualElement GetFocusableElement()

Returns

Type	Description
VisualElement	The element that will be focused when the view will become visible.

Overrides

Popup.GetFocusableElement()

HideView(DismissType)

Called when the popup's Handler has received a k_PopupDismiss message.

Declaration

protected override void HideView(DismissType reason)

Parameters

Type	Name	Description
DismissType	reason	The reason why the popup should be dismissed.

Overrides

Popup.HideView(DismissType)

InvokeShownEventHandlers()

Called when the popup has become visible. This method will invoke any handlers attached to the shown event.

Declaration

protected override void InvokeShownEventHandlers()

Overrides

Popup<Tray>.InvokeShownEventHandlers()

OnLayoutReadyToAnimateIn()

Called when the layout is ready to be animated in.

Declaration

protected override void OnLayoutReadyToAnimateIn()

Overrides

Popup.OnLayoutReadyToAnimateIn()

SetHandleVisible(bool)

Set the handle visibility.

Declaration

public Tray SetHandleVisible(bool value)

Parameters

Type	Name	Description
bool	value	The handle visibility.

Returns

Type	Description
Tray	The Tray instance.

SetPosition(TrayPosition)

Build a new Tray component.

Declaration

public Tray SetPosition(TrayPosition position)

Parameters

Type	Name	Description
TrayPosition	position	The position of the tray.

Returns

Type	Description
Tray	The Tray instance.

SetTransitionDuration(int)

Set the transition duration.

Declaration

public Tray SetTransitionDuration(int durationMs)

Parameters

Type	Name	Description
int	durationMs	The transition duration in milliseconds.

Returns

Type	Description
Tray	The Tray instance.

ShouldAnimate()

Implement this method to know if the popup should call AnimateViewIn() and AnimateViewOut(DismissType) methods or not.

Declaration

protected override bool ShouldAnimate()

Returns

Type	Description
bool	True if you want to animate the popup, False otherwise.

Overrides

Popup.ShouldAnimate()

ShouldDismiss(DismissType)

Dismiss the Popup.

Declaration

protected override bool ShouldDismiss(DismissType reason)

Parameters

Type	Name	Description
DismissType	reason	Why the element has been dismissed.

Returns

Type	Description
bool	True if the element has been dismissed.

Overrides

Popup.ShouldDismiss(DismissType)