Interface Window

All Superinterfaces:
AsynchronousCloseable, AutoCloseable

public interface Window extends AsynchronousCloseable
Glue desktop window.
  • Method Details

    • changeTitle

      CompletionStage<?> changeTitle(String title)
      Changes the window title
      Parameters:
      title - the title to be displayed
      Returns:
      completion stage that completes when title is changed, never null
    • changeChannel

      CompletionStage<?> changeChannel(String channel)
      Changes the window channel
      Parameters:
      channel - the new channel
      Returns:
      completion stage that completes when channel is changed, never null
    • changeBounds

      CompletionStage<?> changeBounds(Bounds bounds)
      Changes the window position and size
      Parameters:
      bounds - the new position and window
      Returns:
      completion stage that completes when bounds are changed, never null
    • changeVisibility

      CompletionStage<?> changeVisibility(boolean visible)
      Changes the visibility. This also affects the window icon in the taskbar
      Parameters:
      visible - flag indicating whether the window should be shown or hidden
      Returns:
      completion stage that completes when visibility is changed, never null
    • maximize

      CompletionStage<?> maximize()
      Minimizes the window.
      Returns:
      completion stage that completes when minimized, never null
      Since:
      1.4.9
    • minimize

      CompletionStage<?> minimize()
      Maximizes the window.
      Returns:
      completion stage that completes when maximized, never null
      Since:
      1.4.9
    • restore

      CompletionStage<?> restore()
      Restores the window. (set window state to normal)
      Returns:
      completion stage that completes when restored, never null
      Since:
      1.4.9
    • collapse

      CompletionStage<?> collapse()
      Collapses the window.
      Returns:
      completion stage that completes when collapsed, never null
      Since:
      1.4.9
    • expand

      CompletionStage<?> expand()
      Expands the window.
      Returns:
      completion stage that completes when expanded, never null
      Since:
      1.4.9
    • toggleCollapse

      CompletionStage<?> toggleCollapse()
      Toggles the window collapsed state.
      Returns:
      completion stage that completes when collapse is toggled, never null
      Since:
      1.4.9
    • focus

      CompletionStage<?> focus()
      Focuses the window.
      Returns:
      completion stage that completes when focus is gained, never null
      Since:
      1.4.9
    • changeContext

      CompletionStage<?> changeContext(Map<String,Object> context)
      Changes the window context
      Parameters:
      context - context for the window
      Returns:
      completion stage that completes when context is changed, never null
    • addFrameButton

      CompletionStage<?> addFrameButton(String buttonId, ButtonOptions options)
      Adds a button to the window frame.
      Parameters:
      buttonId - id of the button to add
      options - options for the button to add
      Returns:
      completion stage that completes when to button is added, never null
    • removeFrameButton

      CompletionStage<?> removeFrameButton(String buttonId)
      Removes a button from the window frame.
      Parameters:
      buttonId - id of the button to remove
      Returns:
      completion stage that completes when the button is removed, never null
    • onFrameButtonClicked

      Registers a callback to be notified when some button from the window frame is clicked.
      Parameters:
      listener - callback to be registered
      Returns:
      subscription object that can be used to unregister the callback, never null
    • onHibernated

      Registers a callback to be notified when the current layout is about to be suspended/hibernated.
      Parameters:
      listener - callback to be registered
      Returns:
      subscription object that can be used to unregister the callback, never null
    • onResumed

      Registers a callback to be notified when the current layout is about to be resumed.
      Parameters:
      listener - callback to be registered
      Returns:
      subscription object that can be used to unregister the callback, never null
    • onContextUpdated

      Registers a callback to be notified upon context update.
      Parameters:
      listener - callback to be registered
      Returns:
      subscription object that can be used to unsubscribe from events, never null.
    • onBoundsChanged

      Registers a callback to be notified when window bounds change.
      Parameters:
      listener - callback to be registered
      Returns:
      subscription object that can be used to unregister the callback, never null
      Since:
      1.4.6
    • onVisibilityChanged

      Registers a callback to be notified when window visibility changes.
      Parameters:
      listener - callback to be registered
      Returns:
      subscription object that can be used to unregister the callback, never null
      Since:
      1.4.6
    • onFocusChanged

      Registers a callback to be notified when window focus changes.
      Parameters:
      listener - callback to be registered
      Returns:
      subscription object that can be used to unregister the callback, never null
      Since:
      1.4.6
    • onTitleChanged

      Registers a callback to be notified when window titles changes.
      Parameters:
      listener - callback to be registered
      Returns:
      subscription object that can be used to unregister the callback, never null
      Since:
      1.4.6
    • onCollapsedChanged

      Registers a callback to be notified when window collapsed changes.
      Parameters:
      listener - callback to be registered
      Returns:
      subscription object that can be used to unregister the callback, never null
      Since:
      1.4.9
    • onStateChanged

      Registers a callback to be notified when window state changes.
      Parameters:
      listener - callback to be registered
      Returns:
      subscription object that can be used to unregister the callback, never null
      Since:
      1.4.9