swing-ui/org.jetbrains.compose.swing.components.desktop/InternalFrameState

InternalFrameState

@Stable

class InternalFrameState @RememberInComposition constructor(bounds: Rectangle, iconified: Boolean = false, maximized: Boolean = false)

A state object that can be hoisted to control and observe where one internal frame of a DesktopPane sits, how large it is, and whether it stands on the desktop as its icon or fills the desktop.

Every property is two-way: assigning to one moves, resizes, iconifies or maximizes the realized frame, and a user dragging the frame across the desktop, pulling its border, or activating its iconify, maximize or restore control writes the new value back into the state.

Parameters

bounds

the initial value for bounds

iconified

the initial value for iconified

maximized

the initial value for maximized

See also

Constructors

InternalFrameState

@RememberInComposition

constructor(bounds: Rectangle, iconified: Boolean = false, maximized: Boolean = false)

Properties

var bounds: Rectangle

The frame's position and size within the desktop, in pixels.

var height: Int

The current height of the frame, in pixels.

var iconified: Boolean

Whether the frame stands on the desktop as its icon rather than as a window.

var maximized: Boolean

Whether the frame fills the desktop rather than standing on the geometry this state holds.

The current width of the frame, in pixels.

var x: Int

The x coordinate of the frame's top-left corner within the desktop, in pixels.

var y: Int

The y coordinate of the frame's top-left corner within the desktop, in pixels.