All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.JDialog

java.lang.Object
   |
   +----java.awt.Component
           |
           +----java.awt.Container
                   |
                   +----java.awt.Window
                           |
                           +----java.awt.Dialog
                                   |
                                   +----com.sun.java.swing.JDialog

public class JDialog
extends Dialog
implements Accessible
The JDialog component contains a JRootPane as it's only child. The contentPane() should be the parent of any children of the JDialog. From the older java.awt.Window object you would normally do something:
       dialog.add(child);
 
Using JDialog the proper semantic is:
       dialog.getContentPane().add(child);
 
The same is true of setting LayoutManagers, removing components, listing children, etc. All these methods should normally be sent to the contentPane() instead of the JDialog itself. The contentPane() will always be non-null. Attempting to set it to null will cause the JDialog to throw an exception. The default contentPane() will have a BorderLayout manager set on it.

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

JDialog offers the option of having show block until the dialog is closed. This differs from modal in that other windows can still be manipulated.

NOTE: For the current release modal panels will still allow input to all other windows, but will block. We are aware of this and will fix it in a later release.

See Also:
JRootPane

Variable Index

 o accessibleDescription
 o accessibleName
 o realModal
Our own bit for modality.
 o rootPane

Constructor Index

 o JDialog(Frame)
 o JDialog(Frame, boolean)
 o JDialog(Frame, String)
 o JDialog(Frame, String, boolean)

Method Index

 o addAccessibleSelection(int)
Adds the nth selected item in the object to the object's selection.
 o blockingShow()
Messaged after super has been messaged to show if the Dialog is to block.
 o clearAccessibleSelection()
Clears the selection in the object, so that nothing in the object is selected.
 o createRootPane()
Called by the constructor methods to create the default rootPane.
 o dialogInit()
Called by the constructors to init the JDialog properly.
 o doAccessibleAction(int)
Perform the nth Action on the object
 o getAccessibleActionCount()
Returns the number of Actions available in this object If there is more than one, the first one is the "default" action (if any action is considered "default").
 o getAccessibleActionDescription(int)
Return a description of the nth action of the object.
 o getAccessibleAt(Point)
Returns the Accessible child contained at the local coordinate Point, if one exists.
 o getAccessibleChild(int)
Return the nth Accessible child of the object.
 o getAccessibleChildrenCount()
Returns the number of accessible children in the object.
 o getAccessibleDescription()
Get the accessible description of this object.
 o getAccessibleName()
Get the accessible name of this object.
 o getAccessibleParent()
Get the Accessible parent of this object.
 o getAccessibleRole()
Get the role of this object.
 o getAccessibleSelection(int)
Returns an Accessible representing the nth selected item in the object.
 o getAccessibleSelectionCount()
Returns the number of items currently selected.
 o getAccessibleStateSet()
Get the state of this object.
 o getAccessibleText()
Gets the AccessibleText interface for the component.
 o getAccessibleValue()
Get the value of this object as a String.
 o getContentPane()
 o getGlassPane()
 o getLayeredPane()
 o getNextAccessibleSibling()
Get the next sibling of this Accessible, if a preferred one exists.
 o getPreviousAccessibleSibling()
Get the previous sibling of this Accessible, if a preferred one exists.
 o getRootPane()
 o isModal()
NOTE: for the current release this will return false, regardless.
 o removeAccessibleSelection(int)
Removes the nth selected item in the object from the object's selection.
 o selectAllAccessibleSelection()
Causes every selected item in the object to be selected, if the object supports multiple selections (if getAccessibleStateSet returns a state that is MULTISELECTABLE).
 o setAccessibleDescription(String)
Set the accessible description of this object.
 o setAccessibleName(String)
Set the localized accessible name of this object.
 o setContentPane(Container)
 o setGlassPane(Component)
 o setLayeredPane(JLayeredPane)
 o setLocationRelativeTo(Component)
Sets the location of the receiver relative to the the Component c is contained in.
 o setModal(boolean)
If newValue is true when the receiver is messaged with show it will block.

NOTE: For the current release modal dialogs will block, but still allow input to other windows, this will be fixed in a later release.

 o setRootPane(JRootPane)
 o setVisible(boolean)
