oracle.ide.db.panels
Class PanelLibrary

java.lang.Object
  oracle.ide.db.panels.PanelLibrary

public abstract class PanelLibrary
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

static interface	PanelLibrary.HeaderPanel Interface to be implemented if a panel can effect a change to the panel set in a dialog.
static interface	PanelLibrary.HeaderPanelListener Interface that defines a listener for changes to the panel set.

Field Summary

static java.lang.String	COMMIT_TO_PROVIDER_KEY
static java.lang.String	KEY

Constructor Summary

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

protected void	addDefaultPanels(java.util.List<Navigable> navs, boolean edit)
protected void	addNavigable(java.lang.String title, Navigable n)
protected Navigable	addPanel(java.lang.String title, java.lang.Class clz, java.lang.String helpId)
protected Navigable	addPanel(java.lang.String title, java.lang.Class clz, java.lang.String helpId, java.lang.Class[] constructorSig, java.lang.Object[] constructorArgs)
protected Traversable	createMainPanel(Traversable header, Navigable[] navs, java.lang.String startPage)
java.util.List<Navigable>	getCreateNavigables(DBObject obj, DBObjectProvider pro) Returns the navigables to create the given object.
java.lang.String	getCreateText() Returns the text used to offer the option to create an object from this library (e.g.
abstract java.lang.String	getCreateTitle() Returns the title to use for the create dialog.
java.util.Map<java.lang.String,java.lang.Class>	getCreateVerifiers() Returns a map of verifier keys to classes for the creation of an object.
protected Navigable[]	getDefaultPanels(boolean edit) gets the default panels for this library.
java.util.List<Navigable>	getEditNavigables(DBObject obj, DBObjectProvider pro) Returns the navigables to edit the given object.
abstract java.lang.String	getEditTitle() Returns the title to use for the edit dialog.
java.util.Map<java.lang.String,java.lang.Class>	getEditVerifiers() Returns a map of verifier keys to classes for the edit of an object.
protected java.lang.Class<? extends Traversable>	getHeader() Returns the traversable class to use for the header component.
java.awt.Component	getInitialFocus(Traversable mainPanel) Get a component from the given main panel for the dialog to put the initial focus in.
Traversable	getMainDialogPanel(DBObject obj, DBObjectProvider pro, DBObject child, Navigable[] navs) Retruns the main panel to use in a dialog.
DBObject	getObjectForCreate(Schema schema, DBObjectProvider pro, DBObject parent) Returns an object ready to be created.
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.
java.lang.String	getStartPage(DBObject child) Returns the page of the editor to start from for the given child object.
protected abstract java.util.List<java.lang.String>	getTitles(DBObject 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) Returns a unique name for a new object of the given type.
protected abstract java.util.Map<java.lang.String,java.lang.Class>	getVerifiers(boolean editing) Returns the verifiers for creating or editing.
protected abstract DBObject	newDBObject(DBObject parent) Returns a new DBObject instance for the type of object this library supports.
static void	setBaseNamePrefix(java.lang.String baseNamePrefix)
void	setDefaultPanels(Navigable[] navs) Sets the default panels for this library.
void	setDefaultPanels(Navigable[] navs, boolean alwaysAddDefaultPanels) Sets the default panels for this library.

Methods inherited from class java.lang.Object

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

Field Detail

KEY

public static final java.lang.String KEY

See Also:

Constant Field Values

COMMIT_TO_PROVIDER_KEY

public static final java.lang.String COMMIT_TO_PROVIDER_KEY

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

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

protected final Navigable[] getDefaultPanels(boolean edit)

gets the default panels for this library. Typically this will be the panels held in m_defaultPanels, but this allows clients to override this behaviour.

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.

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(DBObject obj,
                                            DBObjectProvider pro,
                                            DBObject child,
                                            Navigable[] navs)

Retruns the main panel to use in a dialog.

createMainPanel

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

getCreateNavigables

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

Returns the navigables to create the given object.

getCreateVerifiers

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

Returns a map of verifier keys to classes for the creation of an object.

getEditNavigables

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

Returns the navigables to edit the given object.

getEditVerifiers

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

Returns a map of verifier keys to classes for the edit of an object.

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

getUniqueName

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

Returns a unique name for a new object of the given type.

getStartPage

public java.lang.String getStartPage(DBObject child)

Returns the page of the editor to start from for the given child object. Returns null by default - override for multi-page editors.

newDBObject

protected abstract DBObject newDBObject(DBObject parent)

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

Parameters:

the - parent object for this object. can be null.

getTitles

protected abstract java.util.List<java.lang.String> getTitles(DBObject 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.

getVerifiers

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

Returns the verifiers for creating or editing.

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

addPanel

protected final Navigable addPanel(java.lang.String title,
                                   java.lang.Class clz,
                                   java.lang.String helpId)

addPanel

protected final Navigable addPanel(java.lang.String title,
                                   java.lang.Class clz,
                                   java.lang.String helpId,
                                   java.lang.Class[] constructorSig,
                                   java.lang.Object[] constructorArgs)

addNavigable

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

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 abstract java.lang.String getCreateTitle()

Returns the title to use for the create dialog.

getEditTitle

public abstract java.lang.String getEditTitle()

Returns the title to use for the edit dialog.

setBaseNamePrefix

public static void setBaseNamePrefix(java.lang.String baseNamePrefix)