All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.symantec.itools.vcafe.openapi.pluginapi.JPluginDialog

Object
   |
   +----Component
           |
           +----Container
                   |
                   +----Window
                           |
                           +----Frame
                                   |
                                   +----EmbeddedFrame
                                           |
                                           +----WEmbeddedFrame
                                                   |
                                                   +----BasePluginWindow
                                                           |
                                                           +----BasePluginDialog
                                                                   |
                                                                   +----PluginDialog
                                                                           |
                                                                           +----com.symantec.itools.vcafe.openapi.pluginapi.JPluginDialog

public class JPluginDialog

extends PluginDialog

implements WindowConstants, RootPaneContainer

Version:

1.0

Author:

Symantec Internet Tools Division

Since:

VCafe 3.0

rootPane

rootPaneCheckingEnabled

com.symantec.itools.vcafe.openapi.pluginapi.JPluginDialog()

Create a modal/modeless dialog

com.symantec.itools.vcafe.openapi.pluginapi.JPluginDialog(String)

Create a modeless dialog with the given title

com.symantec.itools.vcafe.openapi.pluginapi.JPluginDialog(String, boolean)

Create a modal/modeless dialog with the given title

com.symantec.itools.vcafe.openapi.pluginapi.JPluginDialog(Window, String, boolean)

Create a modal/modeless dialog with the given title and parent

addImpl(Component, Object, int)

By default, children may not be added directly to a this component, they must be added to its contentPane instead.

createRootPane()

Called by the constructor methods to create the default rootPane.

dialogInit()

Called by the constructors to init the JPluginDialog properly.

getContentPane()

Returns the contentPane object for this dialog.

getDefaultCloseOperation()

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

getGlassPane()

Returns the glassPane object for this dialog.

getLayeredPane()

Returns the layeredPane object for this dialog.

getRootPane()

Returns the rootPane object for this dialog.

isRootPaneCheckingEnabled()

processWindowEvent(WindowEvent)

Handles window events depending on the state of the defaultCloseOperation property.

setContentPane(Container)

Sets the contentPane property.

setDefaultCloseOperation(int)

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

setGlassPane(Component)

Sets the glassPane property.

setLayeredPane(JLayeredPane)

Sets the layeredPane property.

setLayout(LayoutManager)

By default the layout of this component may not be set, the layout of its contentPane should be set instead.

setRootPane(JRootPane)

Sets the rootPane property.

setRootPaneCheckingEnabled(boolean)

If true then calls to add() and setLayout() will cause an exception to be thrown.

protected com.sun.java.swing.JRootPane rootPane

See Also:

getRootPane, setRootPane

protected boolean rootPaneCheckingEnabled

See Also:

isRootPaneCheckingEnabled, setRootPaneCheckingEnabled

public JPluginDialog()

Create a modal/modeless dialog

Parameters:

modal - true for modal and false for modeless dialog box

public JPluginDialog(String title)

Create a modeless dialog with the given title

Parameters:

title - The title on the frame

public JPluginDialog(String title,
                     boolean modal)

Create a modal/modeless dialog with the given title

Parameters:

modal - true for modal and false for modeless dialog box

title - The title on the frame

public JPluginDialog(Window parent,
                     String title,
                     boolean modal)

Create a modal/modeless dialog with the given title and parent

Parameters:

parent - the owner of the dialog

modal - true for modal and false for modeless dialog box

title - The title on the frame

protected void addImpl(Component comp,
                       Object constraints,
                       int index)

By default, children may not be added directly to a this component, they must be added to its contentPane instead. For example:

 thisComponent.getContentPane().add(child)
 

An attempt to add to directly to this component will cause an runtime exception to be thrown. Subclasses can disable this behavior.

Throws: Error

if called with rootPaneChecking true

Overrides:

addImpl in class Container

See Also:

setRootPaneCheckingEnabled

protected com.sun.java.swing.JRootPane createRootPane()

Called by the constructor methods to create the default rootPane.

protected void dialogInit()

Called by the constructors to init the JPluginDialog properly.

public java.awt.Container getContentPane()

Returns the contentPane object for this dialog.

See Also:

setContentPane, getContentPane

public int getDefaultCloseOperation()

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

Returns:

an int indicating the window-close operation

See Also:

setDefaultCloseOperation

public java.awt.Component getGlassPane()

Returns the glassPane object for this dialog.

See Also:

setGlassPane, getGlassPane

public com.sun.java.swing.JLayeredPane getLayeredPane()

Returns the layeredPane object for this dialog.

See Also:

setLayeredPane, getLayeredPane

public com.sun.java.swing.JRootPane getRootPane()

Returns the rootPane object for this dialog.

See Also:

setRootPane, getRootPane

protected boolean isRootPaneCheckingEnabled()

Returns:

true if add and setLayout should be checked

See Also:

addImpl, setLayout, setRootPaneCheckingEnabled

protected void processWindowEvent(WindowEvent e)

Handles window events depending on the state of the defaultCloseOperation property.

Overrides:

processWindowEvent in class Window

See Also:

setDefaultCloseOperation

public void setContentPane(Container contentPane)

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

Parameters:

contentPane - the contentPane object for this dialog

Throws: IllegalComponentStateException

(a runtime exception) if the content pane parameter is null

See Also:

getContentPane, setContentPane

public void setDefaultCloseOperation(int operation)

Sets the operation which will happen by default when the user initiates a "close" on this dialog. 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 dialog after invoking any registered WindowListener objects
• DISPOSE_ON_CLOSE - automatically hide and dispose the dialog after invoking any registered WindowListener objects

The value is set to HIDE_ON_CLOSE by default.

See Also:

addWindowListener, getDefaultCloseOperation

public void setGlassPane(Component glassPane)

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

Parameters:

glassPane - the glassPane object for this dialog

See Also:

getGlassPane, setGlassPane

public void setLayeredPane(JLayeredPane layeredPane)

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

Parameters:

layeredPane - the layeredPane object for this dialog

Throws: IllegalComponentStateException

(a runtime exception) if the layered pane parameter is null

See Also:

getLayeredPane, setLayeredPane

public void setLayout(LayoutManager manager)

By default the layout of this component may not be set, the layout of its contentPane should be set instead. For example:

 thisComponent.getContentPane().setLayout(new BorderLayout())
 

An attempt to set the layout of this component will cause an runtime exception to be thrown. Subclasses can disable this behavior.

Throws: Error

if called with rootPaneChecking true

Overrides:

setLayout in class Container

See Also:

setRootPaneCheckingEnabled

protected void setRootPane(JRootPane root)

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

Parameters:

root - the rootPane object for this dialog

See Also:

getRootPane

protected void setRootPaneCheckingEnabled(boolean enabled)

If true then calls to add() and setLayout() will cause an exception to be thrown.

See Also:

addImpl, setLayout, isRootPaneCheckingEnabled

All Packages  Class Hierarchy  This Package  Previous  Next  Index