Java Doc for Frame.java in  » 6.0-JDK-Core » AWT » java » awt » Java Source Code / Java DocumentationJava Source Code and Java Documentation

The size of the frame includes any area designated for the border. The dimensions of the border area may be obtained using the getInsets method, however, since these dimensions are platform-dependent, a valid insets value cannot be obtained until the frame is made displayable by either calling pack or show. Since the border area is included in the overall size of the frame, the border effectively obscures a portion of the frame, constraining the area available for rendering and/or displaying subcomponents to the rectangle which has an upper-left corner location of (insets.left, insets.top), and has a size of width - (insets.left + insets.right) by height - (insets.top + insets.bottom).

The default layout for a frame is BorderLayout.

A frame may have its native decorations (i.e. Frame and Titlebar) turned off with setUndecorated. This can only be done while the frame is not Component.isDisplayable displayable .

In a multi-screen environment, you can create a Frame on a different screen device by constructing the Frame with Frame.Frame(GraphicsConfiguration) or #Frame(String title, GraphicsConfiguration) . The GraphicsConfiguration object is one of the GraphicsConfiguration objects of the target screen device.

In a virtual device multi-screen environment in which the desktop area could span multiple physical screen devices, the bounds of all configurations are relative to the virtual-coordinate system. The origin of the virtual-coordinate system is at the upper left-hand corner of the primary physical screen. Depending on the location of the primary screen in the virtual device, negative coordinates are possible, as shown in the following figure.

In such an environment, when calling setLocation, you must pass a virtual coordinate to this method. Similarly, calling getLocationOnScreen on a Frame returns virtual device coordinates. Call the getBounds method of a GraphicsConfiguration to find its origin in the virtual coordinate system.

The following code sets the location of the Frame at (10, 10) relative to the origin of the physical screen of the corresponding GraphicsConfiguration. If the bounds of the GraphicsConfiguration is not taken into account, the Frame location would be set at (10, 10) relative to the virtual-coordinate system and would appear on the primary physical screen, which might be different from the physical screen of the specified GraphicsConfiguration.

 Frame f = new Frame(GraphicsConfiguration gc);
 Rectangle bounds = gc.getBounds();
 f.setLocation(10 + bounds.x, 10 + bounds.y);
 

Frames are capable of generating the following types of WindowEvents:

• WINDOW_OPENED
• WINDOW_CLOSING:
  If the program doesn't explicitly hide or dispose the window while processing this event, the window close operation is canceled.
• WINDOW_CLOSED
• WINDOW_ICONIFIED
• WINDOW_DEICONIFIED
• WINDOW_ACTIVATED
• WINDOW_DEACTIVATED
• WINDOW_GAINED_FOCUS
• WINDOW_LOST_FOCUS
• WINDOW_STATE_CHANGED

Warning: this method may return system created frames, such as a shared, hidden frame which is used by Swing.

This method is obsolete and kept for backward compatibility only.

In older versions of JDK a frame state could only be NORMAL or ICONIFIED.

When a frame is in maximized state the system supplies some defaults bounds.

In older versions of JDK a frame state could only be NORMAL or ICONIFIED.

Note that the correct test for frame being fully maximized is

 (state & Frame.MAXIMIZED_BOTH) == Frame.MAXIMIZED_BOTH
 

To test is frame is maximized in some direction use

 (state & Frame.MAXIMIZED_BOTH) != 0
 

• NORMAL
  Indicates that no state bits are set.
• ICONIFIED
• MAXIMIZED_HORIZ
• MAXIMIZED_VERT
• MAXIMIZED_BOTH
  Concatenates MAXIMIZED_HORIZ and MAXIMIZED_VERT.

Warning: this method may return system created frames, such as a shared, hidden frame which is used by Swing. Applications should not assume the existence of these frames, nor should an application assume anything about these frames such as component positions, LayoutManagers or serialization.

Note: To obtain a list of all ownerless windows, including ownerless Dialog s (introduced in release 1.6), use Window.getOwnerlessWindows Window.getOwnerlessWindows .
See Also:   Window.getWindows
See Also:   Window.getOwnerlessWindows
since:
   1.2

This method is obsolete and kept for backward compatibility only. Use Window.getIconImages Window.getIconImages() instead.

If a list of several images was specified as a Window's icon, this method will return the first item of the list. the icon image for this frame, or null if this frame doesn't have an icon image.
See Also:   Frame.setIconImage(Image)
See Also:   Window.getIconImages
See Also:   Window.setIconImages

In older versions of JDK a frame state could only be NORMAL or ICONIFIED. Since JDK 1.4 set of supported frame states is expanded and frame state is represented as a bitwise mask.

For compatibility with old programs this method still returns Frame.NORMAL and Frame.ICONIFIED but it only reports the iconic state of the frame, other aspects of frame state are not reported by this method. Frame.NORMAL or Frame.ICONIFIED.
See Also:   Frame.setState(int)
See Also:   Frame.getExtendedState

• NORMAL
  Indicates that no state bits are set.
• ICONIFIED
• MAXIMIZED_HORIZ
• MAXIMIZED_VERT
• MAXIMIZED_BOTH
  Concatenates MAXIMIZED_HORIZ and MAXIMIZED_VERT.

Note that if the state is not supported on a given platform, nothing will happen. The application may determine if a specific state is available via the java.awt.Toolkit.isFrameStateSupported(int state) method.
Parameters:
  state - a bitwise mask of frame state constants
See Also:   Frame.getExtendedState
See Also:   java.awt.Toolkit.isFrameStateSupported(int)
since:
   1.4

When a frame is in maximized state the system supplies some defaults bounds. This method allows some or all of those system supplied values to be overridden.

If bounds is null, accept bounds supplied by the system. If non-null you can override some of the system supplied values while accepting others by setting those fields you want to accept from system to Integer.MAX_VALUE.

On some systems only the size portion of the bounds is taken into account.
Parameters:
  bounds - bounds for the maximized state
See Also:   Frame.getMaximizedBounds()
since:
   1.4

In older versions of JDK a frame state could only be NORMAL or ICONIFIED. Since JDK 1.4 set of supported frame states is expanded and frame state is represented as a bitwise mask.

For compatibility with old programs this method still accepts Frame.NORMAL and Frame.ICONIFIED but it only changes the iconic state of the frame, other aspects of frame state are not affected by this method.
Parameters:
  state - either Frame.NORMAL orFrame.ICONIFIED.
See Also:   Frame.getState
See Also:   Frame.setExtendedState(int)