oracle.jdeveloper.db.panels

Class ConnectionPanelUI

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

oracle.jdeveloper.db.panels.AbstractConnectionPanelUI

oracle.jdeveloper.db.panels.ConnectionPanelUI

All Implemented Interfaces:

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

Direct Known Subclasses:

AppConnectionPanelUI

public class ConnectionPanelUI
extends AbstractConnectionPanelUI

Widget to use in a wizard or dialog for selecting a database connection. Can include controls to create and edit the connections, and an area showing the connection details if required.

This panel is specific to database connections. If a different use is required create a subclass that overrides listConnections() and runConnectionDialog().

See Also:

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 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

Constructors

Constructor and Description
ConnectionPanelUI(boolean showDetails)
ConnectionPanelUI(boolean oracleOnly, boolean showDetails)
ConnectionPanelUI(java.lang.String[] subTypes, boolean showDetails)

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent ae) Deprecated. ActionListener interface no longer implemented. Buttons handled internally.
protected DatabaseConnectionEditorLauncher	createDatabaseConnectionEditorLauncher() Creates a DatabaseConnectionEditorLauncher for creating/editing a connection.
protected boolean	getCanAddNull() Deprecated.
protected java.lang.String	getComponentNamePrefix() Gets a prefix for the names of the components for testability.
javax.swing.JComboBox	getConnCombo() Deprecated. - this breaks the encapsulation of this UI class. Use getConnectionName() and setConnectionName(java.lang.String) to get/set the selection and addComboListener to add a listener for changes in the selection.
static java.lang.String	getConnection(java.lang.String title, java.lang.String prompt, java.lang.String connName, boolean oracleOnly) Invokes a dialog for selecting a connection.
ConnectionInfo	getConnectionInfo() Gets the connection details for the currently chosen connection.
java.lang.String	getConnectionName() Gets the connection name that is currently selected.
protected DatabaseConnections	getConnections() Used by the default implementation of listConnections() to return the DatabaseConnections instance that contains the connections to choose from.
protected javax.swing.JComboBox	getPicker() Gets the picker combo for the actual connection.
protected PropertyStorage	getPropertyStorage() Used by loadSettings() and saveSettings() for remembering the last chosen connection.
protected java.lang.String	getSettingsKey() The settings key is used to store the last selected connection in the property storage returned by getPropertyStorage().
protected java.lang.String	getStoreName() Gets the name of the connection store from which the connections are to be listed.
void	itemStateChanged(java.awt.event.ItemEvent e) Deprecated.
protected void	launchConnectionDialog(boolean edit) Launches the dialog for creating a new connection, or editing the currently selected connection.
protected java.util.Collection<java.lang.String>	listConnections() By default this lists the connections on the DatabaseConnections instance returned by getConnections().
void	loadSettings() Sets the current selection to that which is stored in the PropertyStorage returned by getPropertyStorage() under the key returned by getSettingsKey().
int	resetConnections() Resets the list of connections ( using listConnections() ) and returns the total number of connections in the newly populated list.
protected java.lang.String	runConnectionDialog(java.lang.String conn) This method is called as a result of the New or Edit button being pressed.
void	saveSettings() Saves the current selection to the PropertyStorage returned by getPropertyStorage() under the key returned by getSettingsKey().
void	setCanAddNull(boolean boo) Deprecated. - replaced by setNoConnectionString
void	setConnectionInfo(ConnectionInfo info) Sets the details for the currently chosen connection.
boolean	setConnectionName(java.lang.String name) Sets the name of the selected connection and returns true if the connection was in the list (i.e.

Methods inherited from class oracle.jdeveloper.db.panels.AbstractConnectionPanelUI

addButton, addButtons, addComboListener, addNotify, checkConnection, checkFocus, clearLastShownInfo, disableDetails, enableActiveComponents, enableButtons, fireSelectionChanged, getConnection, getContext, getDefaultFocusComponent, getDetailsPanel, getListeners, getNoConnectionString, getOracleSubType, getPromptText, getResourceHelper, getSubTypes, initialise, isListening, populateDetails, removeComboListener, setAddButtons, setConnectionLabel, setConnectionPrompt, setContext, setEnabled, setListening, setNoConnectionString, setShowDetails

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, 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, 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

Constructor Detail

ConnectionPanelUI

public ConnectionPanelUI(boolean showDetails)

ConnectionPanelUI

public ConnectionPanelUI(boolean oracleOnly,
                 boolean showDetails)

ConnectionPanelUI

public ConnectionPanelUI(java.lang.String[] subTypes,
                 boolean showDetails)

Method Detail

getComponentNamePrefix

protected java.lang.String getComponentNamePrefix()

Description copied from class: AbstractConnectionPanelUI

Gets a prefix for the names of the components for testability.

Specified by:

getComponentNamePrefix in class AbstractConnectionPanelUI

getPicker

protected javax.swing.JComboBox getPicker()

Description copied from class: AbstractConnectionPanelUI

Gets the picker combo for the actual connection. If this is a ItemSelectable fireSelectionChanged will be called whenever a SELECTED event is received.

Specified by:

getPicker in class AbstractConnectionPanelUI

getConnectionName

public java.lang.String getConnectionName()

Gets the connection name that is currently selected.

Returns:

the selected connection name (if there is one)

setConnectionName

public boolean setConnectionName(java.lang.String name)

Sets the name of the selected connection and returns true if the connection was in the list (i.e. the operation suceeded). If a null or empty string is passed in nothing will be done. If the connection is already selected nothing will be done.

Parameters:

name - the name of the connection to select

Returns:

true if the connection name was selected

getConnections

protected DatabaseConnections getConnections()

Used by the default implementation of listConnections() to return the DatabaseConnections instance that contains the connections to choose from.

getStoreName

protected java.lang.String getStoreName()

Gets the name of the connection store from which the connections are to be listed. By default this is the "IDE Connections" central store.

listConnections

protected java.util.Collection<java.lang.String> listConnections()

By default this lists the connections on the DatabaseConnections instance returned by getConnections(). Subclasses can override to provide any list of connection names required.

resetConnections

public int resetConnections()

Resets the list of connections ( using listConnections() ) and returns the total number of connections in the newly populated list.

Specified by:

resetConnections in class AbstractConnectionPanelUI

getConnectionInfo

public final ConnectionInfo getConnectionInfo()

Description copied from class: AbstractConnectionPanelUI

Gets the connection details for the currently chosen connection.

Specified by:

getConnectionInfo in class AbstractConnectionPanelUI

setConnectionInfo

public final void setConnectionInfo(ConnectionInfo info)

Description copied from class: AbstractConnectionPanelUI

Sets the details for the currently chosen connection.

Specified by:

setConnectionInfo in class AbstractConnectionPanelUI

getSettingsKey

protected java.lang.String getSettingsKey()

The settings key is used to store the last selected connection in the property storage returned by getPropertyStorage(). For the save to occur, saveSettings() must be called.

getPropertyStorage

protected PropertyStorage getPropertyStorage()

Used by loadSettings() and saveSettings() for remembering the last chosen connection.

loadSettings

public void loadSettings()

Sets the current selection to that which is stored in the PropertyStorage returned by getPropertyStorage() under the key returned by getSettingsKey().

saveSettings

public void saveSettings()

Saves the current selection to the PropertyStorage returned by getPropertyStorage() under the key returned by getSettingsKey().

runConnectionDialog

protected java.lang.String runConnectionDialog(java.lang.String conn)

This method is called as a result of the New or Edit button being pressed.

Parameters:

conn - the connection name to edit in the dialog, if null invoke a "new" dialog.

Returns:

the name of the connection that was edited (or newly created), or null if the user cancelled.

createDatabaseConnectionEditorLauncher

protected DatabaseConnectionEditorLauncher createDatabaseConnectionEditorLauncher()

Creates a DatabaseConnectionEditorLauncher for creating/editing a connection. This is used by runConnectionDialog(String) when the add/edit button is pressed.

launchConnectionDialog

protected void launchConnectionDialog(boolean edit)

Description copied from class: AbstractConnectionPanelUI

Launches the dialog for creating a new connection, or editing the currently selected connection.

Specified by:

launchConnectionDialog in class AbstractConnectionPanelUI

itemStateChanged

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

Deprecated.

Combo listener is now internal and calls checkConnection.

getConnCombo

@Deprecated
public javax.swing.JComboBox getConnCombo()

Deprecated. - this breaks the encapsulation of this UI class. Use getConnectionName() and setConnectionName(java.lang.String) to get/set the selection and addComboListener to add a listener for changes in the selection.

getCanAddNull

@Deprecated
protected boolean getCanAddNull()

Deprecated.

setCanAddNull

@Deprecated
public void setCanAddNull(boolean boo)

Deprecated. - replaced by setNoConnectionString

actionPerformed

@Deprecated
public void actionPerformed(java.awt.event.ActionEvent ae)

Deprecated. ActionListener interface no longer implemented. Buttons handled internally.

getConnection

public static java.lang.String getConnection(java.lang.String title,
                             java.lang.String prompt,
                             java.lang.String connName,
                             boolean oracleOnly)

Invokes a dialog for selecting a connection. This only allows the user to select from the IDE connections, not any in an application's resources. To select from application resources use AppConnectionPanelUI.

Parameters:

title - the dialog title

prompt - the prompt string for the dialog

connName - the initially selected connection name, or null to use the default

oracleOnly - whether to only display Oracle connections.