public abstract class DatabaseConnectionEditorLauncher
extends java.lang.Object
DatabaseConnectionEditor.createLauncher()
Modifier and Type | Class and Description |
---|---|
static class |
DatabaseConnectionEditorLauncher.StoreChoice
This governs what choice the user has over where new connections are
created from the create connection dialog.
|
Constructor and Description |
---|
DatabaseConnectionEditorLauncher() |
Modifier and Type | Method and Description |
---|---|
protected java.lang.String[] |
getAllowedSubTypes()
Gets any restriction on the subtype of database connection that the
launched dialog will allow the user to create/edit.
|
protected java.lang.String |
getConnectionBaseName()
Gets the base name for any connection created by this editor.
|
protected Context |
getContext()
Gets the IDE Context.
|
protected java.util.Properties |
getDefaultProperties()
Gets the default Properties for any connection created by this editor.
|
boolean |
getEnsureVisible()
Gets whether the launcher should ensure that any new connection is
visible in the product.
|
protected DatabaseConnectionEditorLauncher.StoreChoice |
getStoreChoice()
Gets the restriction on connection store the user should be limited
to in the dialog.
|
protected boolean |
isAllowedSubType(java.lang.String subType)
Tests whether the given conneciton subtype is allowed in the editor.
|
ConnectionInfo |
launchEditor(ConnectionInfo info)
Launches the editor to edit the given connection.
|
abstract ConnectionInfo |
launchEditor(DatabaseConnections conns,
java.lang.String connName)
Launches the connection editor.
|
java.lang.String |
launchEditor(java.lang.String connName)
Launches the editor to edit the given connection name.
|
java.lang.String |
launchEditor(java.lang.String storeName,
java.lang.String connName)
Launches the editor to edit the given connection name.
|
void |
setAllowedSubTypes(java.lang.String[] subTypes)
Restricts the subtype of any created connections to be in the specified
array.
|
void |
setConnectionBaseName(java.lang.String baseName)
Sets the base name for any connection created by this editor.
|
void |
setContext(Context context)
Sets the IDE Context the dialog is being launched from.
|
void |
setDefautProperties(java.util.Properties props)
Sets the default Properties for any connection created by this editor.
|
void |
setEnsureVisible(boolean ensureVisible)
Sets whether the launcher should ensure that a new connection is
visible in the product when it is created (e.g.
|
void |
setStoreChoice(DatabaseConnectionEditorLauncher.StoreChoice choice)
Sets the store choice that the user will be presented with in the
dialog.
|
public final void setEnsureVisible(boolean ensureVisible)
ensureVisible
- whether to ensure a new connection is visible.public final boolean getEnsureVisible()
public final void setAllowedSubTypes(java.lang.String[] subTypes)
subTypes
- the subtypes of connection to createDatabaseProvider.SUBTYPE_CLASS_REFTYPE
,
AbstractConnectionPanelUI#getOracleSubType()
protected final java.lang.String[] getAllowedSubTypes()
protected final boolean isAllowedSubType(java.lang.String subType)
subType
- the connection subtype to test#getAllowedSubtypes()
public final void setStoreChoice(DatabaseConnectionEditorLauncher.StoreChoice choice)
choice
- whether (and how) to restrict the user's choice of
connection store - if null it is ignored.protected final DatabaseConnectionEditorLauncher.StoreChoice getStoreChoice()
public final void setContext(Context context)
context
- the current IDE Contextprotected Context getContext()
#setContext()
then Context.newIdeContext()
is returned.public final void setDefautProperties(java.util.Properties props)
protected final java.util.Properties getDefaultProperties()
public final void setConnectionBaseName(java.lang.String baseName)
protected java.lang.String getConnectionBaseName()
public final java.lang.String launchEditor(java.lang.String connName)
Note that if the store choice is not restricted you will not know which
connection store the returned name was created - in that case you need
to call launchEditor(ConnectionInfo)
instead.
connName
- the name of the connection to edit, or null for a
create.public final java.lang.String launchEditor(java.lang.String storeName, java.lang.String connName)
Note that if the store choice is not restricted you will not know which
connection store the returned name was created - in that case you need
to call launchEditor(ConnectionInfo)
instead.
storeName
- the store to create/edit a connection inconnName
- the name of the connection to edit, or null for a
create.public final ConnectionInfo launchEditor(ConnectionInfo info)
To create a connection in a given store, create a ConnectionInfo with the store name and no connection name.
info
- the store and connection name for the create/editpublic abstract ConnectionInfo launchEditor(DatabaseConnections conns, java.lang.String connName)
connName
- the name of the connection to edit (or null to create a new
connection).conns
- the connection store that the connection is in, or that is
the default for the new connection. If null the IDE context will be used
to determine the default store.