Constructor and Description |
---|
ProviderWizard() |
Modifier and Type | Method and Description |
---|---|
static void |
addPanel(java.lang.String title,
java.lang.Class panel,
java.lang.String helpID)
Deprecated.
use extension.xml instead.
|
static OfflineDBObjectProvider |
chooseProvider(Context c,
boolean allowApplicationCreate,
boolean allowProjectCreate,
boolean allowProviderCreate)
Prompts the user to choose an offline database in the given Context,
optionally they can be allowed to create a new one.
|
static OfflineDBObjectProvider |
chooseProvider(Context c,
OfflineDBObjectProvider defaultSelection,
boolean allowApplicationCreate,
boolean allowProjectCreate,
boolean allowProviderCreate)
Prompts the user to choose an offline database in the given Context,
optionally they can be allowed to create a new one.
|
static OfflineDBObjectProvider |
chooseProvider(Project p,
boolean allowProviderCreate)
Prompts the user to choose an offline database in the given Project,
optionally they can be allowed to create a new one.
|
static OfflineDBObjectProvider |
chooseProvider(Project p,
boolean allowProviderCreate,
boolean onlyShowProjDeps)
Prompts the user to choose an offline database in the given Project,
optionally they can be allowed to create a new one.
|
static OfflineDBObjectProvider |
chooseProvider(Project p,
boolean allowProviderCreate,
DBObjectProvider pro)
Allow the user to choose an offline provider that is compatible with the
given provider settings from the given project (including its dependencies),
The supplied provider will be used as the base for the offline database.
|
static OfflineDBObjectProvider |
chooseProvider(Project p,
OfflineDBObjectProvider pro)
Allow the user to choose an offline provider that is compatible with the
given provider from the given project (including its dependencies).
|
static OfflineDBObjectProvider |
chooseProvider(Project p,
ProviderSettings settings,
java.net.URL url)
Allow the user to choose an offline provider that is compatible with the
given provider settings from the given project (including its dependencies).
|
static OfflineDBObjectProvider |
createProvider(Context c)
Launches the dialog to create a provider.
|
static OfflineDBObjectProvider |
createProvider(Context c,
java.lang.String name,
java.lang.String schema,
DatabaseDescriptor desc)
Launches the dialog to create a provider, based on supplied values
|
static OfflineDBObjectProvider |
createProvider(Project p,
ProviderSettings settings)
Creates a new offline database.
|
static OfflineDBObjectProvider |
createProvider(Project p,
java.lang.String name,
DBObjectProvider db)
Creates a new offline database.
|
static boolean |
editProvider(Context c)
Launches the editor on the provider in the given context.
|
static boolean |
editProvider(OfflineDBObjectProvider pro,
Context c)
Launches the editor on the provider in 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.
|
static void |
initialiseTemplates(Context c,
OfflineDBObjectProvider pro)
Called to handle the templates of a given offline database.
|
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.
|
static void |
removePanel(java.lang.String title)
Deprecated.
|
static void |
showMissingProviderError(Context c,
java.lang.String title)
Shows a dialog to the user letting them know that the .offlinedb file is
missing and we cannot continue without it.
|
getLegacyParams, getMenuSpecification, getToolTipText, getWizardId, setLegacyParams, setWizardId, toString
public boolean isAvailable(Context context)
Wizard
isAvailable
in class Wizard
context
- The Context
to use when invoking this
Wizard
.true
if the wizard can be invoked, or
false
otherwise.public java.lang.String getShortLabel()
Wizard
getShortLabel
in class Wizard
public javax.swing.Icon getIcon()
Wizard
Icon
to use in the Object Gallery. If this Wizard
is not accessed from the Object Gallery, the Wizard should return
null
.public java.lang.String getLongLabel()
Wizard
Wizard.getShortLabel()
.getLongLabel
in class Wizard
public boolean invoke(Context context)
Invokable
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.@Deprecated public static void addPanel(java.lang.String title, java.lang.Class panel, java.lang.String helpID)
@Deprecated public static void removePanel(java.lang.String title)
public static OfflineDBObjectProvider chooseProvider(Project p, boolean allowProviderCreate)
public static OfflineDBObjectProvider chooseProvider(Project p, OfflineDBObjectProvider pro)
public static OfflineDBObjectProvider chooseProvider(Project p, ProviderSettings settings, java.net.URL url)
public static OfflineDBObjectProvider chooseProvider(Project p, boolean allowProviderCreate, boolean onlyShowProjDeps)
public static OfflineDBObjectProvider chooseProvider(Context c, boolean allowApplicationCreate, boolean allowProjectCreate, boolean allowProviderCreate)
public static OfflineDBObjectProvider chooseProvider(Project p, boolean allowProviderCreate, DBObjectProvider pro)
public static OfflineDBObjectProvider chooseProvider(Context c, OfflineDBObjectProvider defaultSelection, boolean allowApplicationCreate, boolean allowProjectCreate, boolean allowProviderCreate)
public static boolean editProvider(Context c)
public static boolean editProvider(OfflineDBObjectProvider pro, Context c)
public static OfflineDBObjectProvider createProvider(Context c, java.lang.String name, java.lang.String schema, DatabaseDescriptor desc)
c
- an IdeContext, possibly taken from the Travesablecontextname
- the value to populate the set the name field in the provider dialogschema
- the value to populate the schema field in the provider dialogdesc
- the emulation to pick by defaultpublic static OfflineDBObjectProvider createProvider(Context c)
public static OfflineDBObjectProvider createProvider(Project p, java.lang.String name, DBObjectProvider db) throws DBException
p
- the project to contain the new offlinedbname
- the name of the new offline databasedb
- an optional provider that the new offline database's
emulation should matchDBException
- if the offline database couldn't be createdpublic static OfflineDBObjectProvider createProvider(Project p, ProviderSettings settings) throws DBException
p
- the project to contain the new offlinedbsettings
- the settings for the new database (must include a
name).DBException
- if the offline database couldn't be createdpublic static void showMissingProviderError(Context c, java.lang.String title)
c
- the current contexttitle
- the title for the resulting dialog (if null a default will be
used).public static void initialiseTemplates(Context c, OfflineDBObjectProvider pro)
c
- the current IDE contextpro
- the offline database to initialise the templates on