oracle.ide.dialogs

Class DialogUtil

java.lang.Object

oracle.ide.dialogs.DialogUtil

public abstract class DialogUtil
extends java.lang.Object

A factory class for dialogs.

Constructor Summary

Constructors

Constructor and Description
DialogUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addShortcutButtons(URLChooser uc, Context context) Adds shortcut buttons on the left side of the URLChooser based on the specified Context.
static void	addURLChooserShortcutProvider(URLChooserShortcutProvider provider) Installs a provider which may dynamically install shortcuts into the URL chooser when the addShortcutButtons(URLChooser,Context) method is called.
static void	addURLFilter(URLFilter filter) Adds a new URLFilter that will be included automatically in URLChooser instances created by newURLChooser(Context).
static oracle.bali.ewt.dialog.JEWTDialog	createJEWTDialogOwnedBy(java.awt.Component parent) Given a Component find its nearest hosting Dialog or Frame if any, which may be itself, creating a new JEWTDialog with that owner.
static java.awt.Dialog	getAncestorDialog(java.awt.Component parent)
static java.awt.Frame	getAncestorFrame(java.awt.Component parent)
static URLChooserInit	getURLChooserInit(Context context) Returns a URLChooser initializer.
static void	initURLChooser(URLChooser urlChooser, Context context) Initializes the specified URLChooser according to the current Context.
static URLChooser	newURLChooser() Creates a new URLChooser that is initialized using a default Context.
static URLChooser	newURLChooser(Context context) Creates a new URLChooser that is initialized according to the specified Context.
static URLChooser	newURLChooser(Context context, java.net.URL initialURL) Creates a new URLChooser that is initialized according to the specified Context with the specified URL as the initial selection.
static URLChooser	newURLChooser(java.net.URL initialURL) Creates a new URLChooser that is initialized with the specified URL as the initial selection.
static void	registerShortcutButton(javax.swing.Icon icon, java.lang.String label, java.net.URL url) Deprecated. since 11.1.1.0.1 - use #addURLChooserShortcutProvider(URLChooserShortuctProvider).
static void	removeURLChooserShortcutProvider(URLChooserShortcutProvider provider) Uninstalls a provider of shorcuts in the URL chooser.
static void	replaceURLChooserShortcutProviderOfSameClass(URLChooserShortcutProvider provider) Specialized use case for macro expansion.
static void	setDefaultFilter(URLFilter filter) Deprecated. since 11.1.1 this method doesn't do anything
static void	setProjectFilter(URLFilter filter) Deprecated. since 11.1.1 this method doesn't do anything
static void	setWorkspaceFilter(URLFilter filter) Deprecated. since 11.1.1 this method doesn't do anything
static void	unregisterShortcutButton(javax.swing.Icon icon, java.lang.String label, java.net.URL url) Deprecated. snice 11.1.1.0.1 - use removeURLChooserShortcutProvider(URLChooserShortcutProvider).

Methods inherited from class java.lang.Object

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

Constructor Detail

DialogUtil

public DialogUtil()

Method Detail

newURLChooser

public static URLChooser newURLChooser()

Creates a new URLChooser that is initialized using a default Context.

newURLChooser

public static URLChooser newURLChooser(Context context)

Creates a new URLChooser that is initialized according to the specified Context.

Parameters:

context - The Context with which to initialize the URLChooser, or null to initialize with default values.

newURLChooser

public static URLChooser newURLChooser(java.net.URL initialURL)

Creates a new URLChooser that is initialized with the specified URL as the initial selection.

Parameters:

initialURL - The URL of the initial selection, or null to initialize with the default selection.

newURLChooser

public static URLChooser newURLChooser(Context context,
                       java.net.URL initialURL)

Creates a new URLChooser that is initialized according to the specified Context with the specified URL as the initial selection.

Parameters:

context - The Context with which to initialize the URLChooser, or null to initialize with default values.

initialURL - The URL of the initial selection, or null to initialize with the default selection.

initURLChooser

public static void initURLChooser(URLChooser urlChooser,
                  Context context)

