|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.0.0) E17493-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.ide.db.panels.PanelLibrary
public abstract class PanelLibrary
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.
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
Deprecated. use DBEditorConfig.isCommitToProvider() |
static java.lang.String |
KEY
Deprecated. use data.find( PanelLibrary.class ); |
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)
|
boolean |
canEditObject(DBObject 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(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. |
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. |
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 java.util.Map<java.lang.String,java.lang.Class> |
getVerifiers(boolean editing)
Returns the verifiers for creating or editing. |
void |
makeNameUnique(DBObject dbo,
Schema schema,
DBObjectProvider pro,
DBObject parent)
|
protected DBObject |
newDBObject(DBObjectProvider pro,
Schema schema,
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. |
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. |
protected void |
showEditor(DBEditorConfig config)
|
protected boolean |
showEditorAfterCommit()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
@Deprecated public static final java.lang.String KEY
@Deprecated public static final java.lang.String COMMIT_TO_PROVIDER_KEY
DBEditorConfig.isCommitToProvider()
Constructor Detail |
---|
protected PanelLibrary(java.lang.String type)
protected PanelLibrary(java.lang.String type, java.util.Map<java.lang.String,java.lang.String> helpIDs)
Method Detail |
---|
public java.lang.String getType()
public final void setDefaultPanels(Navigable[] navs)
BaseDBEditorFactory#initializeLibrary
,
setDefaultPanels(Navigable[],boolean)
public final void setDefaultPanels(Navigable[] navs, boolean alwaysAddDefaultPanels)
navs
- the navigables describing the default panelsalwaysAddDefaultPanels
- whether to always add the default panels,
even if the object's panel list is empty (getNavigables returned an empty
list).BaseDBEditorFactory#initializeLibrary
protected final Navigable[] getDefaultPanels(boolean edit)
protected final void addDefaultPanels(java.util.List<Navigable> navs, boolean edit)
protected java.lang.Class<? extends Traversable> getHeader()
public java.awt.Component getInitialFocus(Traversable mainPanel)
public final Traversable getMainDialogPanel(DBObject obj, DBObjectProvider pro, DBObject child, Navigable[] navs)
protected Traversable createMainPanel(Traversable header, Navigable[] navs, java.lang.String startPage)
public final java.util.List<Navigable> getCreateNavigables(DBObject obj, DBObjectProvider pro)
public final java.util.Map<java.lang.String,java.lang.Class> getCreateVerifiers()
public boolean canEditObject(DBObject obj, DBObjectProvider pro)
public final java.util.List<Navigable> getEditNavigables(DBObject obj, DBObjectProvider pro)
public final java.util.Map<java.lang.String,java.lang.Class> getEditVerifiers()
public final java.util.List<Navigable> getSimpleNavigables()
public final DBObject getObjectForCreate(Schema schema, DBObjectProvider pro, DBObject parent)
public final void makeNameUnique(DBObject dbo, Schema schema, DBObjectProvider pro, DBObject parent)
public void commitToProvider(DBEditorConfig config)
protected boolean showEditorAfterCommit()
protected void showEditor(DBEditorConfig config)
protected java.lang.String getUniqueName(java.lang.String type)
public java.lang.String getStartPage(DBObject child)
protected DBObject newDBObject(DBObjectProvider pro, Schema schema, DBObject parent)
the
- parent object for this object. can be null.protected abstract java.util.List<java.lang.String> getTitles(DBObject obj, DBObjectProvider pro, boolean editing)
protected java.util.Map<java.lang.String,java.lang.Class> getVerifiers(boolean editing)
protected java.util.List<java.lang.String> getSimpleTitles()
Returns null by default (no simple edit).
protected final Navigable addPanel(java.lang.String title, java.lang.Class clz, java.lang.String helpId)
protected final Navigable addPanel(java.lang.String title, java.lang.Class clz, java.lang.String helpId, java.lang.Class[] constructorSig, java.lang.Object[] constructorArgs)
protected final void addNavigable(java.lang.String title, Navigable n)
public java.awt.Dimension getSize(boolean edit)
public java.lang.String getCreateText()
public java.lang.String getCreateTitle()
public java.lang.String getEditTitle()
public boolean canReplaceByDefault()
public boolean shouldResetObjectBeforeEdit(DBEditorConfig config)
The default implementation returns true if the underlying provider doesn't support timestamps for the given object type.
public static void setBaseNamePrefix(java.lang.String baseNamePrefix)
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK 11g Release 2 (11.1.2.0.0) E17493-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |