public static class DBObjectProviderPicker.PickerConfiguration
extends java.lang.Object
DBObjectProviderPicker.getPicker(oracle.ide.db.controls.DBObjectProviderPicker.PickerConfiguration)
.Constructor and Description |
---|
PickerConfiguration() |
Modifier and Type | Method and Description |
---|---|
boolean |
canBeGlobal(java.lang.String providerType)
Return true if the chooser for the specified provider type can
be global.
|
boolean |
getAllowCreate()
When true, the widget will allow the creation of new providers.
|
boolean |
getAllowCreateProject()
When true, the widget will allow the creation of new projects if relevant.
|
boolean |
getAllowNull()
When true, the widget will add a null option
|
Context |
getContext()
Gets the Ide context for the picker.
|
boolean |
getControlEnable()
When true, the widget will show a check box which will enable/disable
the rest of the picker controls.
|
java.awt.event.ActionListener |
getControlEnableListener()
Gets the listener for the 'enable' control of the picker.
|
java.lang.String[] |
getDatabaseTypes()
Gets the allowed "database types" for the providers that should be
listed for choosing.
|
DBObjectProviderID |
getDefaultProviderID()
The picker may use this to initialize
|
boolean |
getForceGlobal()
When true, the picker will not be restricted to the current Application
e.g.
|
java.lang.String |
getHeaderText()
Translatable string to be used in the header for the dialog.
|
java.lang.String |
getHelpID()
String to be used as the help ID for the dialog.
|
java.lang.String |
getLabel()
Returns the label (optional) for the radio buttons to select the provider
type.
|
boolean |
getOnlyShowProjectDependencies()
When true, a project list will only show dependent projects
|
DBObjectProvider |
getOtherProvider()
Get the other provider to use when initializing the chooser
so that if a provider is created it can match the other provider type.
|
DBObjectProviderPicker.PickerListener |
getPickerListener()
Gets the listener the picker should be initialized with.
|
DBObjectProviderPicker.PickerValidator |
getPickerValidator()
Gets the validator to check the selected provider (can be null).
|
java.lang.String |
getPrompt()
Translatable string to be used as the prompt for the DBObjectProvider
picker UI component.
|
java.lang.String[] |
getProviderTypes()
The type of each DBObjectProvider to be offered for selection.
|
boolean |
getShowDetails()
Determines whether the picker should include a details section underneath
showing important properties of the chosen provider.
|
java.lang.String |
getTitle()
Translatable string to be used in the title bar for the dialog.
|
void |
setAllowCreate(boolean val)
When true, the widget will allow the creation of new providers.
|
void |
setAllowCreateProject(boolean val)
When true, the widget will allow the creation of new projects if relevant.
|
void |
setAllowNull(boolean val)
When true, the widget will add a null option
|
void |
setCanBeGlobal(java.lang.String providerType,
boolean value)
Set whether or not the corresponding ProviderType can be global.
|
void |
setContext(Context context)
Gets the Ide context for the picker.
|
void |
setControlEnable(boolean val)
When true, the widget will show a check box which will enable/disable
the rest of the picker controls.
|
void |
setControlEnableListener(java.awt.event.ActionListener controlEnableListener)
Sets an optional additional listener for the 'enable' control.
|
void |
setDatabaseTypes(java.lang.String... databaseTypes)
Sets the allowed "database types" for the providers that should be
listed for choosing.
|
void |
setDefaultProviderID(DBObjectProviderID defaultProviderID)
Set the details of the provider that should be initially selected.
|
void |
setDisablePickerForDefaultProvider(boolean disablePickerForDefault)
Sets whether to disable the picker when the default provider specified
in the configuration is visible.
|
void |
setForceGlobal(boolean val)
When true, the picker will not be restricted to the current Application
e.g.
|
void |
setHeaderText(java.lang.String headerText)
Sets the translatable string to be used in the header for this dialog.
|
void |
setHelpID(java.lang.String helpID)
Sets string to be used as the help ID for the dialog
|
void |
setLabel(java.lang.String label)
Sets the label (optional) for the radio buttons to select the provider
type.
|
void |
setOnlyShowProjectDependencies(boolean val)
When true, a project list will only show dependent projects
|
void |
setOtherProvider(DBObjectProvider otherProvider)
Set the other provider to use when initializing the chooser
so that if a provider is created it can match the other provider type.
|
void |
setPickerListener(DBObjectProviderPicker.PickerListener pickerListener)
Sets an optional listener to attach to the picker before it is
initialized.
|
void |
setPickerValidator(DBObjectProviderPicker.PickerValidator pickerValidator)
Sets an optional validator to check the selected provider.
|
void |
setPrompt(java.lang.String prompt)
Sets the translatable string to be used as the prompt for the
DBObjectProvider picker UI component.
|
void |
setProviderTypes(java.lang.String... providerTypes)
The type of each DBObjectProvider to be offered for selection.
|
void |
setShowDetails(boolean val)
Determines whether the picker should include a details section underneath
showing important properties of the chosen provider.
|
void |
setTitle(java.lang.String title)
Sets the translatable string to be used in the title bar for this dialog.
|
boolean |
shouldDisablePickerForDefaultProvider()
Returns whether the picker should be disabled when the default
provider specified in the configuation is visible.
|
public Context getContext()
If no Context has been set this will return a new IDE Context.
public java.lang.String getTitle()
public void setTitle(java.lang.String title)
title
- the title textpublic java.lang.String getHeaderText()
public void setHeaderText(java.lang.String headerText)
headerText
- the header text, or blank or null if no header is
to be created.public java.lang.String getPrompt()
See getLabel()
public void setPrompt(java.lang.String prompt)
See getLabel()
prompt
- the text for the promptpublic java.lang.String getHelpID()
public void setHelpID(java.lang.String helpID)
helpID
- the help IDpublic void setContext(Context context)
public boolean getForceGlobal()
#canBeglobal(String)
which
allows finer control over the individual pickers in a multi-provider
picker. For example, it is legal to reverse engineer DBObjects from and
offline database in another application, but it is not legal to
use a connection to an online database in another application.public boolean canBeGlobal(java.lang.String providerType)
public void setForceGlobal(boolean val)
public boolean getShowDetails()
public void setShowDetails(boolean val)
public void setAllowCreateProject(boolean val)
public boolean getAllowCreateProject()
public void setOnlyShowProjectDependencies(boolean val)
public boolean getOnlyShowProjectDependencies()
public boolean getAllowCreate()
public void setAllowCreate(boolean val)
public boolean getControlEnable()
public void setControlEnable(boolean val)
public boolean getAllowNull()
public void setAllowNull(boolean val)
public java.lang.String getLabel()
getControlEnable()
is true, this is the label for the check box.public void setLabel(java.lang.String label)
getControlEnable()
is true, this is the label for the check box.label
- the label for the radio button group that selects the
provider type or the label for the checkbox that enables/disables the
picker controls.public java.lang.String[] getProviderTypes()
public void setProviderTypes(java.lang.String... providerTypes)
public boolean shouldDisablePickerForDefaultProvider()
public void setDisablePickerForDefaultProvider(boolean disablePickerForDefault)
disablePickerForDefault
- if true, when the default provider is
visible, the picker UI is disabled.public void setCanBeGlobal(java.lang.String providerType, boolean value)
public DBObjectProviderID getDefaultProviderID()
public void setDefaultProviderID(DBObjectProviderID defaultProviderID)
public void setControlEnableListener(java.awt.event.ActionListener controlEnableListener)
public java.awt.event.ActionListener getControlEnableListener()
public DBObjectProviderPicker.PickerListener getPickerListener()
public void setPickerListener(DBObjectProviderPicker.PickerListener pickerListener)
public DBObjectProvider getOtherProvider()
public void setOtherProvider(DBObjectProvider otherProvider)
public DBObjectProviderPicker.PickerValidator getPickerValidator()
public void setPickerValidator(DBObjectProviderPicker.PickerValidator pickerValidator)
public java.lang.String[] getDatabaseTypes()
public void setDatabaseTypes(java.lang.String... databaseTypes)