oracle.jdeveloper.db.panels
Class AppConnectionPanelUI

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  oracle.jdeveloper.db.panels.ConnectionPanelUI
                      oracle.jdeveloper.db.panels.AppConnectionPanelUI

All Implemented Interfaces:

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

public class AppConnectionPanelUI
extends ConnectionPanelUI

Connection picker for the database connections in the "Application Resources" Connection section for an application (workspace).

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

AppConnectionPanelUI(boolean showDetails)

AppConnectionPanelUI(boolean oracleOnly, boolean showDetails)

AppConnectionPanelUI(java.lang.String[] dbSubTypes, boolean showDetails)

Method Summary

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 this class to listen for changes to the chosen connection.
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	checkFocus() Checks that the default focus component is focused.
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 void	fireSelectionChanged()
protected java.lang.String	getComponentNamePrefix() Gets a prefix for the names of the components for testability.
static ConnectionInfo	getConnection(oracle.jdeveloper.db.panels.AbstractConnectionPanelUI panel, java.lang.String title, ConnectionInfo connInfo) 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 from the Application Resources for the current active Application.
protected DatabaseConnections	getConnections() Used by the default implementation of ConnectionPanelUI.listConnections() to return the DatabaseConnections instance that contains the connections to choose from.
protected Context	getContext()
java.awt.Component	getDefaultFocusComponent()
protected javax.swing.JPanel	getDetailsPanel() Returns the details panel (only called if m_showDetails is true).
protected java.util.Collection<java.awt.event.ItemListener>	getListeners()
protected java.lang.String	getNoConnectionString() Gets the String in the picker that represents a null selection.
static java.lang.String	getOracleSubType() Gets the connection subtype for Oracle JDBC connections.
protected java.lang.String	getPromptText() Deprecated. - call setConnectionPrompt(java.lang.String) in a subclass constructor.
protected oracle.ideimpl.db.DBUIResourceHelper	getResourceHelper()
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.
protected boolean	isListening()
protected java.util.Collection<java.lang.String>	listConnections() By default this lists the connections on the DatabaseConnections instance returned by ConnectionPanelUI.getConnections().
protected void	populateDetails(ConnectionInfo connInfo) Populates the details panel with the given connection information.
void	removeComboListener(java.awt.event.ItemListener itemListener) Removes a previously registered ItemListener from this picker.
protected java.lang.String	runConnectionDialog(java.lang.String name) This method is called as a result of the New or Edit button being pressed.
protected java.lang.String	runIdeConnectionDialog()
void	setConnectionLabel(java.lang.String label) Sets the label for the connection combo box.
void	setConnectionPrompt(java.lang.String prompt) Sets the prompt above the connection selection.
void	setContext(Context context)
void	setEnabled(boolean boo)
protected void	setListening(boolean listening)
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 oracle.jdeveloper.db.panels.ConnectionPanelUI

actionPerformed, getCanAddNull, getConnCombo, getConnectionInfo, getConnectionName, getPicker, getPropertyStorage, getSettingsKey, getStoreName, itemStateChanged, launchConnectionDialog, loadSettings, resetConnections, saveSettings, setCanAddNull, setConnectionInfo, setConnectionName

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

AppConnectionPanelUI

public AppConnectionPanelUI(boolean showDetails)

AppConnectionPanelUI

public AppConnectionPanelUI(boolean oracleOnly,
                            boolean showDetails)

AppConnectionPanelUI

public AppConnectionPanelUI(java.lang.String[] dbSubTypes,
                            boolean showDetails)

Method Detail

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.

getComponentNamePrefix

protected java.lang.String getComponentNamePrefix()

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

Overrides:

getComponentNamePrefix in class ConnectionPanelUI

getConnections

protected DatabaseConnections getConnections()

Description copied from class: ConnectionPanelUI

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

Overrides:

getConnections in class ConnectionPanelUI

runConnectionDialog

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

Description copied from class: ConnectionPanelUI

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

Overrides:

runConnectionDialog in class ConnectionPanelUI

Parameters:

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

getContext

protected Context getContext()

setContext

public void setContext(Context context)

runIdeConnectionDialog

protected java.lang.String runIdeConnectionDialog()

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

enableActiveComponents

public void enableActiveComponents(boolean boo)

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

listConnections

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

Description copied from class: ConnectionPanelUI

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

Overrides:

listConnections in class ConnectionPanelUI

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 from the Application Resources for the current active Application.

Parameters:

title - the dialog title

prompt - the prompt string for the dialog

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

connClassName - the connection class to prompt for

oracleOnly - whether to only display Oracle connections.

getSubTypes

protected java.lang.String[] getSubTypes()

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

setNoConnectionString

public 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).

getNoConnectionString

protected java.lang.String getNoConnectionString()

Gets the String in the picker that represents a null selection.

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

used to set up the components in the panel for accessibility and testability.

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.

checkFocus

protected final void checkFocus()

Checks that the default focus component is focused. Should be called after a dialog has returned back to the picker.

setEnabled

public void setEnabled(boolean boo)

Overrides:

setEnabled in class javax.swing.JComponent

addComboListener

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

Adds an ItemListener to this class to listen for changes to the chosen connection. The combos do not allow a null selection, the user must always pick something, therefore DELSELECT events will not be fired to the registered listeners, only SELECT events.

removeComboListener

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

Removes a previously registered ItemListener from this picker.

See Also:

addComboListener(ItemListener)

getListeners

protected final java.util.Collection<java.awt.event.ItemListener> getListeners()

isListening

protected boolean isListening()

setListening

protected void setListening(boolean listening)

fireSelectionChanged

protected final void fireSelectionChanged()

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.

getDefaultFocusComponent

public java.awt.Component getDefaultFocusComponent()

getOracleSubType

public static java.lang.String getOracleSubType()

Gets the connection subtype for Oracle JDBC connections.

getConnection

public static ConnectionInfo getConnection(oracle.jdeveloper.db.panels.AbstractConnectionPanelUI panel,
                                           java.lang.String title,
                                           ConnectionInfo connInfo)

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