Class ScrollableFrameView
Definition
Namespace: StardewUI.Widgets
Assembly: StardewUI.dll
Layout widget for a sectioned menu including a scrollable content area.
Inheritance
Object ⇦ DecoratorView<T> ⇦ ComponentView<T> ⇦ ComponentView ⇦ ScrollableFrameView
Remarks
The primary content is always kept centered, with optional title, footer and sidebar (e.g. for navigation) available to decorate the view. Many if not most menus can be fully represented with this layout, as long as they do not have built-in subnavigation such as top-level tabs.
Members
Constructors
| Name | Description |
|---|---|
| ScrollableFrameView() |
Properties
| Name | Description |
|---|---|
| ActualBounds | The bounds of this view relative to the origin (0, 0). (Inherited from DecoratorView<T>) |
| ClipOrigin | Origin position for the ClipSize. (Inherited from DecoratorView<T>) |
| ClipSize | Size of the clipping rectangle, outside which content will not be displayed. (Inherited from DecoratorView<T>) |
| Content | The primary content, which displays inside the menu frame and is clipped/scrollable. |
| ContentBounds | The true bounds of this view's content; i.e. ActualBounds excluding margins. (Inherited from DecoratorView<T>) |
| ContentLayout | Layout parameters to apply to the actual ScrollContainer containing the Content. |
| FloatingBounds | Contains the bounds of all floating elements in this view tree, including the current view and all descendants. (Inherited from DecoratorView<T>) |
| Footer | Optional footer to display below the Content. |
| FrameLayout | Layout parameters to apply to the frame surrounding the Content. |
| IsFocusable | 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 | The current layout parameters, which determine how Measure(Vector2) will behave. (Inherited from DecoratorView<T>) |
| Name | Simple name for this view, used in log/debug output; does not affect behavior. (Inherited from DecoratorView<T>) |
| Opacity | Opacity (alpha level) of the view. (Inherited from DecoratorView<T>) |
| OuterSize | The true computed layout size resulting from a single Measure(Vector2) pass. (Inherited from DecoratorView<T>) |
| PointerEventsEnabled | Whether this view should receive pointer events like Click or Drag. (Inherited from DecoratorView<T>) |
| PointerStyle | Pointer style to use when this view is hovered. (Inherited from DecoratorView<T>) |
| ScrollWithChildren | 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>) |
| Sidebar | Optional content to display to the left of the Content frame. |
| SidebarWidth | Maximum width of the sidebar area. |
| Tags | The user-defined tags for this view. (Inherited from DecoratorView<T>) |
| Title | Title to display above the Content. |
| Tooltip | Tooltip data to display on hover, if any. (Inherited from DecoratorView<T>) |
| Transform | Local transformation to apply to this view, including any children and floating elements. (Inherited from DecoratorView<T>) |
| TransformOrigin | Relative origin position for any Transform on this view. (Inherited from DecoratorView<T>) |
| View | (Inherited from ComponentView<T>) |
| Visibility | Drawing visibility for this view. (Inherited from DecoratorView<T>) |
| ZIndex | 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. (Overrides DecoratorView<T>.Measure(Vector2)) |
| 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
ScrollableFrameView()
Properties
Content
The primary content, which displays inside the menu frame and is clipped/scrollable.
Property Value
ContentLayout
Layout parameters to apply to the actual ScrollContainer containing the Content.
Property Value
Remarks
The scroll container sits between the Content and the outer frame. By default it is set to stretch to the outer layout dimensions, but can be modified to e.g. fit width to content.
Footer
Optional footer to display below the Content.
Property Value
Remarks
Footer layout can be any arbitrary size and will not push up the Content. However, footers wider than the Content may cause problems.
FrameLayout
Layout parameters to apply to the frame surrounding the Content.
Property Value
Remarks
Determines the size of the scrollable area and should generally be one of the FixedSize(Point) overloads, or at least have a fixed Height.
Sidebar
Optional content to display to the left of the Content frame.
Property Value
Remarks
Typically used for navigation or other contextual info. Max width is constrained to SidebarWidth regardless of layout.
SidebarWidth
Maximum width of the sidebar area.
Property Value
Remarks
To keep the primary content centered, the same dimension must be applied to the scrollbar's container, so the width must be specified ahead of time. This acts as a maximum width; the actual sidebar does not have to fill this space (it will be right-aligned in that case), but larger views may clip or overflow.
Title
Title to display above the Content.
Property Value
Remarks
All titles are displayed as a Banner.
Methods
CreateView()
Creates and returns the root view.
Returns
Measure(Vector2)
Performs layout on this view, updating its OuterSize, ActualBounds and ContentBounds, and arranging any children in their respective positions.
Parameters
availableSize Vector2
The width/height that is still available in the container/parent.
Returns
Whether or not any layout was performed as a result of this pass. Callers may use this to propagate layout back up the tree, or perform expensive follow-up actions.
Remarks
Most views should save the value of availableSize for use in IsDirty() checks.
OnWheel(WheelEventArgs)
Called when a wheel event is received within this view's bounds.
Parameters
e WheelEventArgs
The event data.