oracle.jdeveloper.offlinedb.wizard
Class SchemaChooserWizard

java.lang.Object
  oracle.ide.wizard.Wizard
      oracle.jdeveloper.offlinedb.wizard.SchemaChooserWizard

public class SchemaChooserWizard
extends Wizard

Simple dialog for choosing an existing offline schema from a given context. The user is presented with a single editable combobox. If an unrecognized schema name is entered, a new schema is created.

Since:

release specific (what release of product did this appear in)

Nested Class Summary

static interface

SchemaChooserWizard.Result Public interface for the result of displaying the UI.

Field Summary

static java.lang.String

HELP_SCHEMA_INFO

Constructor Summary

SchemaChooserWizard()

Method Summary

static SchemaChooserWizard.Result	chooseSchema(Context context) Shows UI for choosing an offline schema from the given context
static SchemaChooserWizard.Result	chooseSchema(Context context, OfflineDBObjectProvider provider) Shows UI for choosing an offline schema from the given context
static SchemaChooserWizard.Result	chooseSchema(Context context, OfflineDBObjectProvider provider, Schema defaultSchema) Shows UI for choosing an offline schema from the given context
javax.swing.Icon	getIcon() Gets the Icon to use in the Object Gallery.
java.lang.String	getLongLabel() Provides a description of the Wizard that appears in the hint text area of the Object Gallery.
java.lang.String	getShortLabel() Provides the label that represents the Wizard in the Object Gallery.
boolean	invoke(Context context) Invokes the wizard.
boolean	isAvailable(Context context) Called when the sensitivity of the menu item that opens this wizard must be determined.

Methods inherited from class oracle.ide.wizard.Wizard

getLegacyParams, getMenuSpecification, getToolTipText, setLegacyParams, toString

Methods inherited from class java.lang.Object

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

Field Detail

HELP_SCHEMA_INFO

public static final java.lang.String HELP_SCHEMA_INFO

See Also:

Constant Field Values

Constructor Detail

SchemaChooserWizard

public SchemaChooserWizard()

Method Detail

chooseSchema

public static final SchemaChooserWizard.Result chooseSchema(Context context)

Shows UI for choosing an offline schema from the given context

Parameters:

context - the context

Returns:

a Result object containing the schema and whether the dialog was cancelled or not. Note that the user is allowed to OK a null schema.

chooseSchema

public static final SchemaChooserWizard.Result chooseSchema(Context context,
                                                            OfflineDBObjectProvider provider)

Shows UI for choosing an offline schema from the given context

Parameters:

context - the context

provider - the provider, if different from the one in the context

Returns:

a Result object containing the schema and whether the dialog was cancelled or not. Note that the user is allowed to OK a null schema.

chooseSchema

public static final SchemaChooserWizard.Result chooseSchema(Context context,
                                                            OfflineDBObjectProvider provider,
                                                            Schema defaultSchema)

Shows UI for choosing an offline schema from the given context

Parameters:

context - the context

provider - the provider, if different from the one in the context

defaultSchema - the schema to be initially selected

Returns:

a Result object containing the schema and whether the dialog was cancelled or not. Note that the user is allowed to OK a null schema.

getLongLabel

public java.lang.String getLongLabel()

Description copied from class: Wizard

Provides a description of the Wizard that appears in the hint text area of the Object Gallery. This is usually a verb phrase starting with "Creates a...". The default implementation uses a format string for "Creates a new ____", filling in the blank with the value from Wizard.getShortLabel().

Overrides:

getLongLabel in class Wizard

getShortLabel

public java.lang.String getShortLabel()

Description copied from class: Wizard

Provides the label that represents the Wizard in the Object Gallery. The label should be a noun or noun phrase naming the item that is created by this Wizard and should omit the word "new". Examples: "Java Class", "Java Interface", "XML Document", "Database Connection".

Specified by:

getShortLabel in class Wizard

Returns:

The human readable label of the Wizard.

invoke

public boolean invoke(Context context)

Description copied from class: Wizard

Invokes the wizard.

Specified by:

invoke in class Wizard

Parameters:

context - The context of the wizard. All parameters required by the wizard must be set on the context. The wizard may also return values to the caller by setting them into the Context for the caller to retrieve.

Returns:

true if the invocation was successful, false if it failed or was canceled.

isAvailable

public boolean isAvailable(Context context)

Description copied from class: Wizard

Called when the sensitivity of the menu item that opens this wizard must be determined.

Specified by:

isAvailable in class Wizard

Parameters:

context - The Context to use when invoking this Wizard.

Returns:

true if the wizard can be invoked, or false otherwise.

getIcon

public javax.swing.Icon getIcon()

Description copied from class: Wizard

Gets the Icon to use in the Object Gallery. If this Wizard is not accessed from the Object Gallery, the Wizard should return null.

Overrides:

getIcon in class Wizard

Returns:

The Icon to be displayed in the Object Gallery.