Initializes the specified URLChooser according to the current Context.

Parameters:

urlChooser - The URLChooser to initialize, which may not be null.

context - The Context with which to initialize the URLChooser, or null to initialize with default values.

addURLChooserShortcutProvider

public static void addURLChooserShortcutProvider(URLChooserShortcutProvider provider)

Installs a provider which may dynamically install shortcuts into the URL chooser when the addShortcutButtons(URLChooser,Context) method is called.

This method may be safely called from any thread.

Parameters:

provider - a provider to add.

Throws:

java.lang.NullPointerException - if provider is null

Since:

11.1.1.0.1

replaceURLChooserShortcutProviderOfSameClass

public static void replaceURLChooserShortcutProviderOfSameClass(URLChooserShortcutProvider provider)

Specialized use case for macro expansion. We only want one macro-expansion shortcut provider to be active, so we remove any current provider of the same class with the new one. It is not an error if no match is found, in that case this simpl adds the new provider.

removeURLChooserShortcutProvider

public static void removeURLChooserShortcutProvider(URLChooserShortcutProvider provider)

Uninstalls a provider of shorcuts in the URL chooser.

This method may be safely called from any thread. It will, however, not affect any currently visible instance of the URLChooser.

Parameters:

provider - a provider to uninstall.

Since:

11.1.1.0.1

addShortcutButtons

public static void addShortcutButtons(URLChooser uc,
                      Context context)

Adds shortcut buttons on the left side of the URLChooser based on the specified Context.

getURLChooserInit

public static URLChooserInit getURLChooserInit(Context context)

Returns a URLChooser initializer. This method is used to make compile-time dependencies more loosely coupled.

registerShortcutButton

public static void registerShortcutButton(javax.swing.Icon icon,
                          java.lang.String label,
                          java.net.URL url)

Deprecated. since 11.1.1.0.1 - use #addURLChooserShortcutProvider(URLChooserShortuctProvider).

Registers a shortcut button to the dialogs which are created via initURLChooser

Parameters:

icon - shortcut button icon

label - shortcut button label

url - directory root url, that is activated by the shortcut button

unregisterShortcutButton

public static void unregisterShortcutButton(javax.swing.Icon icon,
                            java.lang.String label,
                            java.net.URL url)

Deprecated. snice 11.1.1.0.1 - use removeURLChooserShortcutProvider(URLChooserShortcutProvider).

UnRegisters a short cut button

Parameters:

icon - shortcut button icon

label - shortcut button label

url - directory root url, that is activated by the shortcut button

addURLFilter

public static void addURLFilter(URLFilter filter)

Adds a new URLFilter that will be included automatically in URLChooser instances created by newURLChooser(Context).

setWorkspaceFilter

public static void setWorkspaceFilter(URLFilter filter)

Deprecated. since 11.1.1 this method doesn't do anything

Sets the filter that is to be used when the current Context is the "Workspaces" node.

setProjectFilter

public static void setProjectFilter(URLFilter filter)

Deprecated. since 11.1.1 this method doesn't do anything

Sets the filter that is to be used when the current Context is a Workspace node.

setDefaultFilter

public static void setDefaultFilter(URLFilter filter)

Deprecated. since 11.1.1 this method doesn't do anything

Sets the filter that is to be used by default.

getAncestorDialog

public static java.awt.Dialog getAncestorDialog(java.awt.Component parent)

getAncestorFrame

public static java.awt.Frame getAncestorFrame(java.awt.Component parent)

createJEWTDialogOwnedBy

public static oracle.bali.ewt.dialog.JEWTDialog createJEWTDialogOwnedBy(java.awt.Component parent)

Given a Component find its nearest hosting Dialog or Frame if any, which may be itself, creating a new JEWTDialog with that owner. If no such owner is found, the dialog will be hosted by the IDE main window.

Parameters:

parent - component that should be the owner of the dialog

Returns:

a new JEWTDialog hosted by the nearest Dialog or Frame ancestor of the given Component, or hosted by the IDE main window.