oracle.jdeveloper.dialogs

Class BrowseHandler2

java.lang.Object

oracle.jdeveloper.dialogs.BrowseHandler2

public class BrowseHandler2
extends java.lang.Object

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

This class is based on oracle.jdeveloper.dialogs.BrowseHandler but it does not change the contents of the passed in text field during its operation, and does not work with a JList.

See Also:

BrowseHandler

Method Summary

Methods

Modifier and Type	Method and Description
static BrowseHandler2	createClassBrowserList(JavaManager javaManager, javax.swing.JTextField textField) Creates a BrowseHandler2 that finds matching classes based on the search text in the supplied text field.
static BrowseHandler2	createClassBrowserList(JavaManager javaManager, javax.swing.JTextField textField, ClassNameFilter classFilter) Creates a BrowseHandler2 that finds matching classes based on the search text in the supplied text field.
static BrowseHandler2	createClassBrowserPopup(JavaManager javaManager, javax.swing.JTextField textField, java.awt.event.ActionListener actionListener) Constructs a new BrowseHandler2 for classes only which displays a popup list attached to the supplied text field.
static BrowseHandler2	createClassPackageBrowserList(JavaManager javaManager, javax.swing.JTextField textField) Creates a BrowseHandler2 that finds matching classes and packages based on the search text in the supplied text field.
static BrowseHandler2	createClassPackageBrowserList(JavaManager javaManager, javax.swing.JTextField textField, ClassNameFilter classFilter, PackageNameFilter packageFilter) Creates a BrowseHandler2 that finds matching classes and packages based on the search text in the supplied text field.
static BrowseHandler2	createClassPackageBrowserPopup(JavaManager javaManager, javax.swing.JTextField textField, java.awt.event.ActionListener actionListener) Constructs a new BrowseHandler2 for classes and packages which displays a popup list attached to the supplied text field.
static BrowseHandler2	createPackageBrowserList(JavaManager javaManager, javax.swing.JTextField textField) Creates a BrowseHandler2 that finds matching packages based on the search text in the supplied text field.
static BrowseHandler2	createPackageBrowserList(JavaManager javaManager, javax.swing.JTextField textField, PackageNameFilter packageFilter) Creates a BrowseHandler2 that finds matching packages based on the search text in the supplied text field.
static BrowseHandler2	createPackageBrowserPopup(JavaManager javaManager, javax.swing.JTextField textField, java.awt.event.ActionListener actionListener) Constructs a new BrowseHandler2 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	isShowPopupOnFocus() If true the popup will be attempted to be displayed when the text field gains focus.
void	setCopyQualifiedClassNameToField(boolean copyQualifiedClassNameToField)
void	setShowPopupOnFocus(boolean showPopupOnFocus) If true the popup will be attempted to be displayed when the text field gains focus.

Methods inherited from class java.lang.Object

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

Method Detail

createClassBrowserPopup

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

Constructs a new BrowseHandler2 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 BrowseHandler2

createPackageBrowserPopup

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

Constructs a new BrowseHandler2 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 BrowseHandler2

createClassPackageBrowserPopup

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

Constructs a new BrowseHandler2 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 BrowseHandler2

createClassBrowserList

public static BrowseHandler2 createClassBrowserList(JavaManager javaManager,
                                    javax.swing.JTextField textField)

Creates a BrowseHandler2 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

Returns:

a new class BrowseHandler2

createClassBrowserList

public static BrowseHandler2 createClassBrowserList(JavaManager javaManager,
                                    javax.swing.JTextField textField,
                                    ClassNameFilter classFilter)

Creates a BrowseHandler2 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

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

Returns:

a new class BrowseHandler2

See Also:

ClassNameFilter, ClassPackageNamePrefixFilter

createPackageBrowserList

public static BrowseHandler2 createPackageBrowserList(JavaManager javaManager,
                                      javax.swing.JTextField textField)

Creates a BrowseHandler2 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

Returns:

a new package BrowseHandler2

createPackageBrowserList

public static BrowseHandler2 createPackageBrowserList(JavaManager javaManager,
                                      javax.swing.JTextField textField,
                                      PackageNameFilter packageFilter)

Creates a BrowseHandler2 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

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

Returns:

a new package BrowseHandler2

See Also:

ClassPackageNamePrefixFilter, PackageNameFilter

createClassPackageBrowserList

public static BrowseHandler2 createClassPackageBrowserList(JavaManager javaManager,
                                           javax.swing.JTextField textField)

Creates a BrowseHandler2 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

Returns:

a new class and package BrowseHandler2

createClassPackageBrowserList

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

Creates a BrowseHandler2 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

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 BrowseHandler2

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

isCopyQualifiedClassNameToField

public boolean isCopyQualifiedClassNameToField()

setCopyQualifiedClassNameToField

public void setCopyQualifiedClassNameToField(boolean copyQualifiedClassNameToField)

setShowPopupOnFocus

public void setShowPopupOnFocus(boolean showPopupOnFocus)

If true the popup will be attempted to be displayed when the text field gains focus.

Parameters:

showPopupOnFocus -

isShowPopupOnFocus

public boolean isShowPopupOnFocus()

If true the popup will be attempted to be displayed when the text field gains focus.