oracle.ide.panels
Class TDialogLauncher

java.lang.Object
  oracle.ide.panels.TDialogLauncher

All Implemented Interfaces:

ApplyNotifier

public class TDialogLauncher

extends java.lang.Object

implements ApplyNotifier

This classes launches a dialog whose content area is a single Traversable, thus the "T" prefix.

Constructor Summary

TDialogLauncher(java.awt.Component parent, java.lang.String title, Traversable traversable, Namespace data)

TDialogLauncher(java.awt.Component parent, java.lang.String title, Traversable traversable, Namespace data, DialogRunnerCallback dialogCallback)

TDialogLauncher(java.awt.Component parent, java.lang.String title, Traversable traversable, Namespace data, DialogRunnerCallback dialogCallback, Document[] sources)
The traversable's onEntry(...) method is called as a side effect of constructing the TDialogLauncher.

Method Summary

void	addApplyListener(ApplyListener applyListener) Adds an ApplyListener that will be called when the user applies or cancels changes.
void	dispose()
protected void	fireApply() Fires the "apply" message to all registered ApplyListener objects.
protected void	fireCancel() Fires the "cancel" message to all registered ApplyListener objects.
java.awt.Dimension	getDefaultInitialSize()
java.awt.Dimension	getInitialSize()
java.awt.Component	getParent()
static java.awt.Dimension	getPreferredDefaultInitialSize()
java.lang.String	getTitle()
protected TraversableContext	getTraversableContext()
oracle.bali.ewt.dialog.JEWTDialog	initDialog() Initializes the JEWTDialog that the TDialogLauncher will use to host the Traversable.
protected TDialog	newDialog()
void	removeApplyListener(ApplyListener applyListener) Removes a previously added ApplyListener so that it no longer receives notification when the user applies or cancels changes.
void	setInitialSize(java.awt.Dimension initialSize)
void	setInitialSize(int x, int y)
void	setPackDialog(boolean pack)
static void	setPreferredDefaultInitialSize(java.awt.Dimension defaultSize)
boolean	showDialog() Shows dialog with OK, Cancel, and Help buttons.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TDialogLauncher

public TDialogLauncher(java.awt.Component parent,
                       java.lang.String title,
                       Traversable traversable,
                       Namespace data,
                       DialogRunnerCallback dialogCallback,
                       Document[] sources)

The traversable's onEntry(...) method is called as a side effect of constructing the TDialogLauncher. If a 'sources' param value is provided and any source documents are write-protected, the user is notified through a separate message dialog that no changes will be applied from this dialog session, and the OK button is disabled.

Parameters:

sources - an optional Document array of source files that may be modified through the traversable.

Throws:

java.lang.IllegalArgumentException - if the traversable is null.

TDialogLauncher

public TDialogLauncher(java.awt.Component parent,
                       java.lang.String title,
                       Traversable traversable,
                       Namespace data,
                       DialogRunnerCallback dialogCallback)

TDialogLauncher

public TDialogLauncher(java.awt.Component parent,
                       java.lang.String title,
                       Traversable traversable,
                       Namespace data)

Method Detail

addApplyListener

public void addApplyListener(ApplyListener applyListener)

Description copied from interface: ApplyNotifier

Adds an ApplyListener that will be called when the user applies or cancels changes.

Specified by:

addApplyListener in interface ApplyNotifier

removeApplyListener

public void removeApplyListener(ApplyListener applyListener)

Description copied from interface: ApplyNotifier

Removes a previously added ApplyListener so that it no longer receives notification when the user applies or cancels changes.

Specified by:

removeApplyListener in interface ApplyNotifier

getParent

public java.awt.Component getParent()

getTitle

public java.lang.String getTitle()

getInitialSize

public java.awt.Dimension getInitialSize()

setInitialSize

public void setInitialSize(java.awt.Dimension initialSize)

setInitialSize

public void setInitialSize(int x,
                           int y)

setPackDialog

public void setPackDialog(boolean pack)

getDefaultInitialSize

public java.awt.Dimension getDefaultInitialSize()

getPreferredDefaultInitialSize

public static java.awt.Dimension getPreferredDefaultInitialSize()

setPreferredDefaultInitialSize

public static void setPreferredDefaultInitialSize(java.awt.Dimension defaultSize)

initDialog

public oracle.bali.ewt.dialog.JEWTDialog initDialog()

Initializes the JEWTDialog that the TDialogLauncher will use to host the Traversable.

showDialog

public boolean showDialog()

Shows dialog with OK, Cancel, and Help buttons. The specified Namespace must not be null, or else an IllegalArgumentException is thrown.

Returns:

true if OK was selected; false if Cancel was selected or if the specified Traversable is null.

Throws:

java.lang.IllegalArgumentException - if the specified Namespace is null.

dispose

public void dispose()

getTraversableContext

protected TraversableContext getTraversableContext()

newDialog

protected TDialog newDialog()

fireApply

protected void fireApply()

Fires the "apply" message to all registered ApplyListener objects.

fireCancel

protected void fireCancel()

Fires the "cancel" message to all registered ApplyListener objects.