Module org.snapfx

Package org.snapfx.floating

Record Class DockFloatingPinChangeEvent

java.lang.Object

java.lang.Record

org.snapfx.floating.DockFloatingPinChangeEvent

Record Components:

window - Floating window whose state changed

alwaysOnTop - New always-on-top state

source - Trigger source of the change

public record DockFloatingPinChangeEvent(DockFloatingWindow window, boolean alwaysOnTop, DockFloatingPinSource source)
extends Record

Event emitted when a floating window pin state changes.

Constructor Summary

Constructors

Constructor	Description
DockFloatingPinChangeEvent(DockFloatingWindow window, boolean alwaysOnTop, DockFloatingPinSource source)	Creates an instance of a DockFloatingPinChangeEvent record class.

Method Summary

Modifier and Type	Method	Description
boolean	alwaysOnTop()	Returns the value of the alwaysOnTop record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
DockFloatingPinSource	source()	Returns the value of the source record component.
final String	toString()	Returns a string representation of this record class.
DockFloatingWindow	window()	Returns the value of the window record component.

Methods inherited from class java.lang.Object

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

Constructor Details

DockFloatingPinChangeEvent

public DockFloatingPinChangeEvent(DockFloatingWindow window,
 boolean alwaysOnTop,
 DockFloatingPinSource source)

Creates an instance of a DockFloatingPinChangeEvent record class.

Parameters:

window - the value for the window record component

alwaysOnTop - the value for the alwaysOnTop record component

source - the value for the source record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

window

public DockFloatingWindow window()

Returns the value of the window record component.

Returns:

the value of the window record component

alwaysOnTop

public boolean alwaysOnTop()

Returns the value of the alwaysOnTop record component.

Returns:

the value of the alwaysOnTop record component

source

public DockFloatingPinSource source()

Returns the value of the source record component.

Returns:

the value of the source record component