Class ScrollableView

Framework View

The tag name of this view is <scrollable>.

Definition

Namespace: StardewUI.Widgets
Assembly: StardewUI.dll

Provides a content container and accompanying scrollbar.

[StardewUI.GenerateDescriptor]
public class ScrollableView : StardewUI.Widgets.ComponentView<T>, 
    StardewUI.Layout.IFloatContainer

Inheritance
Object ⇦ DecoratorView<T> ⇦ ComponentView<T> ⇦ ScrollableView

Implements
IFloatContainer

Remarks

This does not add any extra UI elements aside from the scrollbar, like ScrollableFrameView does, and is more suitable for highly customized menus.

Currently supports only vertically-scrolling content.

Members

Constructors

Name	Description
ScrollableView()

Properties

Name	Description
ActualBounds `actual-bounds`	The bounds of this view relative to the origin (0, 0). (Inherited from DecoratorView<T>)
ClipOrigin `clip-origin`	Origin position for the ClipSize. (Inherited from DecoratorView<T>)
ClipSize `clip-size`	Size of the clipping rectangle, outside which content will not be displayed. (Inherited from DecoratorView<T>)
Content `content`	The content to make scrollable.
ContentBounds `content-bounds`	The true bounds of this view's content; i.e. ActualBounds excluding margins. (Inherited from DecoratorView<T>)
FloatingBounds `floating-bounds`	Contains the bounds of all floating elements in this view tree, including the current view and all descendants. (Inherited from DecoratorView<T>)
FloatingElements `floating-elements`	The floating elements to display relative to this view.
HoveredSubject `hovered-subject`	When Lookup Anything (Pathoschild.LookupAnything) is loaded, this Object or NPC subject is given to lookup anything for it's menu. `(unofficial-mushymato)` (Inherited from DecoratorView<T>)
IsFocusable `is-focusable`	Whether or not the view can receive controller focus, i.e. the stick/d-pad controlled cursor can move to this view. Not generally applicable for mouse controls. (Inherited from DecoratorView<T>)
Layout `layout`	The current layout parameters, which determine how Measure(Vector2) will behave. (Inherited from DecoratorView<T>)
Name `name`	Simple name for this view, used in log/debug output; does not affect behavior. (Inherited from DecoratorView<T>)
Opacity `opacity`	Opacity (alpha level) of the view. (Inherited from DecoratorView<T>)
OuterSize `outer-size`	The true computed layout size resulting from a single Measure(Vector2) pass. (Inherited from DecoratorView<T>)
Peeking `peeking`	Amount of extra distance above/below scrolled content; see Peeking.
PointerEventsEnabled `pointer-events-enabled`	Whether this view should receive pointer events like Click or Drag. (Inherited from DecoratorView<T>)
PointerStyle `pointer-style`	Pointer style to use when this view is hovered. (Inherited from DecoratorView<T>)
Progress `progress`	The Progress of the scrollable view. `(unofficial-mushymato)`
ScreenRead `screen-read`	When a screen reader mod (shoaib.stardewaccess) is loaded, this element will be announced by the screen reader using this value. `(unofficial-mushymato)` (Inherited from DecoratorView<T>)
ScrollbarDownSprite `scrollbar-down-sprite`	The DownSprite used for the scrollbar.
ScrollbarMargin `scrollbar-margin`	The Margin of the scrollbar.
ScrollbarThumbSprite `scrollbar-thumb-sprite`	The ThumbSprite used for the scrollbar.
ScrollbarTrackSprite `scrollbar-track-sprite`	The TrackSprite used for the scrollbar.
ScrollbarUpSprite `scrollbar-up-sprite`	The UpSprite used for the scrollbar.
ScrollbarVisibility `scrollbar-visibility`	The ForcedVisibility of the scrollbar.
ScrollStep `scroll-step`	The ScrollStep of the scrollable view. `(unofficial-mushymato)`
ScrollWithChildren `scroll-with-children`	If set to an axis, specifies that when any child of the view is scrolled into view (using ScrollIntoView(IEnumerable<ViewChild>, Vector2)), then this entire view should be scrolled along with it. (Inherited from DecoratorView<T>)
Tags `tags`	The user-defined tags for this view. (Inherited from DecoratorView<T>)
Tooltip `tooltip`	Tooltip data to display on hover, if any. (Inherited from DecoratorView<T>)
Transform `transform`	Local transformation to apply to this view, including any children and floating elements. (Inherited from DecoratorView<T>)
TransformOrigin `transform-origin`	Relative origin position for any Transform on this view. (Inherited from DecoratorView<T>)
View `view`	(Inherited from ComponentView<T>)
Visibility `visibility`	Drawing visibility for this view. (Inherited from DecoratorView<T>)
ZIndex `z-index`	Z order for this view within its direct parent. Higher indices draw later (on top). (Inherited from DecoratorView<T>)

