oracle.ide.db.controls

Class DBObjectProviderPicker.PickerConfiguration

java.lang.Object

oracle.ide.db.controls.DBObjectProviderPicker.PickerConfiguration

Enclosing class:

DBObjectProviderPicker

public static class DBObjectProviderPicker.PickerConfiguration
extends java.lang.Object

Configuration class that allows control over the options for the DBObjectProviderPicker returned by DBObjectProviderPicker.getPicker(oracle.ide.db.controls.DBObjectProviderPicker.PickerConfiguration).

Constructor Summary

Constructors

Constructor and Description
PickerConfiguration()

Method Summary

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PickerConfiguration

public PickerConfiguration()

Method Detail

getContext

public Context getContext()

Gets the Ide context for the picker. This is used to help decide the available types of DBObjectProvider and for the default value to put in the Picker.

If no Context has been set this will return a new IDE Context.

getTitle

public java.lang.String getTitle()

Translatable string to be used in the title bar for the dialog.

Returns:

the dialog title text

setTitle

public void setTitle(java.lang.String title)

Sets the translatable string to be used in the title bar for this dialog.

Parameters:

title - the title text

getHeaderText

public java.lang.String getHeaderText()

Translatable string to be used in the header for the dialog. If null or blank, no header will be created.

Returns:

the header text

setHeaderText

public void setHeaderText(java.lang.String headerText)

Sets the translatable string to be used in the header for this dialog.

Parameters:

headerText - the header text, or blank or null if no header is to be created.

getPrompt

public java.lang.String getPrompt()

Translatable string to be used as the prompt for the DBObjectProvider picker UI component. If set, this will appear above the picker UI.

See getLabel()

Returns:

the prompt

setPrompt

public void setPrompt(java.lang.String prompt)

Sets the translatable string to be used as the prompt for the DBObjectProvider picker UI component. If set, this will appear above the picker UI.

See getLabel()

Parameters:

prompt - the text for the prompt

getHelpID

public java.lang.String getHelpID()

String to be used as the help ID for the dialog.

Returns:

the helpID

setHelpID

public void setHelpID(java.lang.String helpID)

Sets string to be used as the help ID for the dialog

Parameters:

helpID - the help ID

setContext

public void setContext(Context context)

Gets the Ide context for the picker. This is used to help decide the available types of DBObjectProvider and for the default value to put in the Picker.

getForceGlobal

public boolean getForceGlobal()

When true, the picker will not be restricted to the current Application e.g. for database connections a global connection picker will be used. This method has been superceded by #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.

canBeGlobal

public boolean canBeGlobal(java.lang.String providerType)

Return true if the chooser for the specified provider type can be global. This may be because all the pickers can be global, or because the particular provider type can be global.

setForceGlobal

public void setForceGlobal(boolean val)

When true, the picker will not be restricted to the current Application e.g. for database connections a global connection picker will be used.

getShowDetails

public boolean getShowDetails()

Determines whether the picker should include a details section underneath showing important properties of the chosen provider.

setShowDetails

public void setShowDetails(boolean val)

Determines whether the picker should include a details section underneath showing important properties of the chosen provider.

setAllowCreateProject

public void setAllowCreateProject(boolean val)

When true, the widget will allow the creation of new projects if relevant.

getAllowCreateProject

public boolean getAllowCreateProject()

When true, the widget will allow the creation of new projects if relevant.

setOnlyShowProjectDependencies

public void setOnlyShowProjectDependencies(boolean val)

When true, a project list will only show dependent projects

getOnlyShowProjectDependencies

public boolean getOnlyShowProjectDependencies()

When true, a project list will only show dependent projects

getAllowCreate

public boolean getAllowCreate()

When true, the widget will allow the creation of new providers.

setAllowCreate

public void setAllowCreate(boolean val)

When true, the widget will allow the creation of new providers.

getControlEnable

public boolean getControlEnable()

