javax.swing.JInternalFrame — clojure-interop/javax.swing 1.0.5

A lightweight object that provides many of the features of a native frame, including dragging, closing, becoming an icon, resizing, title display, and support for a menu bar. For task-oriented documentation and examples of using internal frames, see How to Use Internal Frames, a section in The Java Tutorial.

Generally, you add JInternalFrames to a JDesktopPane. The UI delegates the look-and-feel-specific actions to the DesktopManager object maintained by the JDesktopPane.

The JInternalFrame content pane is where you add child components. As a convenience, the add, remove, and setLayout methods of this class are overridden, so that they delegate calls to the corresponding methods of the ContentPane. For example, you can add a child component to an internal frame as follows:

  internalFrame.add(child);

And the child will be added to the contentPane. The content pane is actually managed by an instance of JRootPane, which also manages a layout pane, glass pane, and optional menu bar for the internal frame. Please see the JRootPane documentation for a complete description of these components. Refer to RootPaneContainer for details on adding, removing and setting the LayoutManager of a JInternalFrame.

Warning: Swing is not thread safe. For more information see Swing's Threading Policy.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans™ has been added to the java.beans package. Please see XMLEncoder.

*-content-pane-property clj

Static Constant.

Bound property name.

type: java.lang.String

*-frame-icon-property clj

Static Constant.

Bound property name.

type: java.lang.String

*-glass-pane-property clj

Static Constant.

Bound property name.

type: java.lang.String

*-is-closed-property clj

Static Constant.

Constrained property name indicating that the internal frame is closed.

type: java.lang.String

*-is-icon-property clj

Static Constant.

Constrained property name indicating that the internal frame is iconified.

type: java.lang.String

*-is-maximum-property clj

Static Constant.

Constrained property name indicating that the internal frame is maximized.

type: java.lang.String

*-is-selected-property clj

Static Constant.

Constrained property name indicated that this frame has selected status.

type: java.lang.String

*-layered-pane-property clj

Static Constant.

Bound property name.

type: java.lang.String

*-menu-bar-property clj

Static Constant.

Bound property name.

type: java.lang.String

*-root-pane-property clj

Static Constant.

Bound property name.

type: java.lang.String

*-title-property clj

Static Constant.

Bound property name.

type: java.lang.String

->j-internal-frame clj

(->j-internal-frame)

(->j-internal-frame title)

(->j-internal-frame title resizable)

(->j-internal-frame title resizable closable)

(->j-internal-frame title resizable closable maximizable)

(->j-internal-frame title resizable closable maximizable iconifiable)

Constructor.

Creates a JInternalFrame with the specified title, resizability, closability, maximizability, and iconifiability. All JInternalFrame constructors use this one.

title - the String to display in the title bar - java.lang.String resizable - if true, the internal frame can be resized - boolean closable - if true, the internal frame can be closed - boolean maximizable - if true, the internal frame can be maximized - boolean iconifiable - if true, the internal frame can be iconified - boolean

add-internal-frame-listener clj

(add-internal-frame-listener this l)

Adds the specified listener to receive internal frame events from this internal frame.

l - the internal frame listener - javax.swing.event.InternalFrameListener

closable? clj

(closable? this)

Returns whether this JInternalFrame can be closed by some user action.

returns: true if this internal frame can be closed - boolean

closed? clj

(closed? this)

Returns whether this JInternalFrame is currently closed.

returns: true if this internal frame is closed, false otherwise - boolean

dispose clj

(dispose this)

Makes this internal frame invisible, unselected, and closed. If the frame is not already closed, this method fires an INTERNAL_FRAME_CLOSED event. The results of invoking this method are similar to setClosed(true), but dispose always succeeds in closing the internal frame and does not fire an INTERNAL_FRAME_CLOSING event.

do-default-close-action clj

(do-default-close-action this)

Fires an INTERNAL_FRAME_CLOSING event and then performs the action specified by the internal frame's default close operation. This method is typically invoked by the look-and-feel-implemented action handler for the internal frame's close button.

