oracle.ide.db.panels

Class PanelLibrary<T extends DBObject>

java.lang.Object

oracle.ide.db.panels.PanelLibrary<T>

Direct Known Subclasses:

PanelLibrary.DelegatePanelLibrary

public abstract class PanelLibrary<T extends DBObject>
extends java.lang.Object

A panel library is a way that a list of wizard/dialog panels can be built up generically, and a set of Steps or Navigables - flat or nested can be retrieved. This allows there to be one source of truth for the panels available for a given object.

Since:

11.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PanelLibrary.DelegatePanelLibrary<T extends DBObject> Allows the creation of a PanelLibrary that can delegate all the panel logic to an underlying PanelLibrary and then override other specifics as required.
static interface	PanelLibrary.HeaderPanel Deprecated. replaced by PanelSetChangeValidator
static interface	PanelLibrary.HeaderPanelListener Deprecated. replaced by PanelSetChanger
static class	PanelLibrary.PanelSetChanger If a PanelSetChanger is in the TraversableContext then it can be used to change the set of panels in the current editor.
static class	PanelLibrary.PanelSetChangeValidator Optional callback validation mechanism when a panel set change is made.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMIT_TO_PROVIDER_KEY Deprecated. use DBEditorConfig.isCommitToProvider()
static java.lang.String	KEY Deprecated. use data.find( PanelLibrary.class );

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PanelLibrary(java.lang.String type)
protected	PanelLibrary(java.lang.String type, java.util.Map<java.lang.String,java.lang.String> helpIDs) Allows the customisation of help IDs from the default set held by this library.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addDefaultPanels(java.util.List<Navigable> navs, boolean edit)
protected void	addNavigable(java.lang.String title, Navigable n, java.lang.String... properties) Adds a new panel to this library.
protected Navigable	addPanel(java.lang.String title, java.lang.Class<? extends Traversable> clz, java.lang.String helpID, java.lang.Class[] constructorSig, java.lang.Object[] constructorArgs, java.lang.String... properties) Adds a new panel to this library and returns the resulting Navigable.
protected Navigable	addPanel(java.lang.String title, java.lang.Class<? extends Traversable> clz, java.lang.String helpID, java.lang.String... properties) Adds a new panel to this library and returns the resulting Navigable.
protected void	addSupportedTitle(SystemObject obj, DBObjectProvider pro, java.lang.String[] propPaths, java.util.Collection<java.lang.String> titles, java.lang.String title) Deprecated. register the panel against its properties using addPanel and this is done automatically.
protected void	addSupportedTitle(SystemObject obj, DBObjectProvider pro, java.lang.String propPath, java.util.Collection<java.lang.String> titles, java.lang.String title) Deprecated. register the panel against its properties using addPanel and this is done automatically.
boolean	canEditObject(T obj, DBObjectProvider pro) Tests whether this panel library can edit the given object.
boolean	canReplaceByDefault() Tests whether it is ok to replace the object type for this panel library without prompting the user about possible data loss.
void	commitToProvider(DBEditorConfig config) The config must have a result of SUCCCESS set by this method for the dialog to be disposed of.
protected Traversable	createMainPanel(Traversable header, Navigable[] navs, java.lang.String startPage) Gets the main panel that contains all the navigable for the dialog.
java.util.List<Navigable>	getCreateNavigables(T obj, DBObjectProvider pro) Deprecated. use getNavigables(DBEditorConfig)
java.lang.String	getCreateText() Returns the text used to offer the option to create an object from this library (e.g.
java.lang.String	getCreateTitle() Returns the title to use for the create dialog.
java.util.Map<java.lang.String,java.lang.Class>	getCreateVerifiers() Deprecated. verifiers are no longer used, the provider's PropertyManager controls everything.
Navigable	getDDLNavigable() Gets the Navigable representing the DDL panel for this library.
protected java.lang.Class<? extends Traversable>	getDDLPanel()
Navigable[]	getDefaultPanels(boolean edit) Gets the default panels for this library.
java.util.List<Navigable>	getEditNavigables(T obj, DBObjectProvider pro) Deprecated. use #getNavigables(T,DBObjectProvider,boolean)
java.lang.String	getEditTitle() Returns the title to use for the edit dialog.
java.util.Map<java.lang.String,java.lang.Class>	getEditVerifiers() Deprecated. verifiers are no longer used, the provider's PropertyManager controls everything.
protected java.lang.String	getGeneralHelpID() Gets the help ID for the general panel.
Navigable	getGeneralNavigable(DBEditorConfig editorConfig) Gets the Navigable for the "General" panel/section in a flat editor.
java.util.Collection<java.lang.String>	getGeneralTitles() Given the list of available titles, this method returns the subset of those titles that should be included on the "General" page of a flat editor, rather than appearing on pages of their own.
protected java.lang.Class<? extends Traversable>	getHeader() Returns the traversable class to use for the header component.
protected java.lang.String	getHeaderHelpID() Gets the help ID for the header panel.
java.awt.Component	getInitialFocus(Traversable mainPanel) Get a component from the given main panel for the dialog to put the initial focus in.
protected java.util.logging.Logger	getLogger() Gets the Logger to use for any messages that are logged by this PanelLibrary.
Traversable	getMainDialogPanel(DBEditorConfig config, Navigable[] navs) Returns the main panel to use in an editor described by the given config.
Traversable	getMainDialogPanel(T obj, DBObjectProvider pro, DBObject child, Navigable[] navs) Deprecated. replaced by getMainDialogPanel(DBEditorConfig,Navigable[])
protected java.util.Set<java.lang.String>	getNamesToExclude(DBObjectProvider pro, DBObject contextObject)
protected java.util.Map<java.lang.String,Navigable>	getNavigables()
java.util.List<Navigable>	getNavigables(DBEditorConfig editorConfig) Gets the Navigables for the editor of the given object.
T	getObjectForCreate(Schema schema, DBObjectProvider pro, DBObject parent) Returns an object ready to be created.
protected java.util.Collection<java.lang.String>	getPropsRequiredForNavigables() Get properties (derived or otherwise) that are required to be built before determining the Navigables to to return from getNavigables(Collection<String>,DBObject,DBObjectProvider,boolean,boolean,boolean).
java.util.List<Navigable>	getSimpleNavigables() Returns the navigables for the simple edit mode of the dialog, or null if no simple edit is supported for this library.
protected java.util.List<java.lang.String>	getSimpleTitles() Returns the titles for simple editing.
java.awt.Dimension	getSize(boolean edit) Returns a size for the edit dialog to take by default.
boolean	getSkipGeneralForNewObject() Tests whether the "General" page should be "skipped" when an overview editor for a newly created object is first shown.
java.lang.String	getStartPage(DBEditorConfig config) Returns the page of the editor to start from.
java.lang.String	getStartPage(DBObject child) Deprecated. Replaced by getStartPage(DBEditorConfig).
protected abstract java.util.List<java.lang.String>	getTitles(T obj, DBObjectProvider pro, boolean editing) Returns the titles of the panels needed to create or edit the given object as appropriate.
java.lang.String	getType() Returns the object type this library provides panels for.
protected java.lang.String	getUniqueName(java.lang.String type) Deprecated. unqiue name is determined by the api
protected java.util.Map<java.lang.String,java.lang.Class>	getVerifiers(boolean editing) Deprecated. verifiers are no longer used, the provider's PropertyManager controls everything.
protected boolean	includePanelHeaders(DBEditorConfig editorConfig) Tests whether this panel library should include a header at the top of each panel with its title and icon (if defined).
void	makeNameUnique(DBObject dbo, Schema schema, DBObjectProvider pro, DBObject parent) It is expected that an new object created by getObjectForCreate(oracle.javatools.db.Schema, oracle.javatools.db.DBObjectProvider, oracle.javatools.db.DBObject) will be initialized by the provider's DBObjectFactory and therefore have a default name.
protected T	newDBObject(DBObjectProvider pro, Schema schema, DBObject parent) Returns a new DBObject instance for the type of object this library supports.
protected void	setContextObject(SchemaObject newObject, SchemaObject contextObject) Set the context object on the newly created SystemObject.
void	setDefaultPanels(Navigable[] navs) Sets the default panels for this library.
void	setDefaultPanels(Navigable[] navs, boolean alwaysAddDefaultPanels) Sets the default panels for this library.
boolean	shouldResetObjectBeforeEdit(DBEditorConfig config) If this method returns true the object to edit will be completely reset before the edit dialog is launched - so all of its properties will be required from the database.
boolean	shouldValidateOnExit(oracle.ideimpl.db.panels.BaseEditorPanel panel, Namespace dataContext) Tests whether the given panel should validate the objects and properties that are being edited on it when onExit is called, blocking the exit if the model is invalid.
boolean	showEditorAfterCommit() Tests whether the IDE Editor for the object should be shown after any commit.

Methods inherited from class java.lang.Object

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

Field Detail

KEY

@Deprecated
public static final java.lang.String KEY

Deprecated. use data.find( PanelLibrary.class );

COMMIT_TO_PROVIDER_KEY

@Deprecated
public static final java.lang.String COMMIT_TO_PROVIDER_KEY

Deprecated. use DBEditorConfig.isCommitToProvider()

See Also:

Constant Field Values

Constructor Detail

PanelLibrary

protected PanelLibrary(java.lang.String type)

PanelLibrary

protected PanelLibrary(java.lang.String type,
            java.util.Map<java.lang.String,java.lang.String> helpIDs)

Allows the customisation of help IDs from the default set held by this library.

Method Detail

getLogger

protected java.util.logging.Logger getLogger()

Gets the Logger to use for any messages that are logged by this PanelLibrary.

getType

public java.lang.String getType()

Returns the object type this library provides panels for.

setDefaultPanels

public final void setDefaultPanels(Navigable[] navs)

Sets the default panels for this library. The default panels are always included at the end of the panel list regardless of the object state, or whether we're creating or editing. By default the panels will not appear if the object create or edit has no panels defined.

See Also:

BaseDBEditorFactory#initializeLibrary, setDefaultPanels(Navigable[],boolean)

setDefaultPanels

public final void setDefaultPanels(Navigable[] navs,
                    boolean alwaysAddDefaultPanels)

Sets the default panels for this library. The default panels are always included at the end of the panel list regardless of the object state, or whether we're creating or editing.

Parameters:

navs - the navigables describing the default panels

alwaysAddDefaultPanels - whether to always add the default panels, even if the object's panel list is empty (getNavigables returned an empty list).

See Also:

BaseDBEditorFactory#initializeLibrary

getDefaultPanels

public Navigable[] getDefaultPanels(boolean edit)

Gets the default panels for this library.

See Also:

setDefaultPanels(Navigable[],boolean)

addDefaultPanels

protected final void addDefaultPanels(java.util.List<Navigable> navs,
                    boolean edit)

getHeader

protected java.lang.Class<? extends Traversable> getHeader()

Returns the traversable class to use for the header component. By default this is a simple name and schema editor.

getHeaderHelpID

protected java.lang.String getHeaderHelpID()

Gets the help ID for the header panel. The header panel appears at the top of the online dialogs, but also appears on its own in the simple create dialogs offline.

By default this returns getGeneralHelpID() as the header is shown on the general panel.

getGeneralHelpID

protected java.lang.String getGeneralHelpID()

Gets the help ID for the general panel.

See Also:

#getGeneralTraversable()

getGeneralNavigable

public final Navigable getGeneralNavigable(DBEditorConfig editorConfig)

Gets the Navigable for the "General" panel/section in a flat editor. Can return null if no General panel should be included in the flat editor.

getGeneralTitles

public java.util.Collection<java.lang.String> getGeneralTitles()

Given the list of available titles, this method returns the subset of those titles that should be included on the "General" page of a flat editor, rather than appearing on pages of their own.

The default implementation will return

1. A single title if only one is registered
2. "Comment" if it is registered
3. "Properties" if it is registered
4. else an empty list

getSkipGeneralForNewObject

public boolean getSkipGeneralForNewObject()

Tests whether the "General" page should be "skipped" when an overview editor for a newly created object is first shown.

By default this returns true if the only general title is "Comment".

Returns:

true to select the first nav after "General" for a new object.

getDDLPanel

protected java.lang.Class<? extends Traversable> getDDLPanel()

getDDLNavigable

public Navigable getDDLNavigable()

Gets the Navigable representing the DDL panel for this library. This can return null if there should be no DDL panel for the object type.

The default implementation uses getDDLPanel() and constructs a Navigable with the standard title ("DDL") and help id. You therefore only need to override this method to customize the title or help id.

getInitialFocus

public java.awt.Component getInitialFocus(Traversable mainPanel)

Get a component from the given main panel for the dialog to put the initial focus in. Do NOT return a disabled component because it'll make the dialog inaccessible by locking tab navigation.

Returns:

the default focus component for the given panel.

getMainDialogPanel

public final Traversable getMainDialogPanel(DBEditorConfig config,
                             Navigable[] navs)

Returns the main panel to use in an editor described by the given config.

getMainDialogPanel

@Deprecated
public final Traversable getMainDialogPanel(T obj,
                                        DBObjectProvider pro,
                                        DBObject child,
                                        Navigable[] navs)

Deprecated. replaced by getMainDialogPanel(DBEditorConfig,Navigable[])

createMainPanel

protected Traversable createMainPanel(Traversable header,
                          Navigable[] navs,
                          java.lang.String startPage)

Gets the main panel that contains all the navigable for the dialog. If this returns null, no dialog will be shown and the factory will go straight to calling commitToProvider.

includePanelHeaders

protected boolean includePanelHeaders(DBEditorConfig editorConfig)

Tests whether this panel library should include a header at the top of each panel with its title and icon (if defined).

By default this returns true for flat editor and false for dialogs.

Parameters:

editorConfig - the editor config

Returns:

true if a header should be included on all panels

getNavigables

public final java.util.List<Navigable> getNavigables(DBEditorConfig editorConfig)

Gets the Navigables for the editor of the given object. When calling this from an editor launcher make sure that the EditorType has been set on the config. This will add default panels, and the ddl panel as well if appropriate to the EditorType.

Parameters:

editorConfig - the launched editor config

Returns:

the navigables for the editor of this object

getCreateNavigables

@Deprecated
public final java.util.List<Navigable> getCreateNavigables(T obj,
                                                       DBObjectProvider pro)

Deprecated. use getNavigables(DBEditorConfig)

Returns the navigables to create the given object.

getCreateVerifiers

@Deprecated
public final java.util.Map<java.lang.String,java.lang.Class> getCreateVerifiers()

Deprecated. verifiers are no longer used, the provider's PropertyManager controls everything.

canEditObject

public boolean canEditObject(T obj,
                    DBObjectProvider pro)

Tests whether this panel library can edit the given object. Default is to return true if the object is of the right type. If overridden care must be taken not to build the object as this method is called by context menus.

To aid performance this method won't necessarily get passed the object itself, just a blank instance of the correct type.

getEditNavigables

@Deprecated
public final java.util.List<Navigable> getEditNavigables(T obj,
                                                     DBObjectProvider pro)

Deprecated. use #getNavigables(T,DBObjectProvider,boolean)

Returns the navigables to edit the given object.

getEditVerifiers

@Deprecated
public final java.util.Map<java.lang.String,java.lang.Class> getEditVerifiers()

Deprecated. verifiers are no longer used, the provider's PropertyManager controls everything.

getSimpleNavigables

public final java.util.List<Navigable> getSimpleNavigables()

Returns the navigables for the simple edit mode of the dialog, or null if no simple edit is supported for this library.

getObjectForCreate

public final T getObjectForCreate(Schema schema,
                   DBObjectProvider pro,
                   DBObject parent)

Returns an object ready to be created. The object type will match this library type and will set up in the given schema with a unique name and a temporary object id.

makeNameUnique

public final void makeNameUnique(DBObject dbo,
                  Schema schema,
                  DBObjectProvider pro,
                  DBObject parent)

It is expected that an new object created by getObjectForCreate(oracle.javatools.db.Schema, oracle.javatools.db.DBObjectProvider, oracle.javatools.db.DBObject) will be initialized by the provider's DBObjectFactory and therefore have a default name. This method ensures that the name is unique given any special requirements of the object type that the DBObjectFactory is unaware of (e.g. open pl/sql editors).

getNamesToExclude

protected java.util.Set<java.lang.String> getNamesToExclude(DBObjectProvider pro,
                                                DBObject contextObject)

commitToProvider

public void commitToProvider(DBEditorConfig config)

The config must have a result of SUCCCESS set by this method for the dialog to be disposed of.

showEditorAfterCommit

public boolean showEditorAfterCommit()

Tests whether the IDE Editor for the object should be shown after any commit.

Returns:

getUniqueName

@Deprecated
protected java.lang.String getUniqueName(java.lang.String type)

Deprecated. unqiue name is determined by the api

getStartPage

public java.lang.String getStartPage(DBEditorConfig config)

Returns the page of the editor to start from. This uses logic based on the following properties in the DBEditorConfig (if set) in the following order:

1. getStartPage - start on this page
2. getChildObject - start on the page that edits this object
3. getProperty - start on the page that edits this property

Assuming that all panels have been registered with the (root) property paths that they edit there should be no need to override.

Returns:

the page the editor should start on, or null to start on the default (first) page.

getStartPage

@Deprecated
public java.lang.String getStartPage(DBObject child)

Deprecated. Replaced by getStartPage(DBEditorConfig).

newDBObject

protected T newDBObject(DBObjectProvider pro,
            Schema schema,
            DBObject parent)

Returns a new DBObject instance for the type of object this library supports.

Parameters:

pro - The provider

schema - The owing schema if the new object is a SchemaObject

parent - The parent of a ChildDBObject, or where applicable, the context SystemObject (for example, the Table for an Index or Trigger)

Returns:

A new DBObject instance for the type of object this library supports.

setContextObject

protected void setContextObject(SchemaObject newObject,
                    SchemaObject contextObject)

Set the context object on the newly created SystemObject. The default is to set the parent if (and only if) newObject implements ChildDBObject. Subclass Panel Libraries can set the context object on the new object as applicable for the object type.

Parameters:

newObject - The newly created SchemaObject

contextObject - The context SchemaObject (for example the Table for a new Index or Trigger)

getTitles

protected abstract java.util.List<java.lang.String> getTitles(T obj,
                                         DBObjectProvider pro,
                                         boolean editing)

Returns the titles of the panels needed to create or edit the given object as appropriate. Returning null disables the given create or edit operation, returning an empty List will mean the operation is enabled and the dialog will be shown with just the default panels registered with the editor factory in question.

addSupportedTitle

@Deprecated
protected void addSupportedTitle(SystemObject obj,
                                DBObjectProvider pro,
                                java.lang.String propPath,
                                java.util.Collection<java.lang.String> titles,
                                java.lang.String title)

Deprecated. register the panel against its properties using addPanel and this is done automatically.

addSupportedTitle

@Deprecated
protected void addSupportedTitle(SystemObject obj,
                                DBObjectProvider pro,
                                java.lang.String[] propPaths,
                                java.util.Collection<java.lang.String> titles,
                                java.lang.String title)

Deprecated. register the panel against its properties using addPanel and this is done automatically.

getVerifiers

@Deprecated
protected java.util.Map<java.lang.String,java.lang.Class> getVerifiers(boolean editing)

Deprecated. verifiers are no longer used, the provider's PropertyManager controls everything.

getSimpleTitles

protected java.util.List<java.lang.String> getSimpleTitles()

Returns the titles for simple editing. If this method is overridden to return non-null an advanced header will be used and the panel set this list defines will make up the simple UI.

Returns null by default (no simple edit).

getPropsRequiredForNavigables

protected java.util.Collection<java.lang.String> getPropsRequiredForNavigables()

Get properties (derived or otherwise) that are required to be built before determining the Navigables to to return from getNavigables(Collection<String>,DBObject,DBObjectProvider,boolean,boolean,boolean).

addPanel

protected final Navigable addPanel(java.lang.String title,
                 java.lang.Class<? extends Traversable> clz,
                 java.lang.String helpID,
                 java.lang.String... properties)

Adds a new panel to this library and returns the resulting Navigable.

Parameters:

title - the title for the panel

clz - the traversable class for the panel

helpID - the f1 help topic for the panel

properties - the properties that this panel edits. These should be relative to the SystemObject this library edits.

Returns:

the Navigable created during the registration

addPanel

protected final Navigable addPanel(java.lang.String title,
                 java.lang.Class<? extends Traversable> clz,
                 java.lang.String helpID,
                 java.lang.Class[] constructorSig,
                 java.lang.Object[] constructorArgs,
                 java.lang.String... properties)

Adds a new panel to this library and returns the resulting Navigable.

Parameters:

title - the title for the panel

clz - the traversable class for the panel

helpID - the f1 help topic for the panel

constructorSig - the signature of the constructor to use on clz

constructorArgs - the args for the constructor to on clz

properties - the properties that this panel edits. These should be relative to the SystemObject this library edits.

Returns:

the Navigable created during the registration

addNavigable

protected final void addNavigable(java.lang.String title,
                Navigable n,
                java.lang.String... properties)

Adds a new panel to this library.

Parameters:

title - the title for the panel.

n - the navigable with the panel information.

properties - the properties that this panel edits. These should be relative to the SystemObject this library edits.

getNavigables

protected java.util.Map<java.lang.String,Navigable> getNavigables()

getSize

public java.awt.Dimension getSize(boolean edit)

Returns a size for the edit dialog to take by default. Returns null by default which means the dialog will take the standard ide edit dialog size.

getCreateText

public java.lang.String getCreateText()

Returns the text used to offer the option to create an object from this library (e.g. "New Table..." ). The text may contain a mnemonic.

getCreateTitle

public java.lang.String getCreateTitle()

Returns the title to use for the create dialog.

getEditTitle

public java.lang.String getEditTitle()

Returns the title to use for the edit dialog.

canReplaceByDefault

public boolean canReplaceByDefault()

Tests whether it is ok to replace the object type for this panel library without prompting the user about possible data loss.

shouldResetObjectBeforeEdit

public boolean shouldResetObjectBeforeEdit(DBEditorConfig config)

If this method returns true the object to edit will be completely reset before the edit dialog is launched - so all of its properties will be required from the database.

The default implementation returns true if the underlying provider doesn't support timestamps for the given object type.

shouldValidateOnExit

public boolean shouldValidateOnExit(oracle.ideimpl.db.panels.BaseEditorPanel panel,
                           Namespace dataContext)

Tests whether the given panel should validate the objects and properties that are being edited on it when onExit is called, blocking the exit if the model is invalid. Returns true by default.

Parameters:

panel - the panel that onExist has been called on

dataContext - the current data context

Returns:

true to ensure a valid model before allowing the user to exit.