|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1) E13403-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.awt.Component java.awt.Container javax.swing.JComponent javax.swing.JPanel oracle.jdeveloper.db.panels.ConnectionPanelUI
public class ConnectionPanelUI
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().
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 m_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 |
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()
Returns whether this combo is configured to allow the user to select no connection name (assuming there are connections listed). |
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. |
protected static java.lang.String |
getConnection(ConnectionPanelUI panel,
java.lang.String title,
java.lang.String connName)
|
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)
|
protected void |
launchConnectionDialog(boolean edit)
|
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 m_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)
Sets whether the user is allowed to select no connection if there are connections in the list. |
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)
|
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 |
---|
public ConnectionPanelUI(boolean showDetails)
public ConnectionPanelUI(boolean oracleOnly, boolean showDetails)
public ConnectionPanelUI(java.lang.String[] subTypes, boolean showDetails)
Method Detail |
---|
protected java.lang.String getComponentNamePrefix()
protected java.awt.Component getPicker()
public java.lang.String getConnectionName()
public boolean setConnectionName(java.lang.String name)
#allowNullSelection
returns
true, in which case the selection will be nulled out.
name
- the name of the connection to select
protected boolean getCanAddNull()
public void setCanAddNull(boolean boo)
resetConnections()
as this
will destroy the context of the combo box.
protected DatabaseConnections getConnections()
listConnections()
to return the
DatabaseConnections instance that contains the connections to choose from.
protected java.util.Collection<java.lang.String> listConnections()
getConnections()
.
Subclasses can override to provide any list of connection names required.
public int resetConnections()
listConnections()
) and
returns the total number of connections in the newly populated list.
protected final ConnectionInfo getConnectionInfo()
protected java.lang.String getSettingsKey()
getPropertyStorage()
. For the save
to occur, saveSettings()
must be called.
protected PropertyStorage getPropertyStorage()
loadSettings()
and saveSettings()
for remembering
the last chosen connection.
public void loadSettings()
getPropertyStorage()
under the key returned by
getSettingsKey()
.
public void saveSettings()
getPropertyStorage()
under the key returned by
getSettingsKey()
.
protected java.lang.String runConnectionDialog(java.lang.String conn)
conn
- the connection name to edit in the dialog, if null invoke a
"new" dialog.
public void enableActiveComponents(boolean boo)
protected void launchConnectionDialog(boolean edit)
public void itemStateChanged(java.awt.event.ItemEvent e)
itemStateChanged
in interface java.awt.event.ItemListener
public java.awt.Component getDefaultFocusComponent()
@Deprecated public javax.swing.JComboBox getConnCombo()
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.
public void addComboListener(java.awt.event.ItemListener itemListener)
public void removeComboListener(java.awt.event.ItemListener itemListener)
addComboListener(ItemListener)
public static java.lang.String getConnection(java.lang.String title, java.lang.String prompt, java.lang.String connName, boolean oracleOnly)
AppConnectionPanelUI.getConnection(java.lang.String, java.lang.String, java.lang.String, boolean)
title
- the dialog titleprompt
- the prompt string for the dialogconnName
- the initially selected connection name, or
null
to use the defaultoracleOnly
- whether to only display Oracle connections.AppConnectionPanelUI.getConnection(java.lang.String, java.lang.String, java.lang.String, boolean)
protected static java.lang.String getConnection(ConnectionPanelUI panel, java.lang.String title, java.lang.String connName)
protected java.lang.String[] getSubTypes()
protected void initialise()
protected oracle.ideimpl.db.DBUIResourceHelper getResourceHelper()
protected void addButtons(javax.swing.JPanel panel, java.awt.GridBagConstraints gbc)
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 javax.swing.JPanel getDetailsPanel()
If overriden to return a non-standard panel, checkConnection()
and
disableDetails()
must also be overriden.
protected void enableButtons(boolean validConn)
validConn
- whether the current selection contains a valid connectionpublic void setEnabled(boolean boo)
setEnabled
in class javax.swing.JComponent
protected void checkConnection()
enableButtons(boolean)
,
populateDetails(oracle.jdeveloper.db.ConnectionInfo)
protected void disableDetails()
protected void populateDetails(ConnectionInfo connInfo)
checkConnection()
@Deprecated protected java.lang.String getPromptText()
setConnectionPrompt(java.lang.String)
in a subclass constructor.
setConnectionPrompt(java.lang.String)
.
public void setConnectionLabel(java.lang.String label)
public void setConnectionPrompt(java.lang.String prompt)
public void actionPerformed(java.awt.event.ActionEvent e)
actionPerformed
in interface java.awt.event.ActionListener
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1) E13403-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |