All Packages  Class Hierarchy  This Package  Previous  Next  Index  

Class java.awt.swing.JDialog

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

public class JDialog

extends Dialog

implements WindowConstants, Accessible

       dialog.add(child);
 

       dialog.getContentPane().add(child);
 

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

accessibleDescription

accessibleName

realModal

Our own bit for modality.

rootPane

JDialog(Frame)

JDialog(Frame, boolean)

JDialog(Frame, String)

JDialog(Frame, String, boolean)

addAccessibleSelection(int)

Adds the nth selected item in the object to the object's selection.

blockingShow()

Messaged after super has been messaged to show if the Dialog is to block.

clearAccessibleSelection()

Clears the selection in the object, so that nothing in the object is selected.

createRootPane()

Called by the constructor methods to create the default rootPane.

dialogInit()

Called by the constructors to init the JDialog properly.

doAccessibleAction(int)

Perform the nth Action on the object

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").

getAccessibleActionDescription(int)

Return a description of the nth action of the object.

getAccessibleAt(Point)

Returns the Accessible child contained at the local coordinate Point, if one exists.

getAccessibleChild(int)

Return the nth Accessible child of the object.

getAccessibleChildrenCount()

Returns the number of accessible children in the object.

getAccessibleDescription()

Get the accessible description of this object.

getAccessibleName()

Get the accessible name of this object.

getAccessibleParent()

Get the Accessible parent of this object.

getAccessibleRole()

Get the role of this object.

getAccessibleSelection(int)

Returns an Accessible representing the nth selected item in the object.

getAccessibleSelectionCount()

Returns the number of items currently selected.

getAccessibleStateSet()

Get the state of this object.

getAccessibleText()

Gets the AccessibleText interface for the component.

getAccessibleValue()

Get the value of this object as a Number.

getContentPane()

getDefaultCloseOperation()

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

getGlassPane()

getLayeredPane()

getMaximumAccessibleValue()

Get the maximum value of this object as a Number.

getMinimumAccessibleValue()

Get the minimum value of this object as a Number.

getNextAccessibleSibling()

Get the next sibling of this Accessible, if a preferred one exists.

getPreviousAccessibleSibling()

Get the previous sibling of this Accessible, if a preferred one exists.

getRootPane()

isModal()

NOTE: for the current release this will return false, regardless.

processWindowEvent(WindowEvent)

Processes window events occurring on this window by dispatching them to any registered WindowListener objects.

removeAccessibleSelection(int)

Removes the nth selected item in the object from the object's selection.

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).

setAccessibleDescription(String)

Set the accessible description of this object.

setAccessibleName(String)

Set the localized accessible name of this object.

setAccessibleValue(Number)

Set the value of this object as a Number.

setContentPane(Container)

setDefaultCloseOperation(int)

Sets the operation which will happen by default when the user initiates a "close" on this window.

setGlassPane(Component)

setLayeredPane(JLayeredPane)

setLocationRelativeTo(Component)

Sets the location of the receiver relative to the the Component c is contained in.

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.

setRootPane(JRootPane)

setVisible(boolean)

Invokes a notifyAll to potentially wake up another thread and the messages super.

show()

Creates a new EventDispatchThread to dispatch events from.

protected boolean realModal

Our own bit for modality.

protected JRootPane rootPane

protected String accessibleName

protected String accessibleDescription

public JDialog(Frame parent)

public JDialog(Frame parent,
               boolean modal)

public JDialog(Frame parent,
               String title)

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

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

public boolean isModal()

NOTE: for the current release this will return false, regardless.

Overrides:

isModal in class Dialog

protected void dialogInit()

Called by the constructors to init the JDialog properly.

protected JRootPane createRootPane()

Called by the constructor methods to create the default rootPane.

protected void processWindowEvent(WindowEvent e)

Processes window events occurring on this window by dispatching them to any registered WindowListener objects.

Overrides:

processWindowEvent in class Window

public void setContentPane(Container content)

public Container getContentPane()

public void setLayeredPane(JLayeredPane layered)

public JLayeredPane getLayeredPane()

public void setGlassPane(Component glass)

public Component getGlassPane()

protected void setRootPane(JRootPane root)

public JRootPane getRootPane()

public void setDefaultCloseOperation(int operation)

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

• DO_NOTHING_ON_CLOSE - do not do anything - require the program to handle the operation in the windowClosing method of a registered WindowListener object.
• HIDE_ON_CLOSE - automatically hide the window after invoking any registered WindowListener objects
• DISPOSE_ON_CLOSE - automatically hide and dispose the window after invoking any registered WindowListener objects

The value is set to HIDE_ON_CLOSE by default.

See Also:

addWindowListener, getDefaultCloseOperation

public int getDefaultCloseOperation()

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

See Also:

setDefaultCloseOperation

public void show()

Creates a new EventDispatchThread to dispatch events from. This method will return when stopModal is invoked.

Overrides:

show in class Dialog

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.

protected void blockingShow()

Messaged after super has been messaged to show if the Dialog is to block.

public void setVisible(boolean b)

Invokes a notifyAll to potentially wake up another thread and the messages super.

Overrides:

setVisible in class Component

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

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

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

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

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

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

public void setAccessibleDescription(String s)

Set the accessible description of this object.

Parameters:

s - the new localized description of the object

See Also:

getAccessibleDescription

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

public AccessibleRole getAccessibleRole()

Get the role of this object.

Returns:

an instance of AccessibleRole describing the role of the object

See Also:

AccessibleRole

public Number getAccessibleValue()

Get the value of this object as a Number.

Returns:

value of the object -- can be null if this object does not have a value

public boolean setAccessibleValue(Number n)

Set the value of this object as a Number.

Returns:

True if the value was set.

public Number getMinimumAccessibleValue()

Get the minimum value of this object as a Number.

Returns:

Minimum value of the object; null if this object does not have a minimum value

public Number getMaximumAccessibleValue()

Get the maximum value of this object as a Number.

Returns:

Maximum value of the object; null if this object does not have a maximum value

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

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.

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

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

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

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.

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

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.

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

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

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

public void clearAccessibleSelection()

Clears the selection in the object, so that nothing in the object is selected.

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