oracle.jdeveloper.dialogs

Interface ClassPackageView

All Known Implementing Classes:

ClassPackageSearchPanel, ClassPackageTreePanel

public interface ClassPackageView

This class should have package-private access. It is not intended for external use.

Method Summary

Modifier and Type	Method and Description
void	activateView() Called to indicate that the view is active.
void	dispose() Dispose of this view.
java.awt.Component	getComponent() Gets the default component.
java.lang.String[]	getSelectedItems() Gets the one or more selected class or package names.
java.lang.String	getSelection() A valid class or package name.
java.lang.String	getTitle() Gets the title for this view.
void	setClassAndPackageNameFilters(ClassNameFilter classNameFilter, PackageNameFilter pkgNameFilter) Supplies the class with the data needed to filter classes and packages.
void	setFilter(ClassPackageBrowserFilterV2 filterV2) Supplies the view with a ClassPackageBrowserFilterV2 which is used to check each package and class before adding it to the browser.
void	setJavaManager(JavaManager javaManager) Sets the JavaManager for the view.
void	setMode(int classPackageMode) Indicates whether the view shows classes, packages, or both.
void	setMultiSelect(boolean multiSelect) Determines whether multiple selections are allowed.
void	setSelectedItems(java.lang.String[] defaultSelection) Initializes the selection in the dialog tabs.
void	setSelection(java.lang.String defaultSelection) Initializes the dialog state.

Method Detail

activateView

void activateView()

Called to indicate that the view is active.

getTitle

java.lang.String getTitle()

Gets the title for this view.

Returns:

the title text

getComponent

java.awt.Component getComponent()

Gets the default component. This is the component that should have initial focus in the panel.

Returns:

the default component

setSelection

void setSelection(java.lang.String defaultSelection)

Initializes the dialog state. The effect of this method on the search panel, is to set the the default search text. On the hierarchy panel, the node corresponding to defaultSelection is selected unless it is not avaialble in the tree.

Note: This method is only intended to initialize the dialog state. It is not a complement to getSelection() which is not guaranteed to return the supplied initial selection. The getSelection() method returns the resolved value, or null if the resolution has not completed or the search criteria resulted in no matching items.

Parameters:

defaultSelection - the initial search text

setSelectedItems

void setSelectedItems(java.lang.String[] defaultSelection)

Initializes the selection in the dialog tabs. The effect of this method on the search panel, is to set the the default search text to the first item in the supplied array. On the class hierarchy panel, each node corresponding to an entry in the defaultSelection array is selected in the tree unless the node is not found in the tree.

Note: This method is only intended to initialize the dialog state. It is not a complement to getSelectedItems(), which is not guaranteed to return the supplied initial selection. This method returns the resolved value, or an empty array if the resolution has not completed or the search criteria resulted in no matching items.

Parameters:

defaultSelection - an array of class and/or package names

getSelection

java.lang.String getSelection()

A valid class or package name.

Returns:

gets the fully-qualified class name

getSelectedItems

java.lang.String[] getSelectedItems()

Gets the one or more selected class or package names.

Returns:

an array of class and/or package names

setJavaManager

void setJavaManager(JavaManager javaManager)

Sets the JavaManager for the view.

Parameters:

javaManager - a JavaManager

See Also:

JavaManager

setClassAndPackageNameFilters

void setClassAndPackageNameFilters(ClassNameFilter classNameFilter,
                                   PackageNameFilter pkgNameFilter)

Supplies the class with the data needed to filter classes and packages.

Parameters:

classNameFilter - a filter for class names

pkgNameFilter - the filter for package names

See Also:

ClassNameFilter, PackageNameFilter

setFilter

void setFilter(ClassPackageBrowserFilterV2 filterV2)

Supplies the view with a ClassPackageBrowserFilterV2 which is used to check each package and class before adding it to the browser.

Parameters:

filterV2 -

See Also:

ClassPackageBrowserFilterV2

setMultiSelect

void setMultiSelect(boolean multiSelect)

Determines whether multiple selections are allowed.

Parameters:

multiSelect - when true, multiple selection is allowed, otherwise it's not

setMode

void setMode(int classPackageMode)

Indicates whether the view shows classes, packages, or both.

Parameters:

classPackageMode - the ClassPackageBrowserV2 mode, class, package or classes and packages

See Also:

ClassPackageBrowserV2.PACKAGE_ONLY, ClassPackageBrowserV2.CLASS_ONLY, ClassPackageBrowserV2.CLASS_AND_PACKAGE

dispose

void dispose()

Dispose of this view. Performs any necessary cleanup.