Invokes a notifyAll to potentially wake up another thread and the messages super.
 o show()
Creates a new EventDispatchThread to dispatch events from.

Variables

 o realModal
 protected boolean realModal
Our own bit for modality.

 o rootPane
 protected JRootPane rootPane
 o accessibleName
 protected String accessibleName
 o accessibleDescription
 protected String accessibleDescription

Constructors

 o JDialog
 public JDialog(Frame parent)
 o JDialog
 public JDialog(Frame parent,
                boolean modal)
 o JDialog
 public JDialog(Frame parent,
                String title)
 o JDialog
 public JDialog(Frame parent,
                String title,
                boolean modal)

Methods

 o setModal
 public void setModal(boolean newValue)
If newValue is true when the receiver is messaged with show it will block.

NOTE: For the current release modal dialogs will block, but still allow input to other windows, this will be fixed in a later release.

Overrides:
setModal in class Dialog
 o isModal
 public boolean isModal()
NOTE: for the current release this will return false, regardless.

Overrides:
isModal in class Dialog
 o dialogInit
 protected void dialogInit()
Called by the constructors to init the JDialog properly.

 o createRootPane
 protected JRootPane createRootPane()
Called by the constructor methods to create the default rootPane.

 o setContentPane
 public void setContentPane(Container content)
 o getContentPane
 public Container getContentPane()
 o setLayeredPane
 public void setLayeredPane(JLayeredPane layered)
 o getLayeredPane
 public JLayeredPane getLayeredPane()
 o setGlassPane
 public void setGlassPane(Component glass)
 o getGlassPane
 public Component getGlassPane()
 o setRootPane
 protected void setRootPane(JRootPane root)
 o getRootPane
 public JRootPane getRootPane()
 o show
 public void show()
Creates a new EventDispatchThread to dispatch events from. This method will return when stopModal is invoked.

Overrides:
show in class Dialog
 o setLocationRelativeTo
 public void setLocationRelativeTo(Component c)
Sets the location of the receiver relative to the the Component c is contained in. If c is not currently showing the location is set centered on the screen.

 o blockingShow
 protected synchronized void blockingShow()
Messaged after super has been messaged to show if the Dialog is to block.

 o setVisible
 public void setVisible(boolean b)
Invokes a notifyAll to potentially wake up another thread and the messages super.

Overrides:
setVisible in class Component
 o getNextAccessibleSibling
 public Accessible getNextAccessibleSibling()
Get the next sibling of this Accessible, if a preferred one exists. This should generally return the next item in the tab order, if that item implements Accessible

Returns:
the next Accessible, if there is one
 o getPreviousAccessibleSibling
 public Accessible getPreviousAccessibleSibling()
Get the previous sibling of this Accessible, if a preferred one exists. This should generally return the previous item in the tab order, if that item implements Accessible

Returns:
the previous Accessible, if there is one
 o getAccessibleAt
 public Accessible getAccessibleAt(Point p)
Returns the Accessible child contained at the local coordinate Point, if one exists.

Returns:
the Accessible at the specified location, if it exists
 o getAccessibleName
 public String getAccessibleName()
Get the accessible name of this object. This should almost never return java.awt.Component.getName(), as that generally isn't a localized name, and doesn't have meaning for the user. If the object is fundamentally a text object (e.g. a menu item), the accessible name should be the text of the object (e.g. "save"). If the object has a tooltip, the tooltip text may also be an appropriate String to return.

Returns:
the localized name of the object -- can be null if this object does not have a name
See Also:
setAccessibleName
 o setAccessibleName
 public void setAccessibleName(String s)
Set the localized accessible name of this object.

Parameters:
s - the new localized name of the object.
See Also:
getAccessibleName
 o getAccessibleDescription
 public String getAccessibleDescription()
Get the accessible description of this object. This should be a concise, localized description of what this object is - what is it's meaning to the user. If the object has a tooltip, the tooltip text may be an appropriate string to return, assuming it contains a concise description of the object (instead of just the name of the object - e.g. a "Save" icon on a toolbar that had "save" as the tooltip text shouldn't return the tooltip text as the description, but something like "Saves the current text document" instead).

