aboutsummaryrefslogtreecommitdiffstats
path: root/src/graphui/classes/com/jogamp/graph/ui/layout/Padding.java
diff options
context:
space:
mode:
authorSven Göthel <[email protected]>2024-01-26 02:06:58 +0100
committerSven Göthel <[email protected]>2024-01-26 02:06:58 +0100
commitab29e3b34ea29d35b04ad2771ca20e49f1a59351 (patch)
tree9e15ca328507bac9133fa8bbdb40b3957cc1082f /src/graphui/classes/com/jogamp/graph/ui/layout/Padding.java
parent09c256e2f26938cc2015176e259164bd7421dbdd (diff)
GraphUI Layout: Emphasize whether a value/parameter is scaled or unscaled in API doc to ease usage
Diffstat (limited to 'src/graphui/classes/com/jogamp/graph/ui/layout/Padding.java')
-rw-r--r--src/graphui/classes/com/jogamp/graph/ui/layout/Padding.java34
1 files changed, 17 insertions, 17 deletions
diff --git a/src/graphui/classes/com/jogamp/graph/ui/layout/Padding.java b/src/graphui/classes/com/jogamp/graph/ui/layout/Padding.java
index c59f98d1e..9349e7af2 100644
--- a/src/graphui/classes/com/jogamp/graph/ui/layout/Padding.java
+++ b/src/graphui/classes/com/jogamp/graph/ui/layout/Padding.java
@@ -30,7 +30,7 @@ package com.jogamp.graph.ui.layout;
import com.jogamp.math.FloatUtil;
/**
- * GraphUI CSS property Padding, space belonging to the element and included in the element's size.
+ * GraphUI CSS property Padding, unscaled space belonging to the element and included in the element's size.
* <p>
* The CSS padding properties are used to generate space around an element's content, inside of any defined borders.
* </p>
@@ -39,13 +39,13 @@ public class Padding {
/** Zero padding constant. */
public static final Padding None = new Padding();
- /** Top value */
+ /** Top value (unscaled) */
public final float top;
- /** Right value */
+ /** Right value (unscaled) */
public final float right;
- /** Bottom value */
+ /** Bottom value (unscaled) */
public final float bottom;
- /** Left value */
+ /** Left value (unscaled) */
public final float left;
private Padding() {
@@ -54,10 +54,10 @@ public class Padding {
/**
* Ctor
- * @param top top value
- * @param right right value
- * @param bottom bottom value
- * @param left left value
+ * @param top unscaled top value
+ * @param right unscaled right value
+ * @param bottom unscaled bottom value
+ * @param left unscaled left value
*/
public Padding(final float top, final float right, final float bottom, final float left) {
this.top = top; this.right = right; this.bottom = bottom; this.left = left;
@@ -65,9 +65,9 @@ public class Padding {
/**
* Ctor
- * @param top top value
- * @param rl right and left value
- * @param bottom bottom value
+ * @param top unscaled top value
+ * @param rl unscaled right and left value
+ * @param bottom unscaled bottom value
*/
public Padding(final float top, final float rl, final float bottom) {
this.top = top; this.right = rl; this.bottom = bottom; this.left = rl;
@@ -75,8 +75,8 @@ public class Padding {
/**
* Ctor
- * @param tb top and bottom value
- * @param rl right and left value
+ * @param tb unscaled top and bottom value
+ * @param rl unscaled right and left value
*/
public Padding(final float tb, final float rl) {
this.top = tb; this.right = rl; this.bottom = tb; this.left = rl;
@@ -84,16 +84,16 @@ public class Padding {
/**
* Ctor
- * @param trbl top, right, bottom and left value
+ * @param trbl unscaled top, right, bottom and left value
*/
public Padding(final float trbl) {
this.top = trbl; this.right = trbl; this.bottom = trbl; this.left = trbl;
}
- /** Return width of horizontal values top + right. */
+ /** Return unscaled width of horizontal values top + right. */
public float width() { return left + right; }
- /** Return height of vertical values bottom + top. */
+ /** Return unscaled height of vertical values bottom + top. */
public float height() { return bottom + top; }
public boolean zeroWidth() { return FloatUtil.isZero( width() ); };