Package noaa.coastwatch.gui

Class FullScreenWindow

java.lang.Object
noaa.coastwatch.gui.FullScreenWindow
public class FullScreenWindow extends Object

The FullScreenWindow class display a full screen component with optional tool bar. The displayed component is taken from its parent component (if it exists) and displayed in full screen mode by the start() method. The caller must restore the component to its parent after calling the stop() method.

Java support for full screen mode is not required for a component to be displayed full screen, but some performance degradation can occur if no Java support exists. The isFullScreenSupported() method checks for Java full screen mode support. Applications can safely ignore the return value of this method if needed.

Since:
3.2.2
Author:
Peter Hollemans
See Also:

  • Constructor Details

    • FullScreenWindow

      public FullScreenWindow(Component component, FullScreenToolBar toolbar)
      Creates a new window with the specified component and toolbar.
      Parameters:
      component - the component to use as the full screen contents.
      toolbar - the toolbar to use for the component, or null for no toolbar.

  • Method Details

    • start

      public void start()
      Starts full screen mode with this window.
      Throws:
      IllegalStateException - if the graphics device is already in full screen mode.

    • stop

      public void stop()
      Ends full screen mode with this window.
      Throws:
      IllegalStateException - if the graphics device is not in full screen mode.

    • isFullScreen

      public boolean isFullScreen()
      Determines if this window is currently displayed full screen.
      Returns:
      the fullscreen mode flag, true if displayed fullscreen or false if not.

    • isFullScreenSupported

      @Deprecated public static boolean isFullScreenSupported()
      Deprecated.
      Determines if full screen mode is supported on the default graphics device.
      Returns:
      true if full screen mode is supported or false if not.