oracle.jdeveloper.dialogs
Class ClassPackageBrowser

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  oracle.jdeveloper.dialogs.ClassPackageBrowser

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class ClassPackageBrowser

extends javax.swing.JPanel

The ClassPackageBrowser provides a tree-based UI for the selecting of classes and or packages from a Project's classpath and sourcepath.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static int	CLASS_AND_PACKAGE Mode for selecting classes and packages.
static int	CLASS_ONLY Mode for selecting only classes.
static java.lang.String	CLASS_PACKAGE_TITLE
static java.lang.String	CLASS_TITLE
static int	PACKAGE_ONLY Mode for selecting only packages.
static java.lang.String	PACKAGE_TITLE

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

ClassPackageBrowser()
Constructs a new instance.

Method Summary

void	addActionListener(java.awt.event.ActionListener listener)
void	addNotify()
static java.lang.String	browseClassOrPackage(java.awt.Component parent, JProject proj, int mode) Browses for a single class or package.
static java.lang.String[]	browseClassOrPackage(java.awt.Component parent, JProject proj, int mode, boolean isMultiSelect) Browses for one or more classes or packages.
static java.lang.String[]	browseClassOrPackage(java.awt.Component parent, JProject proj, int mode, boolean isMultiSelect, ClassPackageBrowserFilter filter) Browses for one or more classes or packages.
static java.lang.String	browseClassOrPackage(java.awt.Component parent, JProject proj, int mode, ClassPackageBrowserFilter filter) Browses for a single class or package.
static java.lang.String[]	browseClassOrPackage(java.awt.Component parent, JProject proj, int mode, int needs, boolean isMultiSelect, ClassPackageBrowserFilter filter) Browses for one or more classes or packages.
static java.lang.String[]	browseClassOrPackage(java.awt.Component parent, JProject proj, int mode, int needs, boolean isMultiSelect, ClassPackageBrowserFilter filter, java.lang.String[] initialSelection) Browses for one or more classes or packages.
java.lang.String	browseClassOrPackage(JotManager mgr, int mode) Browses for a single class or package.
java.lang.String[]	browseClassOrPackage(JotManager mgr, int mode, boolean isMultiSelect) Browses for one or more class or package.
java.lang.String[]	browseClassOrPackage(JotManager mgr, int mode, boolean isMultiSelect, ClassPackageBrowserFilter filter) Browses for one or more class or package.
java.lang.String	browseClassOrPackage(JotManager mgr, int mode, ClassPackageBrowserFilter filter) Browses for a single class or package.
java.lang.String[]	browseClassOrPackage(JotManager mgr, int mode, int needs, boolean isMultiSelect, ClassPackageBrowserFilter filter) Browses for one or more class or package.
java.lang.String[]	browseClassOrPackage(JotManager mgr, int mode, int needs, boolean isMultiSelect, ClassPackageBrowserFilter filter, java.lang.String[] initialSelection) Browses for one or more class or package.
java.lang.String[]	getSelectedItems() Retrieves the selected packages and/or classes.
java.lang.String	getSelection() Retrieves the single selected package or class (depending on the selection mode).
void	removeActionListener(java.awt.event.ActionListener listener)
void	removeNotify()
void	requestFocus()
void	setFilter(ClassPackageBrowserFilter filter) Sets the filter to use for determining what packages and classes are acceptible.
void	setHostParent(java.awt.Component hostParent) Sets the parent Component from which for this ClassPackageBrowser is launched.
void	setJotManager(JotManager mgr) Sets the JotManager instance to be used by this ClassPackageBrowser.
void	setMode(int mode) Sets the mode for this ClassPackageBrowser.
void	setMultiSelect(boolean isMultiSelect) Specifies whether this ClassPackageBrowser should allow multiple packages and classes to be selected.
void	setNeeds(int needs) Specifies the types of classes or packages required.
void	setSelectedItems(java.lang.String[] sel) Sets the selection in the tree.
void	setTitle(java.lang.String title) Sets the title to use for the dialog.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

PACKAGE_ONLY

public static final int PACKAGE_ONLY

Mode for selecting only packages. Classes will not be shown in the ClassPackageBrowser.

See Also:

Constant Field Values

CLASS_ONLY

public static final int CLASS_ONLY

Mode for selecting only classes. Packages are shown but are not part of the selection.

See Also:

Constant Field Values

CLASS_AND_PACKAGE

public static final int CLASS_AND_PACKAGE

Mode for selecting classes and packages.

See Also:

Constant Field Values

PACKAGE_TITLE

public static final java.lang.String PACKAGE_TITLE

CLASS_TITLE

public static final java.lang.String CLASS_TITLE

CLASS_PACKAGE_TITLE

public static final java.lang.String CLASS_PACKAGE_TITLE

Constructor Detail

ClassPackageBrowser

public ClassPackageBrowser()

Constructs a new instance.

Method Detail

getSelection

public java.lang.String getSelection()

Retrieves the single selected package or class (depending on the selection mode).

Returns:

the user's selection, or null if nothing was selected.

setSelectedItems

public void setSelectedItems(java.lang.String[] sel)

