JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java™ (public API).
com.jogamp.nativewindow.util.Insets Class Reference

Mutable insets representing rectangular window decoration insets on all four edges in window units. More...

Inheritance diagram for com.jogamp.nativewindow.util.Insets:
Collaboration diagram for com.jogamp.nativewindow.util.Insets:

Public Member Functions

 Insets ()
 
 Insets (final int left, final int right, final int top, final int bottom)
 
Object cloneMutable ()
 
final int getLeftWidth ()
 
final int getRightWidth ()
 
final int getTotalWidth ()
 
final int getTopHeight ()
 
final int getBottomHeight ()
 
final int getTotalHeight ()
 
final void set (final int left, final int right, final int top, final int bottom)
 Set the inset values of this instance in window units. More...
 
final void setLeftWidth (final int left)
 Set the left inset value of this instance in window units. More...
 
final void setRightWidth (final int right)
 Set the right inset value of this instance in window units. More...
 
final void setTopHeight (final int top)
 Set the top inset value of this instance in window units. More...
 
final void setBottomHeight (final int bottom)
 Set the bottom inset value of this instance in window units. More...
 
boolean equals (final Object obj)
 Checks whether two rect objects are equal. More...
 
int hashCode ()
 
String toString ()
 
int getLeftWidth ()
 
int getRightWidth ()
 
int getTotalWidth ()
 
int getTopHeight ()
 
int getBottomHeight ()
 
int getTotalHeight ()
 
boolean equals (Object obj)
 Checks whether two rect objects are equal. More...
 
int hashCode ()
 

Static Public Member Functions

static final InsetsImmutable getZero ()
 

Protected Member Functions

Object clone ()
 

Detailed Description

Mutable insets representing rectangular window decoration insets on all four edges in window units.

Definition at line 35 of file Insets.java.

Constructor & Destructor Documentation

◆ Insets() [1/2]

com.jogamp.nativewindow.util.Insets.Insets ( )

Definition at line 41 of file Insets.java.

Here is the caller graph for this function:

◆ Insets() [2/2]

com.jogamp.nativewindow.util.Insets.Insets ( final int  left,
final int  right,
final int  top,
final int  bottom 
)

Definition at line 45 of file Insets.java.

Member Function Documentation

◆ clone()

Object com.jogamp.nativewindow.util.Insets.clone ( )
protected

Definition at line 58 of file Insets.java.

Here is the caller graph for this function:

◆ cloneMutable()

Object com.jogamp.nativewindow.util.Insets.cloneMutable ( )

Definition at line 53 of file Insets.java.

Here is the call graph for this function:

◆ equals()

boolean com.jogamp.nativewindow.util.Insets.equals ( final Object  obj)

Checks whether two rect objects are equal.

Two instances of Insets are equal if the four integer values of the fields left, right, top, and bottom are all equal.

Returns
true if the two Insets are equal; otherwise false.

Implements com.jogamp.nativewindow.util.InsetsImmutable.

Definition at line 111 of file Insets.java.

Here is the call graph for this function:

◆ getBottomHeight()

final int com.jogamp.nativewindow.util.Insets.getBottomHeight ( )
Returns
bottom inset height in window units.

Implements com.jogamp.nativewindow.util.InsetsImmutable.

Definition at line 75 of file Insets.java.

◆ getLeftWidth()

final int com.jogamp.nativewindow.util.Insets.getLeftWidth ( )
Returns
left inset width in window units.

Implements com.jogamp.nativewindow.util.InsetsImmutable.

Definition at line 67 of file Insets.java.

◆ getRightWidth()

final int com.jogamp.nativewindow.util.Insets.getRightWidth ( )
Returns
right inset width in window units.

Implements com.jogamp.nativewindow.util.InsetsImmutable.

Definition at line 69 of file Insets.java.

◆ getTopHeight()

final int com.jogamp.nativewindow.util.Insets.getTopHeight ( )
Returns
top inset height in window units.

Implements com.jogamp.nativewindow.util.InsetsImmutable.

Definition at line 73 of file Insets.java.

◆ getTotalHeight()

final int com.jogamp.nativewindow.util.Insets.getTotalHeight ( )
Returns
total height in window units, ie. top_height + bottom_height

Implements com.jogamp.nativewindow.util.InsetsImmutable.

Definition at line 77 of file Insets.java.

Here is the caller graph for this function:

◆ getTotalWidth()

final int com.jogamp.nativewindow.util.Insets.getTotalWidth ( )
Returns
total width in window units, ie. left_width + right_width

Implements com.jogamp.nativewindow.util.InsetsImmutable.

Definition at line 71 of file Insets.java.

Here is the caller graph for this function:

◆ getZero()

static final InsetsImmutable com.jogamp.nativewindow.util.Insets.getZero ( )
static

Definition at line 37 of file Insets.java.

◆ hashCode()

int com.jogamp.nativewindow.util.Insets.hashCode ( )

Implements com.jogamp.nativewindow.util.InsetsImmutable.

Definition at line 122 of file Insets.java.

◆ set()

final void com.jogamp.nativewindow.util.Insets.set ( final int  left,
final int  right,
final int  top,
final int  bottom 
)

Set the inset values of this instance in window units.

Parameters
leftleft inset width in window units.
rightright inset width in window units.
toptop inset width in window units.
bottombottom inset width in window units.

Definition at line 86 of file Insets.java.

Here is the caller graph for this function:

◆ setBottomHeight()

final void com.jogamp.nativewindow.util.Insets.setBottomHeight ( final int  bottom)

Set the bottom inset value of this instance in window units.

Parameters
bottombottom inset width in window units.

Definition at line 108 of file Insets.java.

◆ setLeftWidth()

final void com.jogamp.nativewindow.util.Insets.setLeftWidth ( final int  left)

Set the left inset value of this instance in window units.

Parameters
leftleft inset width in window units.

Definition at line 93 of file Insets.java.

◆ setRightWidth()

final void com.jogamp.nativewindow.util.Insets.setRightWidth ( final int  right)

Set the right inset value of this instance in window units.

Parameters
rightright inset width in window units.

Definition at line 98 of file Insets.java.

◆ setTopHeight()

final void com.jogamp.nativewindow.util.Insets.setTopHeight ( final int  top)

Set the top inset value of this instance in window units.

Parameters
toptop inset width in window units.

Definition at line 103 of file Insets.java.

◆ toString()

String com.jogamp.nativewindow.util.Insets.toString ( )

Definition at line 132 of file Insets.java.

Here is the call graph for this function:

The documentation for this class was generated from the following file: