oracle.ide.db.panels

Class PanelLibrary.DelegatePanelLibrary<T extends DBObject>

java.lang.Object

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

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

Enclosing class:

PanelLibrary<T extends DBObject>

public static class PanelLibrary.DelegatePanelLibrary<T extends DBObject>
extends PanelLibrary<T>

Allows the creation of a PanelLibrary that can delegate all the panel logic to an underlying PanelLibrary and then override other specifics as required.

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ide.db.panels.PanelLibrary

PanelLibrary.DelegatePanelLibrary<T extends DBObject>, PanelLibrary.HeaderPanel, PanelLibrary.HeaderPanelListener, PanelLibrary.PanelSetChanger, PanelLibrary.PanelSetChangeValidator

Field Summary

Fields inherited from class oracle.ide.db.panels.PanelLibrary

COMMIT_TO_PROVIDER_KEY, KEY

Constructor Summary

Constructors

Constructor and Description
DelegatePanelLibrary(PanelLibrary<T> delegate)

Method Summary

Modifier and Type	Method and Description
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.
protected java.lang.Class<? extends Traversable>	getDDLPanel()
protected java.lang.String	getGeneralHelpID() Gets the help ID for the general panel.
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.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.
java.lang.String	getStartPage(DBEditorConfig config) Returns the page of the editor to start from.
protected 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.
protected java.util.Map<java.lang.String,java.lang.Class>	getVerifiers(boolean editing)
protected T	newDBObject(DBObjectProvider pro, Schema schema, DBObject parent) Returns a new DBObject instance for the type of object this library supports.
boolean	prepareEditorInBackground(DBEditorConfig config) Called by the DBEditorFactory implementation to test whether the prepare of the editor should be done in the background, rather than on the EDT.
void	prepareObjectForEditor(DBEditorConfig config, java.util.List<Navigable> navs) Called just before the editor for the given config will be shown.
protected void	prepareObjectForNavigable(DBEditorConfig config, Navigable nav) Called to ensure that the given object is built sufficiently for display of the given Navigable.
boolean	showEditorAfterCommit() Tests whether the IDE Editor for the object should be shown after any commit.

Methods inherited from class oracle.ide.db.panels.PanelLibrary

addDefaultPanels, addNavigable, addPanel, addPanel, addSupportedTitle, addSupportedTitle, canEditObject, canReplaceByDefault, checkPrivilege, ensurePanels, ensureSimplePanels, getCreateNavigables, getCreateText, getCreateTitle, getCreateVerifiers, getDDLNavigable, getDefaultPanels, getEditNavigables, getEditTitle, getEditVerifiers, getErrorTitle, getGeneralNavigable, getHeaderHelpID, getInitialFocus, getLogger, getMainDialogPanel, getMainDialogPanel, getNamesToExclude, getNavigables, getNavigables, getObjectForCreate, getSimpleNavigables, getSkipGeneralForNewObject, getStartPage, getType, getUniqueName, getValidationLevel, includePanelHeaders, makeNameUnique, setContextObject, setDefaultPanels, setDefaultPanels, shouldResetObjectBeforeEdit, shouldValidateOnExit

Methods inherited from class java.lang.Object

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

Constructor Detail

DelegatePanelLibrary

public DelegatePanelLibrary(PanelLibrary<T> delegate)

Method Detail

getTitles

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

Description copied from class: PanelLibrary

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.

Specified by:

getTitles in class PanelLibrary<T extends DBObject>

createMainPanel

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

Description copied from class: PanelLibrary

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.

Overrides:

createMainPanel in class PanelLibrary<T extends DBObject>

getHeader

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

Description copied from class: PanelLibrary

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

Overrides:

getHeader in class PanelLibrary<T extends DBObject>

getSimpleTitles

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

Description copied from class: PanelLibrary

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

Overrides:

getSimpleTitles in class PanelLibrary<T extends DBObject>

getSize

public java.awt.Dimension getSize(boolean edit)

Description copied from class: PanelLibrary

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.

Overrides:

getSize in class PanelLibrary<T extends DBObject>

showEditorAfterCommit

public boolean showEditorAfterCommit()

Description copied from class: PanelLibrary

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

Overrides:

showEditorAfterCommit in class PanelLibrary<T extends DBObject>

Returns:

commitToProvider

public void commitToProvider(DBEditorConfig config)

Description copied from class: PanelLibrary

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

Overrides:

commitToProvider in class PanelLibrary<T extends DBObject>

getStartPage

public java.lang.String getStartPage(DBEditorConfig config)

Description copied from class: PanelLibrary

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.

Overrides:

getStartPage in class PanelLibrary<T extends DBObject>

Returns:

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

getVerifiers

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

Overrides:

getVerifiers in class PanelLibrary<T extends DBObject>

newDBObject

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

Description copied from class: PanelLibrary

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

Overrides:

newDBObject in class PanelLibrary<T extends DBObject>

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.

getGeneralHelpID

protected java.lang.String getGeneralHelpID()

Description copied from class: PanelLibrary

Gets the help ID for the general panel.

Overrides:

getGeneralHelpID in class PanelLibrary<T extends DBObject>

See Also:

#getGeneralTraversable()

getGeneralTitles

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

Description copied from class: PanelLibrary

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

Overrides:

getGeneralTitles in class PanelLibrary<T extends DBObject>

getDDLPanel

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

Overrides:

getDDLPanel in class PanelLibrary<T extends DBObject>

prepareEditorInBackground

public boolean prepareEditorInBackground(DBEditorConfig config)

Description copied from class: PanelLibrary

Called by the DBEditorFactory implementation to test whether the prepare of the editor should be done in the background, rather than on the EDT. Return true if there could be any hit to the database, or any derived properties build to configure the editor (e.g. getting the panel titles etc).

This is called on the EDT, so it is important that any checks on the config done by this method do not cause any db hits.

Overrides:

prepareEditorInBackground in class PanelLibrary<T extends DBObject>

Parameters:

config - the config for the editor we are going to prepare

Returns:

true to prepare the editor off of the EDT (in a progress bar)

prepareObjectForEditor

public void prepareObjectForEditor(DBEditorConfig config,
                                   java.util.List<Navigable> navs)
                            throws DBException

Description copied from class: PanelLibrary

Called just before the editor for the given config will be shown. Importantly this is called on the background Thread if PanelLibrary.prepareEditorInBackground(oracle.ide.db.dialogs.DBEditorConfig) returns true.

This mechanism should be used to ensure that any properties required for the default editor state (e.g. start page) are built.

Overrides:

prepareObjectForEditor in class PanelLibrary<T extends DBObject>

Parameters:

config - the editor config we are about to launch the editor for

navs - the navigables that have been chosen already for the editor by this panel library.

Throws:

CancelledException - if the prepare is interrupted

DBException - if the object cannot be prepared. This will stop the editor being shown and the exception message will be shown to the user.

prepareObjectForNavigable

protected void prepareObjectForNavigable(DBEditorConfig config,
                                         Navigable nav)
                                  throws DBException

Description copied from class: PanelLibrary

Called to ensure that the given object is built sufficiently for display of the given Navigable. This is only called if #isCallPrepareObjectForNavigable returns true (default is edit only) and is called on a background Thread if PanelLibrary.prepareEditorInBackground(oracle.ide.db.dialogs.DBEditorConfig) returns true.

Overrides:

prepareObjectForNavigable in class PanelLibrary<T extends DBObject>

Parameters:

config - the editor config

nav - the navigable that is about to show

Throws:

CancelledException - if the prepare is interrupted

DBException - if the object cannot be prepared. This will stop the editor being shown and the exception message will be shown to the user.