focus-cycle-root? clj

(focus-cycle-root? this)

Always returns true because all JInternalFrames must be roots of a focus traversal cycle.

returns: true - boolean

get-accessible-context clj

(get-accessible-context this)

Gets the AccessibleContext associated with this JInternalFrame. For internal frames, the AccessibleContext takes the form of an AccessibleJInternalFrame object. A new AccessibleJInternalFrame instance is created if necessary.

returns: an AccessibleJInternalFrame that serves as the AccessibleContext of this JInternalFrame - javax.accessibility.AccessibleContext

get-content-pane clj

(get-content-pane this)

Returns the content pane for this internal frame.

returns: the content pane - java.awt.Container

get-default-close-operation clj

(get-default-close-operation this)

Returns the default operation that occurs when the user initiates a "close" on this internal frame.

returns: the operation that will occur when the user closes the internal frame - int

get-desktop-icon clj

(get-desktop-icon this)

Returns the JDesktopIcon used when this JInternalFrame is iconified.

returns: the JDesktopIcon displayed on the desktop - javax.swing.JInternalFrame$JDesktopIcon

get-desktop-pane clj

(get-desktop-pane this)

Convenience method that searches the ancestor hierarchy for a JDesktop instance. If JInternalFrame finds none, the desktopIcon tree is searched.

returns: the JDesktopPane this internal frame belongs to, or null if none is found - javax.swing.JDesktopPane

get-focus-cycle-root-ancestor clj

(get-focus-cycle-root-ancestor this)

Always returns null because JInternalFrames must always be roots of a focus traversal cycle.

returns: null - java.awt.Container

get-focus-owner clj

(get-focus-owner this)

If this JInternalFrame is active, returns the child that has focus. Otherwise, returns null.

returns: the component with focus, or null if no children have focus - java.awt.Component

get-frame-icon clj

(get-frame-icon this)

Returns the image displayed in the title bar of this internal frame (usually in the top-left corner).

returns: the Icon displayed in the title bar - javax.swing.Icon

get-glass-pane clj

(get-glass-pane this)

Returns the glass pane for this internal frame.

returns: the glass pane - java.awt.Component

get-internal-frame-listeners clj

(get-internal-frame-listeners this)

Returns an array of all the InternalFrameListeners added to this JInternalFrame with addInternalFrameListener.

returns: all of the InternalFrameListeners added or an empty array if no listeners have been added - javax.swing.event.InternalFrameListener[]

get-j-menu-bar clj

(get-j-menu-bar this)

Returns the current JMenuBar for this JInternalFrame, or null if no menu bar has been set.

returns: the JMenuBar used by this internal frame - javax.swing.JMenuBar

get-last-cursor clj

(get-last-cursor this)

Returns the last Cursor that was set by the setCursor method that is not a resizable Cursor.

returns: the last non-resizable Cursor - java.awt.Cursor

get-layer clj

(get-layer this)

Convenience method for getting the layer attribute of this component.

returns: an Integer object specifying this frame's desktop layer - int

get-layered-pane clj

(get-layered-pane this)

Returns the layered pane for this internal frame.

returns: a JLayeredPane object - javax.swing.JLayeredPane

get-menu-bar clj

(get-menu-bar this)

Deprecated. As of Swing version 1.0.3, replaced by getJMenuBar().

returns: the current menu bar, or null if none has been set - javax.swing.JMenuBar

get-most-recent-focus-owner clj

(get-most-recent-focus-owner this)

Returns the child component of this JInternalFrame that will receive the focus when this JInternalFrame is selected. If this JInternalFrame is currently selected, this method returns the same component as the getFocusOwner method. If this JInternalFrame is not selected, then the child component that most recently requested focus will be returned. If no child component has ever requested focus, then this JInternalFrame's initial focusable component is returned. If no such child exists, then this JInternalFrame's default component to focus is returned.

returns: the child component that will receive focus when this JInternalFrame is selected - java.awt.Component

