JOGL v2.6.0-rc-20250706
JOGL, High-Performance Graphics Binding for Java™ (public API).
InsetsImmutable.java
Go to the documentation of this file.
1/**
2 * Copyright 2011 JogAmp Community. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without modification, are
5 * permitted provided that the following conditions are met:
6 *
7 * 1. Redistributions of source code must retain the above copyright notice, this list of
8 * conditions and the following disclaimer.
9 *
10 * 2. Redistributions in binary form must reproduce the above copyright notice, this list
11 * of conditions and the following disclaimer in the documentation and/or other materials
12 * provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
15 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
16 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
21 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
22 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 *
24 * The views and conclusions contained in the software and documentation are those of the
25 * authors and should not be interpreted as representing official policies, either expressed
26 * or implied, of JogAmp Community.
27 */
28
29package com.jogamp.nativewindow.util;
30
31import com.jogamp.common.type.WriteCloneable;
32
33/**
34 * Immutable insets representing rectangular window decoration insets on all four edges
35 * in window units.
36 */
37public interface InsetsImmutable extends WriteCloneable {
38
39 /** @return left inset width in window units. */
41
42 /** @return right inset width in window units. */
44
45 /** @return total width in window units, ie. <code>left_width + right_width</code> */
47
48 /** @return top inset height in window units. */
50
51 /** @return bottom inset height in window units. */
53
54 /** @return total height in window units, ie. <code>top_height + bottom_height</code> */
56
57 /**
58 * Checks whether two rect objects are equal. Two instances
59 * of <code>Insets</code> are equal if the four integer values
60 * of the fields <code>left</code>, <code>right</code>,
61 * <code>top</code>, and <code>bottom</code> are all equal.
62 * @return <code>true</code> if the two Insets are equal;
63 * otherwise <code>false</code>.
64 */
65 @Override
66 boolean equals(Object obj);
67
68 @Override
69 int hashCode();
70
71}
Immutable insets representing rectangular window decoration insets on all four edges in window units.
boolean equals(Object obj)
Checks whether two rect objects are equal.