Returns:
the localized description of the object -- can be null if this object does not have a description
See Also:
setAccessibleDescription
 o setAccessibleDescription
 public void setAccessibleDescription(String s)
Set the accessible description of this object.

Parameters:
s - the new localized description of the object
See Also:
getAccessibleDescription
 o getAccessibleStateSet
 public AccessibleStateSet getAccessibleStateSet()
Get the state of this object.

Returns:
an instance of AccessibleStateSet containing the current state set of the object
See Also:
AccessibleState
 o getAccessibleRole
 public AccessibleRole getAccessibleRole()
Get the role of this object.

Returns:
an instance of AccessibleRole describing the role of the object
See Also:
AccessibleRole
 o getAccessibleValue
 public String getAccessibleValue()
Get the value of this object as a String. This should almost never return java.Object.toString(), as that is not a localized, human readable representation of the value of the object.

Returns:
human readable value of the object -- can be null if this object does not have a value
 o getAccessibleParent
 public Accessible getAccessibleParent()
Get the Accessible parent of this object. If the parent of this object implements Accessible, this method should simply return getParent().

Returns:
the Accessible parent of this object -- can be null if this object does not have an Accessible parent
 o getAccessibleChildrenCount
 public int getAccessibleChildrenCount()
Returns the number of accessible children in the object. If all of the children of this object implement Accessible, than this method should return the number of children of this object.

Returns:
the number of accessible children in the object.
 o getAccessibleChild
 public Accessible getAccessibleChild(int i)
Return the nth Accessible child of the object.

Parameters:
i - zero-based index of child
Returns:
the nth Accessible child of the object
 o getAccessibleActionCount
 public int getAccessibleActionCount()
Returns the number of Actions available in this object If there is more than one, the first one is the "default" action (if any action is considered "default").

Returns:
the number of Actions in this object
 o getAccessibleActionDescription
 public String getAccessibleActionDescription(int i)
Return a description of the nth action of the object. This description should be human-readable; by default it currently isn't...

Parameters:
i - zero-based index of the actions
Returns:
a description of the nth action
 o doAccessibleAction
 public boolean doAccessibleAction(int i)
Perform the nth Action on the object

Parameters:
i - zero-based index of actions
Returns:
whether the action was performed or not.
 o getAccessibleText
 public AccessibleText getAccessibleText()
Gets the AccessibleText interface for the component. If the component does not speak AccessibleText, or have a proxy which does, this method returns null.

Returns:
the AccessibleText of the object.
See Also:
AccessibleText
 o getAccessibleSelectionCount
 public int getAccessibleSelectionCount()
Returns the number of items currently selected. If no items are selected, the return value will be 0.

Returns:
the number of items currently selected.
 o getAccessibleSelection
 public Accessible getAccessibleSelection(int i)
Returns an Accessible representing the nth selected item in the object. If there isn't a selection, or there are fewer items selcted than the integer passed in, the return value will be null.

Parameters:
i - the zero-based index of selected items
Returns:
an Accessible containing the selected item
 o addAccessibleSelection
 public void addAccessibleSelection(int i)
Adds the nth selected item in the object to the object's selection. If the object supports multiple selections, (the method getAccessibleStateSet returns a state that is MULTISELECTABLE) the nth item is added to any existing selection, otherwse it replaces any existing selection in the objct. If the nth item is already selected, this method has no effect.

Parameters:
i - the zero-based index of selectable items
See Also:
getAccessibleStateSet
 o removeAccessibleSelection
 public void removeAccessibleSelection(int i)
Removes the nth selected item in the object from the object's selection. If the nth item isn't currently selected, this method has no effect.

Parameters:
i - the zero-based index of selectable items
 o clearAccessibleSelection
 public void clearAccessibleSelection()
Clears the selection in the object, so that nothing in the object is selected.

 o selectAllAccessibleSelection
 public void selectAllAccessibleSelection()
Causes every selected item in the object to be selected, if the object supports multiple selections (if getAccessibleStateSet returns a state that is MULTISELECTABLE).

See Also:
getAccessibleStateSet

All Packages  Class Hierarchy  This Package  Previous  Next  Index