Skip navigation links

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

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

Direct Known Subclasses:

AppConnectionPanelUI

public class ConnectionPanelUI

extends javax.swing.JPanel

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

ConnectionPanelUI(boolean showDetails)

ConnectionPanelUI(boolean oracleOnly, boolean showDetails)

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

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e)
protected void	addButton(javax.swing.JPanel panel, javax.swing.JButton button, java.awt.GridBagConstraints gbc, java.lang.String tooltip, java.lang.String mnemonicText, java.lang.String name)
protected void	addButtons(javax.swing.JPanel panel, java.awt.GridBagConstraints gbc) This adds the buttons on the RHS of the connection combo box.
void	addComboListener(java.awt.event.ItemListener itemListener) Adds an ItemListener to the connections combo box.
protected void	checkConnection() Checks the current selection is a connection name that exists in the underlying connections namespace and enables the buttons as appropriate, plus populates the details panel if this panel is in showDetails mode.
protected void	clearLastShownInfo() Calls to populateDetails are only made if the connection store/name change.
protected void	disableDetails() Disables all components in the details panel.
void	enableActiveComponents(boolean boo) Enables or disables the picker component, but not the descriptive text.
protected void	enableButtons(boolean validConn) Used to enable/disable buttons that require a valid connection to be selected for their enabled state.
protected boolean	getCanAddNull() Deprecated.
protected java.lang.String	getComponentNamePrefix()
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(java.awt.event.ItemListener) to add a listener for changes in the selection.
static java.lang.String	getConnection(ConnectionPanelUI panel, java.lang.String title, java.lang.String connName) Launches a dialog with the given ConnectionPanelUI allowing the user to choose a connection.
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.
protected ConnectionInfo	getConnectionInfo()
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.
java.awt.Component	getDefaultFocusComponent() Gets the component that the default focus should be on for this panel.
protected javax.swing.JPanel	getDetailsPanel() Returns the details panel (only called if m_showDetails is true).
protected java.awt.Component	getPicker()
protected java.lang.String	getPromptText() Deprecated. - call setConnectionPrompt(java.lang.String) in a subclass constructor.
protected PropertyStorage	getPropertyStorage() Used by loadSettings() and saveSettings() for remembering the last chosen connection.
protected oracle.ideimpl.db.DBUIResourceHelper	getResourceHelper()
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[]	getSubTypes() If the picker was setup to only list certain connection subtypes this returns the required list.
protected void	initialise() Initialises the layout.
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 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().
protected void	populateDetails(ConnectionInfo connInfo) Populates the details panel with the given connection information.
void	removeComboListener(java.awt.event.ItemListener itemListener) Removes an ItemListener from the connections combo box.
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(String)
void	setConnectionLabel(java.lang.String label) Sets the label for the connection combo box.
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.
void	setConnectionPrompt(java.lang.String prompt) Sets the prompt above the connection selection.
void	setEnabled(boolean boo)
void	setNoConnectionString(java.lang.String noConn) Sets a string that (if not null) will be added to the list of connections to allow the selection of "No Connection".

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, 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, hide, 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, 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()

getPicker

protected java.awt.Component getPicker()

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, unless #allowNullSelection returns true, in which case the selection will be nulled out.

Parameters:

name - the name of the connection to select

Returns:

true if the connection name was selected

getCanAddNull

@Deprecated
protected boolean getCanAddNull()

Deprecated.

setCanAddNull

@Deprecated
public void setCanAddNull(boolean boo)

Deprecated. - replaced by setNoConnectionString(String)

setNoConnectionString

public final void setNoConnectionString(java.lang.String noConn)

Sets a string that (if not null) will be added to the list of connections to allow the selection of "No Connection". What the string is will be displayed to the user so should be translated. If noConn is null this will mean the user must pick a connection. For an empty entry in the list set it to " ".

Parameters:

noConn - a string to signify no selection (e.g. "<No Connection>"), or null to ensure the user must pick a connection (the default).

getConnections

protected DatabaseConnections getConnections()

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

listConnections

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

By default this lists the connections 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.

getConnectionInfo

protected final ConnectionInfo getConnectionInfo()

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.

enableActiveComponents

public void enableActiveComponents(boolean boo)

Enables or disables the picker component, but not the descriptive text.

launchConnectionDialog

protected void launchConnectionDialog(boolean edit)

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

