From 7ea8aa31e055ba95a062c87ec4d606f73c2504fa Mon Sep 17 00:00:00 2001
From: Sven Gothel <sgothel@jausoft.com>
Date: Tue, 6 Sep 2011 02:42:11 +0200
Subject: NativeWindow/NEWT: Cont. refinement of Insets usage

Completes commit d4670328991c02a6f11f8873ea7a2331f17d0ef0
---
 .../classes/javax/media/nativewindow/NativeSurface.java      |  4 ++--
 .../classes/javax/media/nativewindow/NativeWindow.java       | 12 ++++++++----
 2 files changed, 10 insertions(+), 6 deletions(-)

(limited to 'src/nativewindow/classes')

diff --git a/src/nativewindow/classes/javax/media/nativewindow/NativeSurface.java b/src/nativewindow/classes/javax/media/nativewindow/NativeSurface.java
index 22e4b0f80..e691ba8e6 100644
--- a/src/nativewindow/classes/javax/media/nativewindow/NativeSurface.java
+++ b/src/nativewindow/classes/javax/media/nativewindow/NativeSurface.java
@@ -136,13 +136,13 @@ public interface NativeSurface extends SurfaceUpdatedListener {
   public long getSurfaceHandle();
 
   /**
-   * Returns the width of the client area.
+   * Returns the width of the client area excluding insets (window decorations).
    * @return width of the client area
    */
   public int getWidth();
 
   /**
-   * Returns the height of the client area.
+   * Returns the height of the client area excluding insets (window decorations).
    * @return height of the client area
    */
   public int getHeight();
diff --git a/src/nativewindow/classes/javax/media/nativewindow/NativeWindow.java b/src/nativewindow/classes/javax/media/nativewindow/NativeWindow.java
index 0f6f84f66..76ac72953 100644
--- a/src/nativewindow/classes/javax/media/nativewindow/NativeWindow.java
+++ b/src/nativewindow/classes/javax/media/nativewindow/NativeWindow.java
@@ -76,10 +76,14 @@ public interface NativeWindow extends NativeSurface {
   public long getWindowHandle();
 
   /** 
-   * Returns the insets defined as the difference between
-   * the top-level window with decorations and the client area.<br>
+   * Returns the insets defined as the width and height of the window decoration
+   * on the left, right, top and bottom.<br>
    * Insets are zero if the window is undecorated, including child windows.
    * 
+   * <p>
+   * Insets are available only after the native window has been created,
+   * ie. the native window has been made visible.<br>
+   *   
    * The top-level window area's top-left corner is located at
    * <pre>
    *   getX() - getInsets().{@link InsetsImmutable#getLeftWidth() getLeftWidth()}
@@ -100,14 +104,14 @@ public interface NativeWindow extends NativeSurface {
   
   /** 
    * @return the current x position of the top-left corner
-   *         of the client area, hence excluding decorations if enabled.<br> 
+   *         of the client area, hence excluding insets (window decorations).<br> 
    * @see #getInsets()
    */
   public int getX();
 
   /** 
    * @return the current y position of the top-left corner
-   *         of the client area, hence excluding decorations if enabled.<br> 
+   *         of the client area, hence excluding insets (window decorations).<br> 
    * @see #getInsets()
    */
   public int getY();
-- 
cgit v1.2.3