Methods

Name	Description
ContainsPoint(Vector2)	Checks if a given point, relative to the view's origin, is within its bounds. (Inherited from DecoratorView<T>)
CreateView()	Creates and returns the root view. (Overrides ComponentView<T>.CreateView())
Dispose()	(Inherited from DecoratorView<T>)
Draw(ISpriteBatch)	Draws the content for this view. (Inherited from DecoratorView<T>)
FocusSearch(Vector2, Direction)	Finds the next focusable component in a given direction that does not overlap with a current position. (Inherited from DecoratorView<T>)
GetChildAt(Vector2, Boolean, Boolean)	Finds the child at a given position. (Inherited from DecoratorView<T>)
GetChildPosition(IView)	Computes or retrieves the position of a given direct child. (Inherited from DecoratorView<T>)
GetChildren(Boolean)	Gets the current children of this view. (Inherited from DecoratorView<T>)
GetChildrenAt(Vector2)	Finds all children at a given position. (Inherited from DecoratorView<T>)
GetDefaultFocusChild()	Gets the direct child that should contain cursor focus when a menu or overlay containing this view is first opened. (Inherited from DecoratorView<T>)
HasOutOfBoundsContent()	Checks if the view has content or elements that are all or partially outside the ActualBounds. (Inherited from DecoratorView<T>)
IsDirty()	Checks whether or not the view is dirty - i.e. requires a new layout with a full Measure(Vector2). (Inherited from DecoratorView<T>)
IsVisible(Vector2?)	Checks if the view is effectively visible, i.e. if it has anything to draw. (Inherited from DecoratorView<T>)
Measure(Vector2)	Performs layout on this view, updating its OuterSize, ActualBounds and ContentBounds, and arranging any children in their respective positions. (Inherited from DecoratorView<T>)
OnButtonPress(ButtonEventArgs)	Called when a button press is received while this view is in the focus path. (Inherited from DecoratorView<T>)
OnButtonRepeat(ButtonEventArgs)	Called when a button press is first received, and at recurring intervals thereafter, for as long as the button is held and this view remains in the focus path. (Inherited from DecoratorView<T>)
OnClick(ClickEventArgs)	Called when a click is received within this view's bounds. (Inherited from DecoratorView<T>)
OnDrag(PointerEventArgs)	Called when the view is being dragged (mouse moved while left button held). (Inherited from DecoratorView<T>)
OnDrop(PointerEventArgs)	Called when the mouse button is released after at least one OnDrag(PointerEventArgs). (Inherited from DecoratorView<T>)
OnLayout()	Runs whenever layout occurs as a result of the UI elements changing. (Inherited from DecoratorView<T>)
OnPointerMove(PointerMoveEventArgs)	Called when a pointer movement related to this view occurs. (Inherited from DecoratorView<T>)
OnPropertyChanged(PropertyChangedEventArgs)	Raises the PropertyChanged event. (Inherited from DecoratorView<T>)
OnPropertyChanged(string)	Raises the PropertyChanged event. (Inherited from DecoratorView<T>)
OnUpdate(TimeSpan)	Runs on every update tick. (Inherited from DecoratorView<T>)
OnWheel(WheelEventArgs)	Called when a wheel event is received within this view's bounds. (Overrides DecoratorView<T>.OnWheel(WheelEventArgs))
RegisterDecoratedProperty<TValue>(DecoratedProperty<T, TValue>)	Registers a DecoratedProperty<T, TValue>. (Inherited from DecoratorView<T>)
ScrollIntoView(IEnumerable<ViewChild>, Vector2)	Attempts to scroll the specified target into view, including all of its ancestors, if not fully in view. (Inherited from DecoratorView<T>)

