Class VirtualMenuSession

java.lang.Object
com.render.api.gui.ScreenExtensionView
com.render.api.VirtualMenuSession
public abstract class VirtualMenuSession extends ScreenExtensionView
Retained screen-extension host specialized for handled-screen virtual menus.

  • Constructor Details

    • VirtualMenuSession

      public VirtualMenuSession()

  • Method Details

    • queue

      public final MenuActionQueue queue()

    • mode

      public ScreenExtensionMode mode()

    • build

      protected abstract void build(MenuHostContext context)

    • tick

      protected void tick(MenuHostContext context)

    • onAttached

      protected void onAttached(MenuHostContext context)

    • onDetached

      protected void onDetached(MenuHostContext context)

    • shouldContinue

      public boolean shouldContinue(MenuTransitionContext transition)

    • onHostMenuChanged

      public void onHostMenuChanged(MenuTransitionContext transition)

    • onHostMenuRefreshed

      public void onHostMenuRefreshed(MenuHostContext context)

    • onQueueStateChanged

      public void onQueueStateChanged(MenuActionQueueState state)

    • build

      protected final void build(ScreenExtensionContext context)
      Specified by:
      build in class ScreenExtensionView

    • tick

      protected final void tick(ScreenExtensionContext context)
      Overrides:
      tick in class ScreenExtensionView

    • onAttached

      protected final void onAttached(ScreenExtensionContext context)
      Overrides:
      onAttached in class ScreenExtensionView

    • onDetached

      protected final void onDetached(ScreenExtensionContext context)
      Overrides:
      onDetached in class ScreenExtensionView

    • onHostScreenChanged

      protected final void onHostScreenChanged(ScreenExtensionContext previous, ScreenExtensionContext next)
      Overrides:
      onHostScreenChanged in class ScreenExtensionView

    • root

      public final ContainerComponent root()

    • findById

      public final Optional<GuiComponent<?>> findById(String id)
      Finds a uniquely identified component across the retained content and managed overlay trees.

      This is the stable cross-class access point for updating a component without retaining the concrete field that originally created it. Duplicate IDs are rejected.

      Parameters:
      id - component identifier
      Returns:
      matching component, when present

    • findById

      public final <C extends GuiComponent<?>> Optional<C> findById(String id, Class<C> componentType)
      Finds and type-checks a uniquely identified component across this view.
      Type Parameters:
      C - component type
      Parameters:
      id - component identifier
      componentType - required component type
      Returns:
      matching typed component, when present

    • viewTransition

      public final GuiViewTransition viewTransition()
      Returns this host's single retained view-transition controller.
      Returns:
      view-transition controller

    • devtoolsEnabled

      public com.render.api.gui.GuiHostView devtoolsEnabled(boolean devtoolsEnabled)

    • devtoolsEnabled

      public final boolean devtoolsEnabled()

    • renderCompatibilityReport

      public final GuiRenderCompatibilityReport renderCompatibilityReport()
      Returns capabilities and fallbacks for the most recently compiled GUI render graph.
      Returns:
      current GUI render compatibility report

    • renderStats

      public final GuiRenderStats renderStats()
      Returns statistics for the most recently compiled GUI render graph.
      Returns:
      current GUI render statistics

    • fontPolicy

      public com.render.api.gui.GuiHostView fontPolicy(GuiFontPolicy policy)
      Selects the external-font authorization policy for this view.
      Parameters:
      policy - font policy
      Returns:
      this host

    • fontPolicy

      public final GuiFontPolicy fontPolicy()
      Returns this view's external-font authorization policy.
      Returns:
      font policy

    • motionPreference

      public com.render.api.gui.GuiHostView motionPreference(GuiMotionPreference preference)
      Selects how this view responds to reduced-motion preferences.
      Parameters:
      preference - motion preference
      Returns:
      this host

    • motionPreference

      public final GuiMotionPreference motionPreference()
      Returns this view's effective motion preference policy.
      Returns:
      motion preference

    • uiMode

      public final GuiUiMode uiMode()
      Returns the selected retained runtime mode.
      Returns:
      runtime mode

    • removeStyleSheet

      public final boolean removeStyleSheet(GuiStyleSheet styleSheet)
      Removes an attached stylesheet.
      Parameters:
      styleSheet - stylesheet
      Returns:
      whether it was attached

    • clearStyleSheets

      public final void clearStyleSheets()
      Clears every attached stylesheet.

    • styleSheets

      public final List<GuiStyleSheet> styleSheets()
      Returns attached stylesheets in cascade order.
      Returns:
      immutable stylesheet list

    • showDialog

      public final void showDialog(DialogModalComponent dialog)

    • closeDialog

      public final void closeDialog(DialogModalComponent dialog)

    • showToast

      public final ToastHandle showToast(ToastComponent toast)

    • clearToasts

      public final void clearToasts()

    • ensureBuilt

      public final void ensureBuilt()