declare namespace java {
namespace awt {
/**
* A Frame
is a top-level window with a title and a border.
*
* 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 {@link Component#isDisplayable() displayable}.
*
* In a multi-screen environment, you can create a Frame
* on a different screen device by constructing the Frame
* with {@link #Frame(GraphicsConfiguration)} or
* {@link #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
* WindowEvent
s:
*
WINDOW_OPENED
* WINDOW_CLOSING
:
* WINDOW_CLOSED
* WINDOW_ICONIFIED
* WINDOW_DEICONIFIED
* WINDOW_ACTIVATED
* WINDOW_DEACTIVATED
* WINDOW_GAINED_FOCUS
* WINDOW_LOST_FOCUS
* WINDOW_STATE_CHANGED
* Frame
that is
* initially invisible. The title of the Frame
* is empty.
* @exception HeadlessException when
* GraphicsEnvironment.isHeadless()
returns true
* @see java.awt.GraphicsEnvironment#isHeadless()
* @see Component#setSize
* @see Component#setVisible(boolean)
*/
// @ts-ignore
constructor()
/**
* Constructs a new, initially invisible {@code Frame} with the
* specified {@code GraphicsConfiguration}.
* @param gc the GraphicsConfiguration
* of the target screen device. If gc
* is null
, the system default
* GraphicsConfiguration
is assumed.
* @exception IllegalArgumentException if
* gc
is not from a screen device.
* @exception HeadlessException when
* GraphicsEnvironment.isHeadless()
returns true
* @see java.awt.GraphicsEnvironment#isHeadless()
* @since 1.3
*/
// @ts-ignore
constructor(gc: java.awt.GraphicsConfiguration)
/**
* Constructs a new, initially invisible Frame
object
* with the specified title.
* @param title the title to be displayed in the frame's border.
* A null
value
* is treated as an empty string, "".
* @exception HeadlessException when
* GraphicsEnvironment.isHeadless()
returns true
* @see java.awt.GraphicsEnvironment#isHeadless()
* @see java.awt.Component#setSize
* @see java.awt.Component#setVisible(boolean)
* @see java.awt.GraphicsConfiguration#getBounds
*/
// @ts-ignore
constructor(title: java.lang.String | string)
/**
* Constructs a new, initially invisible Frame
object
* with the specified title and a
* GraphicsConfiguration
.
* @param title the title to be displayed in the frame's border.
* A null
value
* is treated as an empty string, "".
* @param gc the GraphicsConfiguration
* of the target screen device. If gc
is
* null
, the system default
* GraphicsConfiguration
is assumed.
* @exception IllegalArgumentException if gc
* is not from a screen device.
* @exception HeadlessException when
* GraphicsEnvironment.isHeadless()
returns true
* @see java.awt.GraphicsEnvironment#isHeadless()
* @see java.awt.Component#setSize
* @see java.awt.Component#setVisible(boolean)
* @see java.awt.GraphicsConfiguration#getBounds
* @since 1.3
*/
// @ts-ignore
constructor(title: java.lang.String | string, gc: java.awt.GraphicsConfiguration)
/**
* @deprecated replaced by Cursor.DEFAULT_CURSOR
.
*/
// @ts-ignore
public static readonly DEFAULT_CURSOR: number /*int*/
/**
* @deprecated replaced by Cursor.CROSSHAIR_CURSOR
.
*/
// @ts-ignore
public static readonly CROSSHAIR_CURSOR: number /*int*/
/**
* @deprecated replaced by Cursor.TEXT_CURSOR
.
*/
// @ts-ignore
public static readonly TEXT_CURSOR: number /*int*/
/**
* @deprecated replaced by Cursor.WAIT_CURSOR
.
*/
// @ts-ignore
public static readonly WAIT_CURSOR: number /*int*/
/**
* @deprecated replaced by Cursor.SW_RESIZE_CURSOR
.
*/
// @ts-ignore
public static readonly SW_RESIZE_CURSOR: number /*int*/
/**
* @deprecated replaced by Cursor.SE_RESIZE_CURSOR
.
*/
// @ts-ignore
public static readonly SE_RESIZE_CURSOR: number /*int*/
/**
* @deprecated replaced by Cursor.NW_RESIZE_CURSOR
.
*/
// @ts-ignore
public static readonly NW_RESIZE_CURSOR: number /*int*/
/**
* @deprecated replaced by Cursor.NE_RESIZE_CURSOR
.
*/
// @ts-ignore
public static readonly NE_RESIZE_CURSOR: number /*int*/
/**
* @deprecated replaced by Cursor.N_RESIZE_CURSOR
.
*/
// @ts-ignore
public static readonly N_RESIZE_CURSOR: number /*int*/
/**
* @deprecated replaced by Cursor.S_RESIZE_CURSOR
.
*/
// @ts-ignore
public static readonly S_RESIZE_CURSOR: number /*int*/
/**
* @deprecated replaced by Cursor.W_RESIZE_CURSOR
.
*/
// @ts-ignore
public static readonly W_RESIZE_CURSOR: number /*int*/
/**
* @deprecated replaced by Cursor.E_RESIZE_CURSOR
.
*/
// @ts-ignore
public static readonly E_RESIZE_CURSOR: number /*int*/
/**
* @deprecated replaced by Cursor.HAND_CURSOR
.
*/
// @ts-ignore
public static readonly HAND_CURSOR: number /*int*/
/**
* @deprecated replaced by Cursor.MOVE_CURSOR
.
*/
// @ts-ignore
public static readonly MOVE_CURSOR: number /*int*/
/**
* Frame is in the "normal" state. This symbolic constant names a
* frame state with all state bits cleared.
* @see #setExtendedState(int)
* @see #getExtendedState
*/
// @ts-ignore
public static readonly NORMAL: number /*int*/
/**
* This state bit indicates that frame is iconified.
* @see #setExtendedState(int)
* @see #getExtendedState
*/
// @ts-ignore
public static readonly ICONIFIED: number /*int*/
/**
* This state bit indicates that frame is maximized in the
* horizontal direction.
* @see #setExtendedState(int)
* @see #getExtendedState
* @since 1.4
*/
// @ts-ignore
public static readonly MAXIMIZED_HORIZ: number /*int*/
/**
* This state bit indicates that frame is maximized in the
* vertical direction.
* @see #setExtendedState(int)
* @see #getExtendedState
* @since 1.4
*/
// @ts-ignore
public static readonly MAXIMIZED_VERT: number /*int*/
/**
* This state bit mask indicates that frame is fully maximized
* (that is both horizontally and vertically). It is just a
* convenience alias for
* MAXIMIZED_VERT | MAXIMIZED_HORIZ
.
* 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 ** @see #setExtendedState(int) * @see #getExtendedState * @since 1.4 */ // @ts-ignore public static readonly MAXIMIZED_BOTH: number /*int*/ /** * Makes this Frame displayable by connecting it to * a native screen resource. Making a frame displayable will * cause any of its children to be made displayable. * This method is called internally by the toolkit and should * not be called directly by programs. * @see Component#isDisplayable * @see #removeNotify */ // @ts-ignore public addNotify(): void /** * Gets the title of the frame. The title is displayed in the * frame's border. * @return the title of this frame, or an empty string ("") * if this frame doesn't have a title. * @see #setTitle(String) */ // @ts-ignore public getTitle(): string /** * Sets the title for this frame to the specified string. * @param title the title to be displayed in the frame's border. * A
null
value
* is treated as an empty string, "".
* @see #getTitle
*/
// @ts-ignore
public setTitle(title: java.lang.String | string): void
/**
* Returns the image to be displayed as the icon for this frame.
* * This method is obsolete and kept for backward compatibility * only. Use {@link 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.
* @return the icon image for this frame, or null
* if this frame doesn't have an icon image.
* @see #setIconImage(Image)
* @see Window#getIconImages()
* @see Window#setIconImages
*/
// @ts-ignore
public getIconImage(): java.awt.Image
/**
* {@inheritDoc}
*/
// @ts-ignore
public setIconImage(image: java.awt.Image): void
/**
* Gets the menu bar for this frame.
* @return the menu bar for this frame, or null
* if this frame doesn't have a menu bar.
* @see #setMenuBar(MenuBar)
*/
// @ts-ignore
public getMenuBar(): java.awt.MenuBar
/**
* Sets the menu bar for this frame to the specified menu bar.
* @param mb the menu bar being set.
* If this parameter is null
then any
* existing menu bar on this frame is removed.
* @see #getMenuBar
*/
// @ts-ignore
public setMenuBar(mb: java.awt.MenuBar): void
/**
* Indicates whether this frame is resizable by the user.
* By default, all frames are initially resizable.
* @return true
if the user can resize this frame;
* false
otherwise.
* @see java.awt.Frame#setResizable(boolean)
*/
// @ts-ignore
public isResizable(): boolean
/**
* Sets whether this frame is resizable by the user.
* @param resizable true
if this frame is resizable;
* false
otherwise.
* @see java.awt.Frame#isResizable
*/
// @ts-ignore
public setResizable(resizable: boolean): void
/**
* Sets the state of this frame (obsolete).
*
* 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 applications developed * earlier this method still accepts * {@code Frame.NORMAL} and * {@code Frame.ICONIFIED} only. The iconic * state of the frame is only changed, other aspects * of frame state are not affected by this method. If * the state passed to this method is neither {@code * Frame.NORMAL} nor {@code Frame.ICONIFIED} the * method performs no actions at all. *
Note that if the state is not supported on a * given platform, neither the state nor the return * value of the {@link #getState} method will be * changed. The application may determine whether a * specific state is supported via the {@link * java.awt.Toolkit#isFrameStateSupported} method. *
If the frame is currently visible on the * screen (the {@link #isShowing} method returns * {@code true}), the developer should examine the * return value of the {@link * java.awt.event.WindowEvent#getNewState} method of * the {@code WindowEvent} received through the * {@link java.awt.event.WindowStateListener} to * determine that the state has actually been * changed. *
If the frame is not visible on the
* screen, the events may or may not be
* generated. In this case the developer may assume
* that the state changes immediately after this
* method returns. Later, when the {@code
* setVisible(true)} method is invoked, the frame
* will attempt to apply this state. Receiving any
* {@link
* java.awt.event.WindowEvent#WINDOW_STATE_CHANGED}
* events is not guaranteed in this case also.
* @param state either Frame.NORMAL
or
* Frame.ICONIFIED
.
* @see #setExtendedState(int)
* @see java.awt.Window#addWindowStateListener
*/
// @ts-ignore
public setState(state: number /*int*/): void
/**
* Sets the state of this frame. The state is
* represented as a bitwise mask.
*
NORMAL
* ICONIFIED
* MAXIMIZED_HORIZ
* MAXIMIZED_VERT
* MAXIMIZED_BOTH
* MAXIMIZED_HORIZ
* and MAXIMIZED_VERT
.
* Note that if the state is not supported on a * given platform, neither the state nor the return * value of the {@link #getExtendedState} method will * be changed. The application may determine whether * a specific state is supported via the {@link * java.awt.Toolkit#isFrameStateSupported} method. *
If the frame is currently visible on the * screen (the {@link #isShowing} method returns * {@code true}), the developer should examine the * return value of the {@link * java.awt.event.WindowEvent#getNewState} method of * the {@code WindowEvent} received through the * {@link java.awt.event.WindowStateListener} to * determine that the state has actually been * changed. *
If the frame is not visible on the * screen, the events may or may not be * generated. In this case the developer may assume * that the state changes immediately after this * method returns. Later, when the {@code * setVisible(true)} method is invoked, the frame * will attempt to apply this state. Receiving any * {@link * java.awt.event.WindowEvent#WINDOW_STATE_CHANGED} * events is not guaranteed in this case also. * @param state a bitwise mask of frame state constants * @since 1.4 * @see java.awt.Window#addWindowStateListener */ // @ts-ignore public setExtendedState(state: number /*int*/): void /** * Gets the state of this frame (obsolete). *
* 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.
* @return Frame.NORMAL
or Frame.ICONIFIED
.
* @see #setState(int)
* @see #getExtendedState
*/
// @ts-ignore
public getState(): number /*int*/
/**
* Gets the state of this frame. The state is
* represented as a bitwise mask.
*
NORMAL
* ICONIFIED
* MAXIMIZED_HORIZ
* MAXIMIZED_VERT
* MAXIMIZED_BOTH
* MAXIMIZED_HORIZ
* and MAXIMIZED_VERT
.
* * 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
.
*
* Note, the given maximized bounds are used as a hint for the native
* system, because the underlying platform may not support setting the
* location and/or size of the maximized windows. If that is the case, the
* provided values do not affect the appearance of the frame in the
* maximized state.
* @param bounds bounds for the maximized state
* @see #getMaximizedBounds()
* @since 1.4
*/
// @ts-ignore
public setMaximizedBounds(bounds: java.awt.Rectangle): void
/**
* Gets maximized bounds for this frame.
* Some fields may contain Integer.MAX_VALUE
to indicate
* that system supplied values for this field must be used.
* @return maximized bounds for this frame; may be null
* @see #setMaximizedBounds(Rectangle)
* @since 1.4
*/
// @ts-ignore
public getMaximizedBounds(): java.awt.Rectangle
/**
* Disables or enables decorations for this frame.
*
* This method can only be called while the frame is not displayable. To
* make this frame decorated, it must be opaque and have the default shape,
* otherwise the {@code IllegalComponentStateException} will be thrown.
* Refer to {@link Window#setShape}, {@link Window#setOpacity} and {@link
* Window#setBackground} for details
* @param undecorated {#code true} if no frame decorations are to be
* enabled; {@code false} if frame decorations are to be enabled
* @throws IllegalComponentStateException if the frame is displayable
* @throws IllegalComponentStateException if {#code undecorated} is
* {@code false}, and this frame does not have the default shape
* @throws IllegalComponentStateException if {#code undecorated} is
* {@code false}, and this frame opacity is less than {@code 1.0f}
* @throws IllegalComponentStateException if {#code undecorated} is
* {@code false}, and the alpha value of this frame background
* color is less than {@code 1.0f}
* @see #isUndecorated
* @see Component#isDisplayable
* @see Window#getShape
* @see Window#getOpacity
* @see Window#getBackground
* @see javax.swing.JFrame#setDefaultLookAndFeelDecorated(boolean)
* @since 1.4
*/
// @ts-ignore
public setUndecorated(undecorated: boolean): void
/**
* Indicates whether this frame is undecorated.
* By default, all frames are initially decorated.
* @return true
if frame is undecorated;
* false
otherwise.
* @see java.awt.Frame#setUndecorated(boolean)
* @since 1.4
*/
// @ts-ignore
public isUndecorated(): boolean
/**
* {@inheritDoc}
*/
// @ts-ignore
public setOpacity(opacity: number /*float*/): void
/**
* {@inheritDoc}
*/
// @ts-ignore
public setShape(shape: java.awt.Shape): void
/**
* {@inheritDoc}
*/
// @ts-ignore
public setBackground(bgColor: java.awt.Color): void
/**
* Removes the specified menu bar from this frame.
* @param m the menu component to remove.
* If m
is null
, then
* no action is taken
*/
// @ts-ignore
public remove(m: java.awt.MenuComponent): void
/**
* Makes this Frame undisplayable by removing its connection
* to its native screen resource. Making a Frame undisplayable
* will cause any of its children to be made undisplayable.
* This method is called by the toolkit internally and should
* not be called directly by programs.
* @see Component#isDisplayable
* @see #addNotify
*/
// @ts-ignore
public removeNotify(): void
/**
* Returns a string representing the state of this Frame
.
* This method is intended to be used only for debugging purposes, and the
* content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
* null
.
* @return the parameter string of this frame
*/
// @ts-ignore
paramString(): string
/**
* @deprecated As of JDK version 1.1,
* replaced by Component.setCursor(Cursor)
.
*/
// @ts-ignore
public setCursor(cursorType: number /*int*/): void
/**
* @deprecated As of JDK version 1.1,
* replaced by Component.getCursor()
.
*/
// @ts-ignore
public getCursorType(): number /*int*/
/**
* Returns an array of all {@code Frame}s created by this application.
* If called from an applet, the array includes only the {@code Frame}s
* accessible by that applet.
*
* 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, LayoutManager
s or serialization.
*
* Note: To obtain a list of all ownerless windows, including * ownerless {@code Dialog}s (introduced in release 1.6), use {@link * Window#getOwnerlessWindows Window.getOwnerlessWindows}. * @see Window#getWindows() * @see Window#getOwnerlessWindows * @since 1.2 */ // @ts-ignore public static getFrames(): java.awt.Frame[] /** * Gets the AccessibleContext associated with this Frame. * For frames, the AccessibleContext takes the form of an * AccessibleAWTFrame. * A new AccessibleAWTFrame instance is created if necessary. * @return an AccessibleAWTFrame that serves as the * AccessibleContext of this Frame * @since 1.3 */ // @ts-ignore public getAccessibleContext(): javax.accessibility.AccessibleContext } } }