Sets the selection in the tree.

getSelectedItems

public java.lang.String[] getSelectedItems()

Retrieves the selected packages and/or classes. If the mode is set to PACKAGE_ONLY, each entry is a package; if the mode is CLASS_ONLY, each entry is a fully qualified classname; otherwise, the entries are classes and packages.

Returns:

an array of classes and/or packages representing the selection. If nothing was selected, a zero-length array is returned.

setJotManager

public void setJotManager(JotManager mgr)

Sets the JotManager instance to be used by this ClassPackageBrowser.

Parameters:

mgr - the JotManager instance.

setMode

public void setMode(int mode)

Sets the mode for this ClassPackageBrowser.

Parameters:

mode - the mode under which this ClassPackageBrowser should operate.

See Also:

PACKAGE_ONLY, CLASS_ONLY, CLASS_AND_PACKAGE

setNeeds

public void setNeeds(int needs)

Specifies the types of classes or packages required.

See Also:

JotManager

setHostParent

public void setHostParent(java.awt.Component hostParent)

Sets the parent Component from which for this ClassPackageBrowser is launched.

Parameters:

hostParent - the parent from which this ClassPackageBrowser is launched.

setTitle

public void setTitle(java.lang.String title)

Sets the title to use for the dialog.

Parameters:

title - the title to display for the dialog

setFilter

public void setFilter(ClassPackageBrowserFilter filter)

Sets the filter to use for determining what packages and classes are acceptible.

Parameters:

filter - the ClassPackageBrowserFilter to use to filter the displayed classes and packages. Use null to use the default filter.

setMultiSelect

public void setMultiSelect(boolean isMultiSelect)

Specifies whether this ClassPackageBrowser should allow multiple packages and classes to be selected.

Parameters:

isMultiSelect - whether this ClassPackageBrowser supports multi-selection.

browseClassOrPackage

public java.lang.String browseClassOrPackage(JotManager mgr,
                                             int mode)

Browses for a single class or package.

Parameters:

mgr - the JotManager instance to use to located the classes and packages.

mode - the mode to invoke the ClassPackageBrowser in.

Returns:

the selected class or package, or null if nothing was selected.

See Also:

PACKAGE_ONLY, CLASS_ONLY, CLASS_AND_PACKAGE

browseClassOrPackage

public java.lang.String browseClassOrPackage(JotManager mgr,
                                             int mode,
                                             ClassPackageBrowserFilter filter)

Browses for a single class or package.

Parameters:

mgr - the JotManager instance to use to located the classes and packages.

mode - the mode to invoke the ClassPackageBrowser in.

filter - the ClassPackageBrowserFilter to use to filter the displayed packages and classes.

Returns:

the selected class or package, or null if nothing was selected.

See Also:

PACKAGE_ONLY, CLASS_ONLY, CLASS_AND_PACKAGE

browseClassOrPackage

public java.lang.String[] browseClassOrPackage(JotManager mgr,
                                               int mode,
                                               boolean isMultiSelect)

Browses for one or more class or package.

Parameters:

mgr - the JotManager instance to use to located the classes and packages.

mode - the mode to invoke the ClassPackageBrowser in.

isMultiSelect - whether this ClassPackageBrowser supports multi-selection.

Returns:

the selected class or package, or null if nothing was selected.

See Also:

PACKAGE_ONLY, CLASS_ONLY, CLASS_AND_PACKAGE

browseClassOrPackage

public java.lang.String[] browseClassOrPackage(JotManager mgr,
                                               int mode,
                                               boolean isMultiSelect,
                                               ClassPackageBrowserFilter filter)

Browses for one or more class or package.

Parameters:

mgr - the JotManager instance to use to located the classes and packages.

mode - the mode to invoke the ClassPackageBrowser in.

isMultiSelect - whether this ClassPackageBrowser supports multi-selection.

filter - the ClassPackageBrowserFilter to use to filter the displayed packages and classes.

Returns:

the selected class or package, or null if nothing was selected.

See Also:

PACKAGE_ONLY, CLASS_ONLY, CLASS_AND_PACKAGE

browseClassOrPackage

public java.lang.String[] browseClassOrPackage(JotManager mgr,
                                               int mode,
                                               int needs,
                                               boolean isMultiSelect,
                                               ClassPackageBrowserFilter filter)

Browses for one or more class or package.

Parameters:

mgr - the JotManager instance to use to located the classes and packages.

mode - the mode to invoke the ClassPackageBrowser in.

needs - the type class and package required

isMultiSelect - whether this ClassPackageBrowser supports multi-selection.

filter - the ClassPackageBrowserFilter to use to filter the displayed packages and classes.

Returns:

the selected class or package, or null if nothing was selected.

See Also:

PACKAGE_ONLY, CLASS_ONLY, CLASS_AND_PACKAGE, JotManager

browseClassOrPackage

public java.lang.String[] browseClassOrPackage(JotManager mgr,
                                               int mode,
                                               int needs,
                                               boolean isMultiSelect,
                                               ClassPackageBrowserFilter filter,
                                               java.lang.String[] initialSelection)

Browses for one or more class or package.

Parameters:

