oracle.jdeveloper.dialogs

Class BrowseHandler

java.lang.Object

oracle.jdeveloper.dialogs.BrowseHandler

public final class BrowseHandler
extends java.lang.Object

The BrowseHandler is responsible for displaying a popup list for the text field, or displaying the results in the supplied list box.

This class is a nearly intact copy of oracle.jdevimpl.java.browse.BrowsePopupList

Method Summary

Modifier and Type	Method and Description
static BrowseHandler	createClassBrowserList(JavaManager javaManager, javax.swing.JTextField textField, javax.swing.JList list) Creates a BrowseHandler that finds matching classes based on the search text in the supplied text field.
static BrowseHandler	createClassBrowserList(JavaManager javaManager, javax.swing.JTextField textField, javax.swing.JList list, ClassNameFilter classFilter) Creates a BrowseHandler that finds matching classes based on the search text in the supplied text field.
static BrowseHandler	createClassBrowserPopup(JavaManager javaManager, javax.swing.JTextField textField, java.awt.event.ActionListener actionListener) Constructs a new BrowseHandler for classes only which displays a popup list attached to the supplied text field.
static BrowseHandler	createClassPackageBrowserList(JavaManager javaManager, javax.swing.JTextField textField, javax.swing.JList list) Creates a BrowseHandler that finds matching classes and packages based on the search text in the supplied text field.
static BrowseHandler	createClassPackageBrowserList(JavaManager javaManager, javax.swing.JTextField textField, javax.swing.JList list, ClassNameFilter classFilter, PackageNameFilter packageFilter) Creates a BrowseHandler that finds matching classes and packages based on the search text in the supplied text field.
static BrowseHandler	createClassPackageBrowserPopup(JavaManager javaManager, javax.swing.JTextField textField, java.awt.event.ActionListener actionListener) Constructs a new BrowseHandler for classes and packages which displays a popup list attached to the supplied text field.
static BrowseHandler	createPackageBrowserList(JavaManager javaManager, javax.swing.JTextField textField, javax.swing.JList list) Creates a BrowseHandler that finds matching packages based on the search text in the supplied text field.
static BrowseHandler	createPackageBrowserList(JavaManager javaManager, javax.swing.JTextField textField, javax.swing.JList list, PackageNameFilter packageFilter) Creates a BrowseHandler that finds matching packages based on the search text in the supplied text field.
static BrowseHandler	createPackageBrowserPopup(JavaManager javaManager, javax.swing.JTextField textField, java.awt.event.ActionListener actionListener) Constructs a new BrowseHandler for packages only that displays a popup list attached to the supplied text field.
void	dispose() Utility routine to detach from the text field and clean up.
java.lang.String	getSelectedItem() Fetch the current selected item in the popup list.
boolean	isCopyQualifiedClassNameToField()
boolean	isPopupVisible()
void	setCopyQualifiedClassNameToField(boolean copyQualifiedClassNameToField)

Methods inherited from class java.lang.Object

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

Method Detail

createClassBrowserPopup

public static BrowseHandler createClassBrowserPopup(JavaManager javaManager,
                                                    javax.swing.JTextField textField,
                                                    java.awt.event.ActionListener actionListener)

Constructs a new BrowseHandler for classes only which displays a popup list attached to the supplied text field.

Parameters:

javaManager - the JavaManager to use

textField - the text field the popup list is associated with

actionListener - the dialog to dismiss (if any) when the user double-clicks in the list

Returns:

a new class BrowseHandler

createPackageBrowserPopup

public static BrowseHandler createPackageBrowserPopup(JavaManager javaManager,
                                                      javax.swing.JTextField textField,
                                                      java.awt.event.ActionListener actionListener)

Constructs a new BrowseHandler for packages only that displays a popup list attached to the supplied text field.

Parameters:

javaManager - the JavaManager to use

textField - the text field the popup list is associated with

actionListener - the dialog to dismiss (if any) when the user double-clicks in the list

Returns:

a new package BrowseHandler

createClassPackageBrowserPopup

public static BrowseHandler createClassPackageBrowserPopup(JavaManager javaManager,
                                                           javax.swing.JTextField textField,
                                                           java.awt.event.ActionListener actionListener)

Constructs a new BrowseHandler for classes and packages which displays a popup list attached to the supplied text field.

Parameters:

javaManager - the JavaManager to use

textField - the text field the popup list is associated with

