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

The main class for creating a dialog window. You can use this class to create a custom dialog, or invoke the many class methods in JOptionPane to create a variety of standard dialogs. For information about creating dialogs, see The Java Tutorial section How to Make Dialogs.

The JDialog component contains a JRootPane as its only child. The contentPane should be the parent of any children of the JDialog. 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 a dialog as follows:

  dialog.add(child);

And the child will be added to the contentPane. The contentPane is always non-null. Attempting to set it to null generates an exception. The default contentPane has a BorderLayout manager set on it. Refer to RootPaneContainer for details on adding, removing and setting the LayoutManager of a JDialog.

Please see the JRootPane documentation for a complete description of the contentPane, glassPane, and layeredPane components.

In a multi-screen environment, you can create a JDialog on a different screen device than its owner. See Frame for more information.

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.

*default-look-and-feel-decorated? clj

(*default-look-and-feel-decorated?)

Returns true if newly created JDialogs should have their Window decorations provided by the current look and feel. This is only a hint, as certain look and feels may not support this feature.

returns: true if look and feel should provide Window decorations. - boolean

*set-default-look-and-feel-decorated clj

(*set-default-look-and-feel-decorated default-look-and-feel-decorated)

Provides a hint as to whether or not newly created JDialogs should have their Window decorations (such as borders, widgets to close the window, title...) provided by the current look and feel. If defaultLookAndFeelDecorated is true, the current LookAndFeel supports providing window decorations, and the current window manager supports undecorated windows, then newly created JDialogs will have their Window decorations provided by the current LookAndFeel. Otherwise, newly created JDialogs will have their Window decorations provided by the current window manager.

You can get the same effect on a single JDialog by doing the following:

JDialog dialog = new JDialog();
dialog.setUndecorated(true);
dialog.getRootPane().setWindowDecorationStyle(JRootPane.PLAIN_DIALOG);

default-look-and-feel-decorated - A hint as to whether or not current look and feel should provide window decorations - boolean

->j-dialog clj

(->j-dialog)

(->j-dialog owner)

(->j-dialog owner modal)

(->j-dialog owner title modal)

(->j-dialog owner title modal gc)

Constructor.

Creates a dialog with the specified title, owner Frame, modality and GraphicsConfiguration. If owner is null, a shared, hidden frame will be set as the owner of this dialog.

This constructor sets the component's locale property to the value returned by JComponent.getDefaultLocale.

NOTE: Any popup components (JComboBox, JPopupMenu, JMenuBar) created within a modal dialog will be forced to be lightweight.

NOTE: This constructor does not allow you to create an unowned JDialog. To create an unowned JDialog you must use either the JDialog(Window) or JDialog(Dialog) constructor with an argument of null.

owner - the Frame from which the dialog is displayed - java.awt.Frame title - the String to display in the dialog's title bar - java.lang.String modal - specifies whether dialog blocks user input to other top-level windows when shown. If true, the modality type property is set to DEFAULT_MODALITY_TYPE, otherwise the dialog is modeless. - boolean gc - the GraphicsConfiguration of the target screen device; if null, the default system GraphicsConfiguration is assumed - java.awt.GraphicsConfiguration

throws: java.awt.HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

get-accessible-context clj

(get-accessible-context this)

Gets the AccessibleContext associated with this JDialog. For JDialogs, the AccessibleContext takes the form of an AccessibleJDialog. A new AccessibleJDialog instance is created if necessary.

returns: an AccessibleJDialog that serves as the AccessibleContext of this JDialog - javax.accessibility.AccessibleContext

get-content-pane clj

(get-content-pane this)

Returns the contentPane object for this dialog.

returns: the contentPane property - java.awt.Container

get-default-close-operation clj

(get-default-close-operation this)

Returns the operation which occurs when the user initiates a "close" on this dialog.

returns: an integer indicating the window-close operation - int

get-glass-pane clj

(get-glass-pane this)

Returns the glassPane object for this dialog.

returns: the glassPane property - java.awt.Component

get-graphics clj

(get-graphics this)

Creates a graphics context for this component. This method will return null if this component is currently not displayable.

returns: a graphics context for this component, or null if it has none - java.awt.Graphics

get-j-menu-bar clj

(get-j-menu-bar this)

Returns the menubar set on this dialog.

returns: javax.swing.JMenuBar

get-layered-pane clj

(get-layered-pane this)

Returns the layeredPane object for this dialog.

returns: the layeredPane property - javax.swing.JLayeredPane

get-root-pane clj

(get-root-pane this)

Returns the rootPane object for this dialog.

returns: this components single JRootPane child. - javax.swing.JRootPane

get-transfer-handler clj

(get-transfer-handler this)

Gets the transferHandler property.

returns: the value of the transferHandler property - javax.swing.TransferHandler

remove clj

(remove this comp)

Removes the specified component from the container. If comp is not the rootPane, this will forward the call to the contentPane. This will do nothing if comp is not a child of the JDialog or contentPane.

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

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

repaint clj

(repaint this time x y width height)

Repaints the specified rectangle of this component within time milliseconds. Refer to RepaintManager for details on how the repaint is handled.

time - maximum time in milliseconds before update - long x - the x coordinate - int y - the y coordinate - int width - the width - int height - the height - int

set-content-pane clj

(set-content-pane this content-pane)

Sets the contentPane property. This method is called by the constructor.

Swing's painting architecture requires an opaque JComponent in the containment hierarchy. This is typically provided by the content pane. If you replace the content pane it is recommended you replace it with an opaque JComponent.

content-pane - the contentPane object for this dialog - java.awt.Container

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

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 dialog. You must specify one of the following choices:

DO_NOTHING_ON_CLOSE (defined in WindowConstants): Don't do anything; require the program to handle the operation in the windowClosing method of a registered WindowListener object.

HIDE_ON_CLOSE (defined in WindowConstants): Automatically hide the dialog after invoking any registered WindowListener objects.

DISPOSE_ON_CLOSE (defined in WindowConstants): Automatically hide and dispose the dialog after invoking any registered WindowListener objects.

The value is set to HIDE_ON_CLOSE by default. Changes to the value of this property cause the firing of a property change event, with property name "defaultCloseOperation".

Note: When the last displayable window within the Java virtual machine (VM) is disposed of, the VM may terminate. See AWT Threading Issues for more information.

operation - the operation which should be performed when the user closes the dialog - int

throws: java.lang.IllegalArgumentException - if defaultCloseOperation value isn't one of the above valid values

set-glass-pane clj

(set-glass-pane this glass-pane)

Sets the glassPane property. This method is called by the constructor.

glass-pane - the glassPane object for this dialog - java.awt.Component

set-j-menu-bar clj

(set-j-menu-bar this menu)

Sets the menubar for this dialog.

menu - the menubar being placed in the dialog - javax.swing.JMenuBar

set-layered-pane clj

(set-layered-pane this layered-pane)

Sets the layeredPane property. This method is called by the constructor.

layered-pane - the new layeredPane property - javax.swing.JLayeredPane

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

set-layout clj

(set-layout this manager)

Sets the LayoutManager. Overridden to conditionally forward the call to the contentPane. Refer to RootPaneContainer for more information.

manager - the LayoutManager - java.awt.LayoutManager

set-transfer-handler clj

(set-transfer-handler this new-handler)

Sets the transferHandler property, which is a mechanism to support transfer of data into this component. Use null if the component does not support data transfer operations.

If the system property suppressSwingDropSupport is false (the default) and the current drop target on this component is either null or not a user-set drop target, this method will change the drop target as follows: If newHandler is null it will clear the drop target. If not null it will install a new DropTarget.

Note: When used with JDialog, TransferHandler only provides data import capability, as the data export related methods are currently typed to JComponent.

Please see

How to Use Drag and Drop and Data Transfer, a section in The Java Tutorial, for more information.

new-handler - the new TransferHandler - javax.swing.TransferHandler

update clj

(update this g)

Calls paint(g). This method was overridden to prevent an unnecessary call to clear the background.

g - the Graphics context in which to paint - java.awt.Graphics