When true, the widget will show a check box which will enable/disable the rest of the picker controls.

setControlEnable

public void setControlEnable(boolean val)

When true, the widget will show a check box which will enable/disable the rest of the picker controls.

getAllowNull

public boolean getAllowNull()

When true, the widget will add a null option

setAllowNull

public void setAllowNull(boolean val)

When true, the widget will add a null option

getLabel

public java.lang.String getLabel()

Returns the label (optional) for the radio buttons to select the provider type. The label is displayed inline with the radio buttons. When getControlEnable() is true, this is the label for the check box.

Returns:

the label for the radio button group that selects the provider type or the label for the checkbox that enables/disables the picker controls.

setLabel

public void setLabel(java.lang.String label)

Sets the label (optional) for the radio buttons to select the provider type. The label is displayed inline with the radio buttons. When getControlEnable() is true, this is the label for the check box.

Parameters:

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.

getProviderTypes

public java.lang.String[] getProviderTypes()

The type of each DBObjectProvider to be offered for selection. Example provider types are "db" which is constant Database.PROVIDER_TYPE and "offlinedb" which is constant OfflineDBObjectProvider.PROVIDER_TYPE.

setProviderTypes

public void setProviderTypes(java.lang.String... providerTypes)

The type of each DBObjectProvider to be offered for selection. Example provider types are "db" which is constant Database.PROVIDER_TYPE and "offlinedb" which is constant OfflineDBObjectProvider.PROVIDER_TYPE.

shouldDisablePickerForDefaultProvider

public boolean shouldDisablePickerForDefaultProvider()

Returns whether the picker should be disabled when the default provider specified in the configuation is visible. This can be useful in the multi-provider UI, if the user is to be prevented from changing the provider for the default provider type.

Returns:

the disabled types

setDisablePickerForDefaultProvider

public void setDisablePickerForDefaultProvider(boolean disablePickerForDefault)

Sets whether to disable the picker when the default provider specified in the configuration is visible. This can be useful in the multi-provider UI, if the user is to be prevented from changing the provider for the default provider type.

Parameters:

disablePickerForDefault - if true, when the default provider is visible, the picker UI is disabled.

setCanBeGlobal

public void setCanBeGlobal(java.lang.String providerType,
                           boolean value)

Set whether or not the corresponding ProviderType can be global.

getDefaultProviderID

public DBObjectProviderID getDefaultProviderID()

The picker may use this to initialize

setDefaultProviderID

public void setDefaultProviderID(DBObjectProviderID defaultProviderID)

Set the details of the provider that should be initially selected.

setControlEnableListener

public void setControlEnableListener(java.awt.event.ActionListener controlEnableListener)

Sets an optional additional listener for the 'enable' control.

getControlEnableListener

public java.awt.event.ActionListener getControlEnableListener()

Gets the listener for the 'enable' control of the picker.

getPickerListener

public DBObjectProviderPicker.PickerListener getPickerListener()

Gets the listener the picker should be initialized with.

setPickerListener

public void setPickerListener(DBObjectProviderPicker.PickerListener pickerListener)

Sets an optional listener to attach to the picker before it is initialized.

getOtherProvider

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

setOtherProvider

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

getPickerValidator

public DBObjectProviderPicker.PickerValidator getPickerValidator()

Gets the validator to check the selected provider (can be null).

setPickerValidator

public void setPickerValidator(DBObjectProviderPicker.PickerValidator pickerValidator)

Sets an optional validator to check the selected provider.

getDatabaseTypes

public java.lang.String[] getDatabaseTypes()

Gets the allowed "database types" for the providers that should be listed for choosing.

Returns:

the allowed database types

setDatabaseTypes

public void setDatabaseTypes(java.lang.String... databaseTypes)

Sets the allowed "database types" for the providers that should be listed for choosing. The filtering is not guaranteed, not all pickers can always filter all types - for example if a database chooser needs to connect to the db in order to filter, the filter will be ignored.