oracle.jdeveloper.db.panels

Class DatabaseConnectionPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

oracle.ide.panels.DefaultTraversablePanel

oracle.jdeveloper.db.panels.DatabaseConnectionPanel

All Implemented Interfaces:

java.awt.event.ItemListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, GridBagConstants, Traversable

Direct Known Subclasses:

AppDatabaseConnPanel

public class DatabaseConnectionPanel
extends DefaultTraversablePanel
implements java.awt.event.ItemListener

Traversable panel to use in a wizard for selecting a connection from the IDE connection store (Resource Palette and Database Navigator).

The connection name goes in the context under CHOSEN_CONNECTION_NAME, the JDBC Connection under CHOSEN_CONNECTION, and the Database under UIConstants.PROVIDER_KEY.

The panel will use available WizardCallbacks or DialogCallbacks to prevent the user from continuing (or pressing OK) if a valid connection is not chosen.

If a connection picker is required for embedding into another panel use a ConnectionPanelUI directly instead.

Since:

11

See Also:

ConnectionPanelUI, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHOSEN_CONNECTION Key for the Connection in the context.
static java.lang.String	CHOSEN_CONNECTION_NAME Key for the connection name in the context (a String).

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 oracle.ide.controls.GridBagConstants

ANCHOR_C, ANCHOR_E, ANCHOR_N, ANCHOR_NE, ANCHOR_NW, ANCHOR_S, ANCHOR_SE, ANCHOR_SW, ANCHOR_W, FILL_NONE, FILL_X, FILL_XY, FILL_Y

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
DatabaseConnectionPanel()

Method Summary

Methods

Modifier and Type	Method and Description
void	addItemListener(java.awt.event.ItemListener il)
protected boolean	canWizardNext() The default checkWizardButtons() implementation uses this method to check whether the next button should be enabled.
void	checkWizardButtons() If in a wizard, this checks the enable/disable state of the wizard's back, next and finish buttons.
protected void	commitConnectionInfo(ConnectionInfo info, TraversableContext dataContext) This is called by onExit once the chosen connection has been identified.
protected void	commitConnectionName(java.lang.String name, TraversableContext dataContext) Deprecated. replaced by commitConnectionInfo(ConnectionInfo,TraversableContext)
protected ConnectionPanelUI	createConnectionUI()
void	enableActiveComponents(boolean boo)
java.lang.String	getConnectionName()
protected java.lang.String	getConnectionPrompt()
protected ConnectionPanelUI	getConnectionUI() Override createConnectionUI() to custom the ConnectionPanelUI implementation.
protected java.lang.String	getEntryConnection(TraversableContext dataContext) Returns the name of a connection to select by default onEntry.
protected java.lang.String	getProviderKey() Returns the key to store the chosen Database in the traversable context with.
void	itemStateChanged(java.awt.event.ItemEvent e)
void	onEntry(TraversableContext dataContext) Does nothing by default.
void	onExit(TraversableContext dataContext) Does nothing by default.
void	removeItemListener(java.awt.event.ItemListener il)
void	setConnectionLabel(java.lang.String label)
boolean	setConnectionName(java.lang.String name)
protected boolean	validateOnExit(TraversableContext dataContext) Gets whether or not validation should be done, and errors should be shown to the user for the given TraversableContext.

Methods inherited from class oracle.ide.panels.DefaultTraversablePanel

gbc, gbc, getComponent, getDefaultTitle, getExitTransition, getHelpID, getText, setDefaultTitle, setHelpID

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

CHOSEN_CONNECTION_NAME

public static final java.lang.String CHOSEN_CONNECTION_NAME

Key for the connection name in the context (a String).

See Also:

Constant Field Values

CHOSEN_CONNECTION

public static final java.lang.String CHOSEN_CONNECTION

Key for the Connection in the context.

See Also:

Connection, Constant Field Values

Constructor Detail

DatabaseConnectionPanel

public DatabaseConnectionPanel()

Method Detail

getConnectionName

public java.lang.String getConnectionName()

setConnectionName

public boolean setConnectionName(java.lang.String name)

createConnectionUI

protected ConnectionPanelUI createConnectionUI()

getConnectionUI

protected final ConnectionPanelUI getConnectionUI()

Override createConnectionUI() to custom the ConnectionPanelUI implementation.

setConnectionLabel

public void setConnectionLabel(java.lang.String label)

getConnectionPrompt

protected java.lang.String getConnectionPrompt()

getProviderKey

protected java.lang.String getProviderKey()

Returns the key to store the chosen Database in the traversable context with. If this returns null, no attempt will be made to check the connection onExit. By default this returns UIConstants.PROVIDER_KEY

onEntry

public void onEntry(TraversableContext dataContext)

Description copied from class: DefaultTraversablePanel

Does nothing by default.

Specified by:

onEntry in interface Traversable

Overrides:

onEntry in class DefaultTraversablePanel

Parameters:

dataContext - The data wrapper where the Traversable locates the data that it needs to populate the UI.

See Also:

Traversable.onEntry(TraversableContext)

getEntryConnection

protected java.lang.String getEntryConnection(TraversableContext dataContext)

Returns the name of a connection to select by default onEntry.

onExit

public void onExit(TraversableContext dataContext)
            throws TraversalException

Description copied from class: DefaultTraversablePanel

Does nothing by default.

Specified by:

onExit in interface Traversable

Overrides:

onExit in class DefaultTraversablePanel

Parameters:

dataContext - The data object where changes made in the UI should be copied so that the changes can be accessed by other Traversables.

Throws:

TraversalException - if the user has entered either incomplete, invalid, or inconsistent data. This exception prevents the property dialog or wizard from continuing and forces the user to stay on the current Traversable until the data entered is valid or the user cancels. The exception class itself is capable of carrying an error message that will be shown to the user. Refer to its javadoc for details.

See Also:

Traversable.onExit(TraversableContext)

validateOnExit

protected boolean validateOnExit(TraversableContext dataContext)

Gets whether or not validation should be done, and errors should be shown to the user for the given TraversableContext.

By default this returns true unless the context has a direction of backwards traversal.

Returns:

true if errors in commiting the chosen connection should be shown to the user.

commitConnectionName

@Deprecated
protected void commitConnectionName(java.lang.String name,
                                   TraversableContext dataContext)
                             throws TraversalException

Deprecated. replaced by commitConnectionInfo(ConnectionInfo,TraversableContext)

Throws:

TraversalException

commitConnectionInfo

protected void commitConnectionInfo(ConnectionInfo info,
                        TraversableContext dataContext)
                             throws TraversalException

This is called by onExit once the chosen connection has been identified. The method should commit the connection information to the traversable context as appropriate.

Throws:

TraversalException

itemStateChanged

public void itemStateChanged(java.awt.event.ItemEvent e)

Specified by:

itemStateChanged in interface java.awt.event.ItemListener

addItemListener

public void addItemListener(java.awt.event.ItemListener il)

removeItemListener

public void removeItemListener(java.awt.event.ItemListener il)

checkWizardButtons

public void checkWizardButtons()

If in a wizard, this checks the enable/disable state of the wizard's back, next and finish buttons. This implementation only checks the "next" button, using canWizardNext().

canWizardNext

protected boolean canWizardNext()

The default checkWizardButtons() implementation uses this method to check whether the next button should be enabled. This checks that there is a connection selected.

enableActiveComponents

public void enableActiveComponents(boolean boo)