itemStateChanged

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

Deprecated.

Combo listener is now internal and calls checkConnection().

getDefaultFocusComponent

public java.awt.Component getDefaultFocusComponent()

Gets the component that the default focus should be on for this panel.

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(java.awt.event.ItemListener) to add a listener for changes in the selection.

addComboListener

public void addComboListener(java.awt.event.ItemListener itemListener)

Adds an ItemListener to the connections combo box.

removeComboListener

public void removeComboListener(java.awt.event.ItemListener itemListener)

Removes an ItemListener from the connections combo box.

See Also:

addComboListener(ItemListener)

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.getConnection(java.lang.String, java.lang.String, java.lang.String, boolean)

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.

See Also:

AppConnectionPanelUI.getConnection(java.lang.String, java.lang.String, java.lang.String, boolean)

getConnection

public static java.lang.String getConnection(ConnectionPanelUI panel,
                                             java.lang.String title,
                                             java.lang.String connName)

Launches a dialog with the given ConnectionPanelUI allowing the user to choose a connection.

getSubTypes

protected java.lang.String[] getSubTypes()

If the picker was setup to only list certain connection subtypes this returns the required list.

initialise

protected void initialise()

Initialises the layout. This calls getPicker() to get the active picker Component for the panel.

getResourceHelper

protected oracle.ideimpl.db.DBUIResourceHelper getResourceHelper()

For internal use only. Application developers should not use this

addButtons

protected void addButtons(javax.swing.JPanel panel,
                          java.awt.GridBagConstraints gbc)

This adds the buttons on the RHS of the connection combo box. The gridx of the given constraints is incremented after every button is added so subclasses can add their own buttons after the default add/edit buttons this class defines.

addButton

protected void addButton(javax.swing.JPanel panel,
                         javax.swing.JButton button,
                         java.awt.GridBagConstraints gbc,
                         java.lang.String tooltip,
                         java.lang.String mnemonicText,
                         java.lang.String name)

getDetailsPanel

protected javax.swing.JPanel getDetailsPanel()

Returns the details panel (only called if m_showDetails is true). The default details panel displays the username, driver class name and url for the database connection. Override as necessary.

If overriden to return a non-standard panel, populateDetails(oracle.jdeveloper.db.ConnectionInfo) must also be overriden. In addition either disableDetails() should be overriden, or calling setEnabled on the returned JPanel should enable/disable all the detail components on the panel as well as the panel itself.

enableButtons

protected void enableButtons(boolean validConn)

Used to enable/disable buttons that require a valid connection to be selected for their enabled state. This is called when the selected connection changes.

Parameters:

validConn - whether the current selection contains a valid connection

setEnabled

public void setEnabled(boolean boo)

Overrides:

setEnabled in class javax.swing.JComponent

checkConnection

protected void checkConnection()

Checks the current selection is a connection name that exists in the underlying connections namespace and enables the buttons as appropriate, plus populates the details panel if this panel is in showDetails mode.

See Also:

enableButtons(boolean), populateDetails(oracle.jdeveloper.db.ConnectionInfo)

clearLastShownInfo

protected final void clearLastShownInfo()

Calls to populateDetails are only made if the connection store/name change. If the details of the currently selected connection are changed (e.g. via the edit dialog) then this method must be called prior to calling checkConnection().

disableDetails

protected void disableDetails()

Disables all components in the details panel. By default this calls setEnabled( false ) on the details panel (returned by getDetailsPanel()). If that will not disable all the components on the details panel this method should be overridden to do that. The details panel should be enabled when populateDetails(oracle.jdeveloper.db.ConnectionInfo) is called with a ConnectionInfo.

populateDetails

protected void populateDetails(ConnectionInfo connInfo)

Populates the details panel with the given connection information. This is called by checkConnection()

getPromptText

@Deprecated
protected java.lang.String getPromptText()

Deprecated. - call setConnectionPrompt(java.lang.String) in a subclass constructor.

Returns the prompt text to go at the top of the panel. Subclasses can override, to customise the prompt text of a panel without subclassing simply call setConnectionPrompt(java.lang.String).

setConnectionLabel

public void setConnectionLabel(java.lang.String label)

Sets the label for the connection combo box.

setConnectionPrompt

public void setConnectionPrompt(java.lang.String prompt)

Sets the prompt above the connection selection.

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Skip navigation links