Events

Name	Description
ButtonPress	Event raised when any button on any input device is pressed. (Inherited from DecoratorView<T>)
ButtonRepeat	Event raised when a button is being held while the view is in focus, and has been held long enough since the initial ButtonPress or the previous `ButtonRepeat` to trigger a repeated press. (Inherited from DecoratorView<T>)
Click	Event raised when the view receives a click initiated from any button. (Inherited from DecoratorView<T>)
Drag	Event raised when the view is being dragged using the mouse. (Inherited from DecoratorView<T>)
DragEnd	Event raised when mouse dragging is stopped, i.e. when the button is released. Always raised after the last Drag, and only once per drag operation. (Inherited from DecoratorView<T>)
DragStart	Event raised when mouse dragging is first activated. Always raised before the first Drag, and only once per drag operation. (Inherited from DecoratorView<T>)
LeftClick	Event raised when the view receives a click initiated from the left mouse button, or the controller's action button (A). (Inherited from DecoratorView<T>)
PointerEnter	Event raised when the pointer enters the view. (Inherited from DecoratorView<T>)
PointerLeave	Event raised when the pointer exits the view. (Inherited from DecoratorView<T>)
PointerMove	Event raised when the pointer moves within the view. (Inherited from DecoratorView<T>)
PropertyChanged	(Inherited from DecoratorView<T>)
RightClick	Event raised when the view receives a click initiated from the right mouse button, or the controller's tool-use button (X). (Inherited from DecoratorView<T>)
Wheel	Event raised when the scroll wheel moves. (Inherited from DecoratorView<T>)

Details

Constructors

ScrollableView()

public ScrollableView();

Properties

Content

The content to make scrollable.

public StardewUI.IView Content { get; set; }

Property Value

IView

FloatingElements

The floating elements to display relative to this view.

public System.Collections.Generic.IList<StardewUI.Layout.FloatingElement> FloatingElements { get; set; }

Property Value

IList<FloatingElement>

Peeking

Amount of extra distance above/below scrolled content; see Peeking.

public float Peeking { get; set; }

Property Value

Single

Progress

The Progress of the scrollable view. (unofficial-mushymato)

public float Progress { get; set; }

Property Value

Single

ScrollbarDownSprite

The DownSprite used for the scrollbar.

public StardewUI.Graphics.Sprite ScrollbarDownSprite { get; set; }

Property Value

Sprite

ScrollbarMargin

The Margin of the scrollbar.

public StardewUI.Layout.Edges ScrollbarMargin { get; set; }

Property Value

Edges

ScrollbarThumbSprite

The ThumbSprite used for the scrollbar.

public StardewUI.Graphics.Sprite ScrollbarThumbSprite { get; set; }

Property Value

Sprite

ScrollbarTrackSprite

The TrackSprite used for the scrollbar.

public StardewUI.Graphics.Sprite ScrollbarTrackSprite { get; set; }

Property Value

Sprite

ScrollbarUpSprite

The UpSprite used for the scrollbar.

public StardewUI.Graphics.Sprite ScrollbarUpSprite { get; set; }

Property Value

Sprite

ScrollbarVisibility

The ForcedVisibility of the scrollbar.

public StardewUI.Layout.Visibility? ScrollbarVisibility { get; set; }

Property Value

Nullable<Visibility>

ScrollStep

The ScrollStep of the scrollable view. (unofficial-mushymato)

public float ScrollStep { get; set; }

Property Value

Single

Methods

CreateView()

Creates and returns the root view.

protected override StardewUI.Widgets.ScrollContainer CreateView();

Returns

ScrollContainer

OnWheel(WheelEventArgs)

Called when a wheel event is received within this view's bounds.

public override void OnWheel(StardewUI.Events.WheelEventArgs e);

Parameters

e WheelEventArgs
The event data.