Package org.freedesktop.wayland.client

Class XdgPositionerProxy

java.lang.Object

org.freedesktop.wayland.client.Proxy<XdgPositionerEvents>

org.freedesktop.wayland.client.XdgPositionerProxy

All Implemented Interfaces:

WaylandObject

public class XdgPositionerProxy
extends Proxy<XdgPositionerEvents>

child surface positioner

The xdg_positioner provides a collection of rules for the placement of a child surface relative to a parent surface. Rules can be defined to ensure the child surface remains within the visible area's borders, and to specify how the child surface changes its position, such as sliding along an axis, or flipping around a rectangle. These positioner-created rules are constrained by the requirement that a child surface must intersect with or be at least partially adjacent to its parent surface.

See the various requests for details about possible rules.

At the time of the request, the compositor makes a copy of the rules specified by the xdg_positioner. Thus, after the request is complete the xdg_positioner object can be destroyed or reused; further changes to the object will have no effect on previous usages.

For an xdg_positioner object to be considered complete, it must have a non-zero size set by set_size, and a non-zero anchor rectangle set by set_anchor_rect. Passing an incomplete xdg_positioner object when positioning a surface raises an invalid_positioner error.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INTERFACE_NAME

Fields inherited from class org.freedesktop.wayland.client.Proxy

pointer

Constructor Summary

Constructors

Constructor	Description
XdgPositionerProxy(MemorySegment pointer)
XdgPositionerProxy(MemorySegment pointer, XdgPositionerEvents implementation, int version)

Method Summary

Modifier and Type	Method	Description
void	destroy()	destroy the xdg_positioner object
void	setAnchor(int anchor)	set anchor rectangle anchor
void	setAnchorRect(int x, int y, int width, int height)	set the anchor rectangle within the parent surface
void	setConstraintAdjustment(int constraintAdjustment)	set the adjustment to be done when constrained
void	setGravity(int gravity)	set child surface gravity
void	setOffset(int x, int y)	set surface position offset
void	setParentConfigure(int serial)	set parent configure this is a response to
void	setParentSize(int parentWidth, int parentHeight)	Set the parent window geometry the compositor should use when positioning the popup.
void	setReactive()	continuously reconstrain the surface
void	setSize(int width, int height)	set the size of the to-be positioned rectangle

Methods inherited from class org.freedesktop.wayland.client.Proxy

equals, getId, getImplementation, getPointer, getVersion, hashCode, marshal, marshal, marshalConstructor, setQueue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

INTERFACE_NAME

public static final String INTERFACE_NAME

See Also:

• Constant Field Values

Constructor Details

XdgPositionerProxy

public XdgPositionerProxy(MemorySegment pointer,
 XdgPositionerEvents implementation,
 int version)

XdgPositionerProxy

public XdgPositionerProxy(MemorySegment pointer)

Method Details

destroy

public void destroy()

destroy the xdg_positioner object

Notify the compositor that the xdg_positioner will no longer be used.

Overrides:

destroy in class Proxy<XdgPositionerEvents>

setSize

public void setSize(int width,
 int height)

set the size of the to-be positioned rectangle

Set the size of the surface that is to be positioned with the positioner object. The size is in surface-local coordinates and corresponds to the window geometry. See xdg_surface.set_window_geometry.

If a zero or negative size is set the invalid_input error is raised.

Parameters:

width - width of positioned rectangle

height - height of positioned rectangle

setAnchorRect

public void setAnchorRect(int x,
 int y,
 int width,
 int height)

set the anchor rectangle within the parent surface

Specify the anchor rectangle within the parent surface that the child surface will be placed relative to. The rectangle is relative to the window geometry as defined by xdg_surface.set_window_geometry of the parent surface.

When the xdg_positioner object is used to position a child surface, the anchor rectangle may not extend outside the window geometry of the positioned child's parent surface.

If a negative size is set the invalid_input error is raised.

Parameters:

x - x position of anchor rectangle

y - y position of anchor rectangle

width - width of anchor rectangle

height - height of anchor rectangle

setAnchor

public void setAnchor(int anchor)

set anchor rectangle anchor

Defines the anchor point for the anchor rectangle. The specified anchor is used derive an anchor point that the child surface will be positioned relative to. If a corner anchor is set (e.g. 'top_left' or 'bottom_right'), the anchor point will be at the specified corner; otherwise, the derived anchor point will be centered on the specified edge, or in the center of the anchor rectangle if no edge is specified.

Parameters:

anchor - anchor

setGravity

public void setGravity(int gravity)

set child surface gravity

Defines in what direction a surface should be positioned, relative to the anchor point of the parent surface. If a corner gravity is specified (e.g. 'bottom_right' or 'top_left'), then the child surface will be placed towards the specified gravity; otherwise, the child surface will be centered over the anchor point on any axis that had no gravity specified. If the gravity is not in the ‘gravity’ enum, an invalid_input error is raised.

Parameters:

gravity - gravity direction

setConstraintAdjustment

public void setConstraintAdjustment(int constraintAdjustment)

set the adjustment to be done when constrained

Specify how the window should be positioned if the originally intended position caused the surface to be constrained, meaning at least partially outside positioning boundaries set by the compositor. The adjustment is set by constructing a bitmask describing the adjustment to be made when the surface is constrained on that axis.

If no bit for one axis is set, the compositor will assume that the child surface should not change its position on that axis when constrained.

If more than one bit for one axis is set, the order of how adjustments are applied is specified in the corresponding adjustment descriptions.

The default adjustment is none.

Parameters:

constraintAdjustment - bit mask of constraint adjustments

setOffset

public void setOffset(int x,
 int y)

set surface position offset

Specify the surface position offset relative to the position of the anchor on the anchor rectangle and the anchor on the surface. For example if the anchor of the anchor rectangle is at (x, y), the surface has the gravity bottom|right, and the offset is (ox, oy), the calculated surface position will be (x + ox, y + oy). The offset position of the surface is the one used for constraint testing. See set_constraint_adjustment.

An example use case is placing a popup menu on top of a user interface element, while aligning the user interface element of the parent surface with some user interface element placed somewhere in the popup surface.

Parameters:

x - surface position x offset

y - surface position y offset

setReactive

public void setReactive()

continuously reconstrain the surface

When set reactive, the surface is reconstrained if the conditions used for constraining changed, e.g. the parent window moved.

If the conditions changed and the popup was reconstrained, an xdg_popup.configure event is sent with updated geometry, followed by an xdg_surface.configure event.

setParentSize

public void setParentSize(int parentWidth,
 int parentHeight)

Set the parent window geometry the compositor should use when positioning the popup. The compositor may use this information to determine the future state the popup should be constrained using. If this doesn't match the dimension of the parent the popup is eventually positioned against, the behavior is undefined.

The arguments are given in the surface-local coordinate space.

Parameters:

parentWidth - future window geometry width of parent

parentHeight - future window geometry height of parent

setParentConfigure

public void setParentConfigure(int serial)

set parent configure this is a response to

Set the serial of an xdg_surface.configure event this positioner will be used in response to. The compositor may use this information together with set_parent_size to determine what future state the popup should be constrained using.

Parameters:

serial - serial of parent configure event