actionListener - the dialog to dismiss (if any) when the user double-clicks in the list

Returns:

a new class and package BrowseHandler

createClassBrowserList

public static BrowseHandler createClassBrowserList(JavaManager javaManager,
                                                   javax.swing.JTextField textField,
                                                   javax.swing.JList list)

Creates a BrowseHandler that finds matching classes based on the search text in the supplied text field. Results are shown in the supplied list.

Parameters:

javaManager - the JavaManager to use

textField - the text field the popup list is associated with

list - the list where the results are displayed

Returns:

a new class BrowseHandler

createClassBrowserList

public static BrowseHandler createClassBrowserList(JavaManager javaManager,
                                                   javax.swing.JTextField textField,
                                                   javax.swing.JList list,
                                                   ClassNameFilter classFilter)

Creates a BrowseHandler that finds matching classes based on the search text in the supplied text field. Results are shown in the supplied list.

Parameters:

javaManager - the JavaManager to use

textField - the text field the popup list is associated with

list - the list where the results are displayed

classFilter - the ClassNameFilter to use for filtering classes, or null to use the default filter, ClassPackageNamePrefixFilter

Returns:

a new class BrowseHandler

See Also:

ClassNameFilter, ClassPackageNamePrefixFilter

createPackageBrowserList

public static BrowseHandler createPackageBrowserList(JavaManager javaManager,
                                                     javax.swing.JTextField textField,
                                                     javax.swing.JList list)

Creates a BrowseHandler that finds matching packages based on the search text in the supplied text field. Results are shown in the supplied list.

Parameters:

javaManager - the JavaManager to use

textField - the text field the popup list is associated with

list - the list where the results are displayed

Returns:

a new package BrowseHandler

createPackageBrowserList

public static BrowseHandler createPackageBrowserList(JavaManager javaManager,
                                                     javax.swing.JTextField textField,
                                                     javax.swing.JList list,
                                                     PackageNameFilter packageFilter)

Creates a BrowseHandler that finds matching packages based on the search text in the supplied text field. Results are shown in the supplied list.

Parameters:

javaManager - the JavaManager to use

textField - the text field the popup list is associated with

list - the list where the results are displayed

packageFilter - the PackageNameFilter to use for filtering packages, or null to use the default filter, ClassPackageNamePrefixFilter

Returns:

a new package BrowseHandler

See Also:

ClassPackageNamePrefixFilter, PackageNameFilter

createClassPackageBrowserList

public static BrowseHandler createClassPackageBrowserList(JavaManager javaManager,
                                                          javax.swing.JTextField textField,
                                                          javax.swing.JList list)

Creates a BrowseHandler that finds matching classes and packages based on the search text in the supplied text field. Results are shown in the supplied list.

Parameters:

javaManager - the JavaManager to use

textField - the text field the popup list is associated with

list - the list where the results are displayed

Returns:

a new class and package BrowseHandler

createClassPackageBrowserList

public static BrowseHandler createClassPackageBrowserList(JavaManager javaManager,
                                                          javax.swing.JTextField textField,
                                                          javax.swing.JList list,
                                                          ClassNameFilter classFilter,
                                                          PackageNameFilter packageFilter)

Creates a BrowseHandler that finds matching classes and packages based on the search text in the supplied text field. Results are shown in the supplied list.

Parameters:

javaManager - the JavaManager to use

textField - the text field the popup list is associated with

list - the list where the results are displayed

classFilter - the ClassNameFilter to use for filtering classes, or null to use the default filter

packageFilter - the PackageNameFilter to use for filtering packages, or null to use the default filter, ClassPackageNamePrefixFilter

Returns:

a new class and package BrowseHandler

See Also:

ClassNameFilter, ClassPackageNamePrefixFilter, PackageNameFilter

dispose

public void dispose()

Utility routine to detach from the text field and clean up. Just to make sure that we are disposed of properly.

getSelectedItem

public java.lang.String getSelectedItem()

Fetch the current selected item in the popup list. This is what will be used for the actual browse operation.

Returns:

the item selected in the popup list

isPopupVisible

public boolean isPopupVisible()

Returns:

true if the popup is currently visible.

isCopyQualifiedClassNameToField

public boolean isCopyQualifiedClassNameToField()

setCopyQualifiedClassNameToField

public void setCopyQualifiedClassNameToField(boolean copyQualifiedClassNameToField)