Interface NativeWindow

    • Method Detail

      • destroy

        void destroy()
        Destroys this window incl. releasing all related resources.
      • getParent

        NativeWindow getParent()
        Returns:
        The parent NativeWindow, or null if this NativeWindow is top level.
      • getWindowHandle

        long getWindowHandle()
        Returns the window handle for this NativeWindow.

        The window handle shall reflect the platform one for all window related operations, e.g. open, close, resize.

        On X11 this returns an entity of type Window.
        On Microsoft Windows this returns an entity of type HWND.

      • getInsets

        InsetsImmutable getInsets()
        Returns the insets defined as the width and height of the window decoration on the left, right, top and bottom in window units.

        Insets are zero if the window is undecorated, including child windows.

        Insets are available only after the native window has been created, ie. the native window has been made visible.
        The top-level window area's top-left corner is located at

           getX() - getInsets().getLeftWidth()
           getY() - getInsets().getTopHeight()
         
        The top-level window size is
           getWidth()  + getInsets().getTotalWidth()
           getHeight() + getInsets().getTotalHeight()
         
        Returns:
        insets
      • getX

        int getX()
        Returns the x position of the top-left corner of the client area relative to it's parent in window units.

        If no parent exist (top-level window), this coordinate equals the screen coordinate.

        Since the position reflects the client area, it does not include the insets.

        See Coordinate System.

        See Also:
        getInsets(), getLocationOnScreen(Point)
      • getY

        int getY()
        Returns the current y position of the top-left corner of the client area relative to it's parent in window units.

        If no parent exist (top-level window), this coordinate equals the screen coordinate.

        Since the position reflects the client area, it does not include the insets.

        See Coordinate System.

        See Also:
        getInsets(), getLocationOnScreen(Point)
      • getWidth

        int getWidth()
        Returns the width of the client area excluding insets (window decorations) in window units.
        Returns:
        width of the client area in window units
        See Also:
        NativeSurface.getSurfaceWidth()
      • getHeight

        int getHeight()
        Returns the height of the client area excluding insets (window decorations) in window units.
        Returns:
        height of the client area in window units
        See Also:
        NativeSurface.getSurfaceHeight()
      • getSurfaceBounds

        Rectangle getSurfaceBounds()
        Returns a newly created Rectangle containing window's surface origin and size in pixel units.
      • getLocationOnScreen

        Point getLocationOnScreen​(Point point)
        Returns the window's top-left client-area position in the screen.

        If Point is not null, it is translated about the resulting screen position and returned.

        See Coordinate System.

        Since the position reflects the client area, it does not include the insets.

        Parameters:
        point - Optional Point storage. If not null, null, it is translated about the resulting screen position and returned.
        See Also:
        getX(), getY(), getInsets()
      • hasFocus

        boolean hasFocus()
        Returns true if this native window owns the focus, otherwise false.