get-normal-bounds clj

(get-normal-bounds this)

If the JInternalFrame is not in maximized state, returns getBounds(); otherwise, returns the bounds that the JInternalFrame would be restored to.

returns: a Rectangle containing the bounds of this frame when in the normal state - java.awt.Rectangle

get-root-pane clj

(get-root-pane this)

Returns the rootPane object for this internal frame.

returns: the rootPane property - javax.swing.JRootPane

get-title clj

(get-title this)

Returns the title of the JInternalFrame.

returns: a String containing this internal frame's title - java.lang.String

get-ui clj

(get-ui this)

Returns the look-and-feel object that renders this component.

returns: the InternalFrameUI object that renders this component - javax.swing.plaf.InternalFrameUI

get-ui-class-id clj

(get-ui-class-id this)

Returns the name of the look-and-feel class that renders this component.

returns: the string "InternalFrameUI" - java.lang.String

get-warning-string clj

(get-warning-string this)

Gets the warning string that is displayed with this internal frame. Since an internal frame is always secure (since it's fully contained within a window that might need a warning string) this method always returns null.

returns: null - java.lang.String

hide clj

(hide this)

Description copied from class: JComponent

icon? clj

(icon? this)

Returns whether the JInternalFrame is currently iconified.

returns: true if this internal frame is iconified - boolean

iconifiable? clj

(iconifiable? this)

Gets the iconable property, which by default is false.

returns: the value of the iconable property. - boolean

maximizable? clj

(maximizable? this)

Gets the value of the maximizable property.

returns: the value of the maximizable property - boolean

maximum? clj

(maximum? this)

Returns whether the JInternalFrame is currently maximized.

returns: true if this internal frame is maximized, false otherwise - boolean

move-to-back clj

(move-to-back this)

Convenience method that moves this component to position -1 if its parent is a JLayeredPane.

move-to-front clj

(move-to-front this)

Convenience method that moves this component to position 0 if its parent is a JLayeredPane.

pack clj

(pack this)

Causes subcomponents of this JInternalFrame to be laid out at their preferred size. Internal frames that are iconized or maximized are first restored and then packed. If the internal frame is unable to be restored its state is not changed and will not be packed.

remove clj

(remove this comp)

Removes the specified component from the container. If comp is not a child of the JInternalFrame this will forward the call to the contentPane.

comp - the component to be removed - java.awt.Component

throws: java.lang.NullPointerException - if comp is null

remove-internal-frame-listener clj

(remove-internal-frame-listener this l)

Removes the specified internal frame listener so that it no longer receives internal frame events from this internal frame.

l - the internal frame listener - javax.swing.event.InternalFrameListener

reshape clj

(reshape this x y width height)

Moves and resizes this component. Unlike other components, this implementation also forces re-layout, so that frame decorations such as the title bar are always redisplayed.

x - an integer giving the component's new horizontal position measured in pixels from the left of its container - int y - an integer giving the component's new vertical position, measured in pixels from the bottom of its container - int width - an integer giving the component's new width in pixels - int height - an integer giving the component's new height in pixels - int

resizable? clj

(resizable? this)

Returns whether the JInternalFrame can be resized by some user action.

returns: true if this internal frame can be resized, false otherwise - boolean

restore-subcomponent-focus clj

(restore-subcomponent-focus this)

Requests the internal frame to restore focus to the last subcomponent that had focus. This is used by the UI when the user selected this internal frame -- for example, by clicking on the title bar.

selected? clj

(selected? this)

Returns whether the JInternalFrame is the currently "selected" or active frame.

returns: true if this internal frame is currently selected (active) - boolean

set-closable clj

(set-closable this b)

Sets whether this JInternalFrame can be closed by some user action.

b - a boolean value, where true means this internal frame can be closed - boolean

set-closed clj

(set-closed this b)

Closes this internal frame if the argument is true. Do not invoke this method with a false argument; the result of invoking setClosed(false) is unspecified.

If the internal frame is already closed, this method does nothing and returns immediately. Otherwise, this method begins by firing an INTERNAL_FRAME_CLOSING event. Then this method sets the closed property to true unless a listener vetoes the property change. This method finishes by making the internal frame invisible and unselected, and then firing an INTERNAL_FRAME_CLOSED event.

Note: To reuse an internal frame that has been closed, you must add it to a container (even if you never removed it from its previous container). Typically, this container will be the JDesktopPane that previously contained the internal frame.

b - must be true - boolean

throws: java.beans.PropertyVetoException - when the attempt to set the property is vetoed by the JInternalFrame

set-content-pane clj

(set-content-pane this c)

Sets this JInternalFrame's contentPane property.

c - the content pane for this internal frame - java.awt.Container

throws: java.awt.IllegalComponentStateException - (a runtime exception) if the content pane parameter is null

set-cursor clj

(set-cursor this cursor)

Sets the cursor image to the specified cursor. This cursor image is displayed when the contains method for this component returns true for the current cursor location, and this Component is visible, displayable, and enabled. Setting the cursor of a Container causes that cursor to be displayed within all of the container's subcomponents, except for those that have a non-null cursor.

The method may have no visual effect if the Java platform implementation and/or the native system do not support changing the mouse cursor shape.

cursor - One of the constants defined by the Cursor class; if this parameter is null then this component will inherit the cursor of its parent - java.awt.Cursor

set-default-close-operation clj

(set-default-close-operation this operation)

Sets the operation that will happen by default when the user initiates a "close" on this internal frame. The possible choices are:

DO_NOTHING_ON_CLOSE Do nothing. This requires the program to handle the operation in the internalFrameClosing method of a registered InternalFrameListener object. HIDE_ON_CLOSE Automatically make the internal frame invisible. DISPOSE_ON_CLOSE Automatically dispose of the internal frame.

The default value is DISPOSE_ON_CLOSE. Before performing the specified close operation, the internal frame fires an INTERNAL_FRAME_CLOSING event.

operation - one of the following constants defined in javax.swing.WindowConstants (an interface implemented by JInternalFrame): DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE, or DISPOSE_ON_CLOSE - int

set-desktop-icon clj

(set-desktop-icon this d)

Sets the JDesktopIcon associated with this JInternalFrame.

d - the JDesktopIcon to display on the desktop - javax.swing.JInternalFrame$JDesktopIcon

set-focus-cycle-root clj

(set-focus-cycle-root this focus-cycle-root)

Does nothing because JInternalFrames must always be roots of a focus traversal cycle.

focus-cycle-root - this value is ignored - boolean

set-frame-icon clj

(set-frame-icon this icon)

Sets an image to be displayed in the titlebar of this internal frame (usually in the top-left corner). This image is not the desktopIcon object, which is the image displayed in the JDesktop when this internal frame is iconified.

Passing null to this function is valid, but the look and feel can choose the appropriate behavior for that situation, such as displaying no icon or a default icon for the look and feel.

icon - the Icon to display in the title bar - javax.swing.Icon

set-glass-pane clj

(set-glass-pane this glass)

Sets this JInternalFrame's glassPane property.

glass - the glass pane for this internal frame - java.awt.Component

set-icon clj

(set-icon this b)

Iconifies or de-iconifies this internal frame, if the look and feel supports iconification. If the internal frame's state changes to iconified, this method fires an INTERNAL_FRAME_ICONIFIED event. If the state changes to de-iconified, an INTERNAL_FRAME_DEICONIFIED event is fired.

b - a boolean, where true means to iconify this internal frame and false means to de-iconify it - boolean

throws: java.beans.PropertyVetoException - when the attempt to set the property is vetoed by the JInternalFrame

set-iconifiable clj

(set-iconifiable this b)

Sets the iconable property, which must be true for the user to be able to make the JInternalFrame an icon. Some look and feels might not implement iconification; they will ignore this property.

b - a boolean, where true means this internal frame can be iconified - boolean

set-j-menu-bar clj

(set-j-menu-bar this m)

Sets the menuBar property for this JInternalFrame.

m - the JMenuBar to use in this internal frame - javax.swing.JMenuBar

set-layer clj

(set-layer this layer)

Convenience method for setting the layer attribute of this component.

layer - an Integer object specifying this frame's desktop layer - java.lang.Integer

set-layered-pane clj

(set-layered-pane this layered)

Sets this JInternalFrame's layeredPane property.

layered - the JLayeredPane for this internal frame - javax.swing.JLayeredPane

throws: java.awt.IllegalComponentStateException - (a runtime exception) if the layered pane parameter is null

set-layout clj

(set-layout this manager)

Ensures that, by default, the layout of this component cannot be set. Overridden to conditionally forward the call to the contentPane. Refer to RootPaneContainer for more information.

manager - the LayoutManager - java.awt.LayoutManager

set-maximizable clj

(set-maximizable this b)

Sets the maximizable property, which determines whether the JInternalFrame can be maximized by some user action. Some look and feels might not support maximizing internal frames; they will ignore this property.

b - true to specify that this internal frame should be maximizable; false to specify that it should not be - boolean

set-maximum clj

(set-maximum this b)

Maximizes and restores this internal frame. A maximized frame is resized to fully fit the JDesktopPane area associated with the JInternalFrame. A restored frame's size is set to the JInternalFrame's actual size.

b - a boolean, where true maximizes this internal frame and false restores it - boolean

throws: java.beans.PropertyVetoException - when the attempt to set the property is vetoed by the JInternalFrame

set-menu-bar clj

(set-menu-bar this m)

Deprecated. As of Swing version 1.0.3 replaced by setJMenuBar(JMenuBar m).

m - the JMenuBar to use in this internal frame - javax.swing.JMenuBar

set-normal-bounds clj

(set-normal-bounds this r)

Sets the normal bounds for this internal frame, the bounds that this internal frame would be restored to from its maximized state. This method is intended for use only by desktop managers.

r - the bounds that this internal frame should be restored to - java.awt.Rectangle

set-resizable clj

(set-resizable this b)

Sets whether the JInternalFrame can be resized by some user action.

b - a boolean, where true means this internal frame can be resized - boolean

set-selected clj

(set-selected this selected)

Selects or deselects the internal frame if it's showing. A JInternalFrame normally draws its title bar differently if it is the selected frame, which indicates to the user that this internal frame has the focus. When this method changes the state of the internal frame from deselected to selected, it fires an InternalFrameEvent.INTERNAL_FRAME_ACTIVATED event. If the change is from selected to deselected, an InternalFrameEvent.INTERNAL_FRAME_DEACTIVATED event is fired.

selected - a boolean, where true means this internal frame should become selected (currently active) and false means it should become deselected - boolean

throws: java.beans.PropertyVetoException - when the attempt to set the property is vetoed by the JInternalFrame

set-title clj

(set-title this title)

Sets the JInternalFrame title. title may have a null value.

title - the String to display in the title bar - java.lang.String

set-ui clj

(set-ui this ui)

Sets the UI delegate for this JInternalFrame.

ui - the UI delegate - javax.swing.plaf.InternalFrameUI

show clj

(show this)

If the internal frame is not visible, brings the internal frame to the front, makes it visible, and attempts to select it. The first time the internal frame is made visible, this method also fires an INTERNAL_FRAME_OPENED event. This method does nothing if the internal frame is already visible. Invoking this method has the same result as invoking setVisible(true).

to-back clj

(to-back this)

Sends this internal frame to the back. Places this internal frame at the bottom of the stacking order and makes the corresponding adjustment to other visible internal frames.

to-front clj

(to-front this)

Brings this internal frame to the front. Places this internal frame at the top of the stacking order and makes the corresponding adjustment to other visible internal frames.

update-ui clj

(update-ui this)

Notification from the UIManager that the look and feel has changed. Replaces the current UI object with the latest version from the UIManager.