mgr - the JotManager instance to use to located the classes and packages.

mode - the mode to invoke the ClassPackageBrowser in.

needs - the type class and package required

isMultiSelect - whether this ClassPackageBrowser supports multi-selection.

filter - the ClassPackageBrowserFilter to use to filter the displayed packages and classes.

initialSelection - the initially selected classes or packages.

Returns:

the selected class or package, or null if nothing was selected.

See Also:

PACKAGE_ONLY, CLASS_ONLY, CLASS_AND_PACKAGE, JotManager

browseClassOrPackage

public static java.lang.String browseClassOrPackage(java.awt.Component parent,
                                                    JProject proj,
                                                    int mode)

Browses for a single class or package.

Parameters:

parent - the component to parent the ClassPackageBrowser dialog on

proj - the JProject to use to find packages and classes

mode - the mode to invoke the ClassPackageBrowser in.

Returns:

the selected class or package, or null if nothing was selected.

See Also:

PACKAGE_ONLY, CLASS_ONLY, CLASS_AND_PACKAGE

browseClassOrPackage

public static java.lang.String browseClassOrPackage(java.awt.Component parent,
                                                    JProject proj,
                                                    int mode,
                                                    ClassPackageBrowserFilter filter)

Browses for a single class or package.

Parameters:

parent - the component to parent the ClassPackageBrowser dialog on

proj - the JProject to use to find packages and classes

mode - the mode to invoke the ClassPackageBrowser in.

filter - the ClassPackageBrowserFilter to use to filter the displayed packages and classes.

Returns:

the selected class or package, or null if nothing was selected.

See Also:

PACKAGE_ONLY, CLASS_ONLY, CLASS_AND_PACKAGE

browseClassOrPackage

public static java.lang.String[] browseClassOrPackage(java.awt.Component parent,
                                                      JProject proj,
                                                      int mode,
                                                      boolean isMultiSelect)

Browses for one or more classes or packages.

Parameters:

parent - the component to parent the ClassPackageBrowser dialog on

proj - the JProject to use to find packages and classes

mode - the mode to invoke the ClassPackageBrowser in.

isMultiSelect - whether this ClassPackageBrowser supports multi-selection.

Returns:

the selected class or package, or null if nothing was selected.

See Also:

PACKAGE_ONLY, CLASS_ONLY, CLASS_AND_PACKAGE

browseClassOrPackage

public static java.lang.String[] browseClassOrPackage(java.awt.Component parent,
                                                      JProject proj,
                                                      int mode,
                                                      boolean isMultiSelect,
                                                      ClassPackageBrowserFilter filter)

Browses for one or more classes or packages.

Parameters:

parent - the component to parent the ClassPackageBrowser dialog on

proj - the JProject to use to find packages and classes

mode - the mode to invoke the ClassPackageBrowser in.

isMultiSelect - whether this ClassPackageBrowser supports multi-selection.

filter - the ClassPackageBrowserFilter to use to filter the displayed packages and classes.

Returns:

the selected class or package, or null if nothing was selected.

See Also:

PACKAGE_ONLY, CLASS_ONLY, CLASS_AND_PACKAGE

browseClassOrPackage

public static java.lang.String[] browseClassOrPackage(java.awt.Component parent,
                                                      JProject proj,
                                                      int mode,
                                                      int needs,
                                                      boolean isMultiSelect,
                                                      ClassPackageBrowserFilter filter)

Browses for one or more classes or packages.

Parameters:

parent - the component to parent the ClassPackageBrowser dialog on

proj - the JProject to use to find packages and classes

mode - the mode to invoke the ClassPackageBrowser in.

needs - the type class and package required

isMultiSelect - whether this ClassPackageBrowser supports multi-selection.

filter - the ClassPackageBrowserFilter to use to filter the displayed packages and classes.

Returns:

the selected class or package, or null if nothing was selected.

See Also:

PACKAGE_ONLY, CLASS_ONLY, CLASS_AND_PACKAGE, JotManager

browseClassOrPackage

public static java.lang.String[] browseClassOrPackage(java.awt.Component parent,
                                                      JProject proj,
                                                      int mode,
                                                      int needs,
                                                      boolean isMultiSelect,
                                                      ClassPackageBrowserFilter filter,
                                                      java.lang.String[] initialSelection)

Browses for one or more classes or packages.

Parameters:

parent - the component to parent the ClassPackageBrowser dialog on

proj - the JProject to use to find packages and classes

mode - the mode to invoke the ClassPackageBrowser in.

needs - the type class and package required

isMultiSelect - whether this ClassPackageBrowser supports multi-selection.

filter - the ClassPackageBrowserFilter to use to filter the displayed packages and classes.

Returns:

the selected class or package, or null if nothing was selected.

See Also:

PACKAGE_ONLY, CLASS_ONLY, CLASS_AND_PACKAGE, JotManager

addNotify

public void addNotify()

removeNotify

public void removeNotify()

requestFocus

public void requestFocus()

addActionListener

public void addActionListener(java.awt.event.ActionListener listener)

removeActionListener

public void removeActionListener(java.awt.event.ActionListener listener)