oracle.jdeveloper.offlinedb.panels

Class OfflineDBChooserPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

oracle.ide.panels.DefaultTraversablePanel

oracle.jdeveloper.offlinedb.panels.OfflineDBChooserPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, GridBagConstants, Traversable

public class OfflineDBChooserPanel
extends DefaultTraversablePanel

Traversable panel that allows the user to choose (or create) an Offline Database. It is configurable to additionally allow the user to choose (or create) an application and project as well.

By default the panel will place the chosen provider under the key UIConstants.PROVIDER_KEY when onExit is called.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OfflineDBChooserPanel.InfoListener Custom listener class for being notified of changes in the panel to the selected offline database.
class	OfflineDBChooserPanel.OfflineDatabaseInfo Encapsulates the information about the chosen offline database in this panel.

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface oracle.ide.controls.GridBagConstants

ANCHOR_C, ANCHOR_E, ANCHOR_N, ANCHOR_NE, ANCHOR_NW, ANCHOR_S, ANCHOR_SE, ANCHOR_SW, ANCHOR_W, FILL_NONE, FILL_X, FILL_XY, FILL_Y

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
OfflineDBChooserPanel() Constructs a new panel for choosing offline databases.

Method Summary

Methods

Modifier and Type	Method and Description
void	addOfflineDatabaseListener(java.awt.event.ItemListener il) Deprecated. replaced by addOfflineDatabaseListener(InfoListener)
void	addOfflineDatabaseListener(OfflineDBChooserPanel.InfoListener l) Add a listener to be informed of changes to the selected offline database.
java.awt.Component	getComponent() Gets the Component to include in any layout.
java.awt.Component	getDefaultFocusComponent() This panels choice for default focus.
OfflineDBChooserPanel.OfflineDatabaseInfo	getOfflineDatabaseInfo() Gets the current information from this panel.
OfflineDBObjectProvider	getOrCreateProvider() Gets the chosen provider.
protected java.lang.String	getProviderDataKey() Gets the key that the OfflineDBObjectProvider will be put under in the TraversableContext passed to onExit.
boolean	isAllowNull() Tests whether the offlinedb chooser contains a null entry
void	onEntry(TraversableContext data) Enter/initialises the panel with a chosen offline database and project/application if the extra pickers are shown.
void	onExit(TraversableContext data) Gets (or creates) the chosen offline database and puts it in the TravserableContext under the panel's data key.
void	removeOfflineDatabaseListener(java.awt.event.ItemListener il) Deprecated. replaced by removeOfflineDatabaseListener(InfoListener)
void	removeOfflineDatabaseListener(OfflineDBChooserPanel.InfoListener l) Add a listener to be informed of changes to the selected offline database.
void	setAllowApplicationCreate(boolean createApp) Sets whether to allow a new application to be created.
void	setAllowNull(boolean allowNull) Sets whether a null entry should appear in the picker for the offlinedb.
void	setAllowOfflineDatabaseCreate(boolean createOfflineDB) Sets whether to allow the user to create a new offline database in the current project.
void	setAllowOfflineDatabaseEdit(boolean editOfflineDB) Sets whether to allow the user to edit an offline database in the current project.
void	setAllowProjectCreate(boolean createProj) Sets whether to allow a new project to be created in the current application.
void	setDefaultSelection(OfflineDBObjectProvider defaultSelection)
void	setEditingProvider(java.net.URL url) Indicates that we are in the process of editing the given provider and therefore it should not appear in the picklist.
void	setEnabled(boolean enable)
void	setIncludeOfflineDatabasesFromDependentProjects(boolean incProjDeps) If ths project selector is not shown, this controls whether offline databases from dependent projects are shown in the offline database selector.
void	setIncludeProjectDependencies(boolean incProjDeps) Deprecated. this was badly named and has been replaced with setOnlyShowProjectDependencies(boolean)
void	setOnlineDatabase(Database db) Deprecated. use setOtherProvider(DBObjectProvider)
void	setOnlyShowProjectDependencies(boolean onlyShowProjDeps) Sets whether to only include dependent projects in the project picker.
void	setOtherOfflineProvider(OfflineDBObjectProvider otherOfflineProvider) Deprecated. no longer used.
void	setOtherProvider(DBObjectProvider pro) Sets another provider that this chooser will use to match if it creates a new offline database.
void	setProvider(OfflineDBObjectProvider provider)
void	setProviderLike(ProviderSettings likePro) Sets a provider to filter the provider list by.
void	setShowApplications(boolean showApp) Sets whether to show the applications available in jdev.
void	setShowOfflineDatabaseDetail(boolean showOfflineDBDetail) Sets whether to include a component under the offline database picker to show the details of the selected offline database.
void	setShowProjects(boolean showProj) Set whether to show the projects available in the current application.

Methods inherited from class oracle.ide.panels.DefaultTraversablePanel

gbc, gbc, getDefaultTitle, getExitTransition, getHelpID, getText, setDefaultTitle, setHelpID

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

OfflineDBChooserPanel

public OfflineDBChooserPanel()

Constructs a new panel for choosing offline databases. The panel will be empty after construction, allowing the various options to be configured. If the panel is being used in a wizard or TDialog then the layout will occur automatically, to force the layout call getComponent().

Method Detail

addOfflineDatabaseListener

@Deprecated
public final void addOfflineDatabaseListener(java.awt.event.ItemListener il)

Deprecated. replaced by addOfflineDatabaseListener(InfoListener)

addOfflineDatabaseListener

public final void addOfflineDatabaseListener(OfflineDBChooserPanel.InfoListener l)

Add a listener to be informed of changes to the selected offline database.

removeOfflineDatabaseListener

@Deprecated
public final void removeOfflineDatabaseListener(java.awt.event.ItemListener il)

Deprecated. replaced by removeOfflineDatabaseListener(InfoListener)

removeOfflineDatabaseListener

public final void removeOfflineDatabaseListener(OfflineDBChooserPanel.InfoListener l)

Add a listener to be informed of changes to the selected offline database.

setDefaultSelection

public final void setDefaultSelection(OfflineDBObjectProvider defaultSelection)

setProvider

public final void setProvider(OfflineDBObjectProvider provider)

setShowApplications

public final void setShowApplications(boolean showApp)

Sets whether to show the applications available in jdev. false by default.

setAllowApplicationCreate

public final void setAllowApplicationCreate(boolean createApp)

Sets whether to allow a new application to be created. false by default.

setShowProjects

public final void setShowProjects(boolean showProj)

Set whether to show the projects available in the current application. true by default.

setOnlyShowProjectDependencies

public final void setOnlyShowProjectDependencies(boolean onlyShowProjDeps)

Sets whether to only include dependent projects in the project picker. Setting this to true will only show the project selector if dependencies exist, and hide the application selector. It will also turn off the ability to create a project.

setIncludeProjectDependencies

@Deprecated
public final void setIncludeProjectDependencies(boolean incProjDeps)

Deprecated. this was badly named and has been replaced with setOnlyShowProjectDependencies(boolean)

setIncludeOfflineDatabasesFromDependentProjects

public final void setIncludeOfflineDatabasesFromDependentProjects(boolean incProjDeps)

If ths project selector is not shown, this controls whether offline databases from dependent projects are shown in the offline database selector. This is true by default.

setProviderLike

public final void setProviderLike(ProviderSettings likePro)

Sets a provider to filter the provider list by. The available providers will only include those with a compatible database emulation, and will ommit the given provider.

setEditingProvider

public final void setEditingProvider(java.net.URL url)

Indicates that we are in the process of editing the given provider and therefore it should not appear in the picklist.

setOnlineDatabase

@Deprecated
public final void setOnlineDatabase(Database db)

Deprecated. use setOtherProvider(DBObjectProvider)

setOtherProvider

public final void setOtherProvider(DBObjectProvider pro)

Sets another provider that this chooser will use to match if it creates a new offline database.

setAllowProjectCreate

public final void setAllowProjectCreate(boolean createProj)

Sets whether to allow a new project to be created in the current application. false by default.

setAllowOfflineDatabaseCreate

public final void setAllowOfflineDatabaseCreate(boolean createOfflineDB)

Sets whether to allow the user to create a new offline database in the current project. true by default.

setAllowOfflineDatabaseEdit

public final void setAllowOfflineDatabaseEdit(boolean editOfflineDB)

Sets whether to allow the user to edit an offline database in the current project. false by default.

setShowOfflineDatabaseDetail

public final void setShowOfflineDatabaseDetail(boolean showOfflineDBDetail)

Sets whether to include a component under the offline database picker to show the details of the selected offline database. true by default.

setEnabled

public void setEnabled(boolean enable)

Overrides:

setEnabled in class javax.swing.JComponent

getComponent

public final java.awt.Component getComponent()

Gets the Component to include in any layout. This must be called before the panel will display, but it done implictly by onEntry.

Specified by:

getComponent in interface Traversable

Overrides:

getComponent in class DefaultTraversablePanel

Returns:

The UI Component that the user interacts with for creating or editing an object.

See Also:

Traversable.getComponent()

onEntry

public void onEntry(TraversableContext data)

Enter/initialises the panel with a chosen offline database and project/application if the extra pickers are shown.

Specified by:

onEntry in interface Traversable

Overrides:

onEntry in class DefaultTraversablePanel

Parameters:

data - the wizard's traversable context

See Also:

Traversable.onEntry(TraversableContext)

getOfflineDatabaseInfo

public final OfflineDBChooserPanel.OfflineDatabaseInfo getOfflineDatabaseInfo()

Gets the current information from this panel. This includes the offline database if one is chosen, or the name of a new offline database to be created.

Returns:

the current panel information

getOrCreateProvider

public final OfflineDBObjectProvider getOrCreateProvider()
                                                  throws TraversalException

Gets the chosen provider. If this panel can create then a new OfflineDBObjectProvider will be created on disk.

Returns:

the chosen (or newly created) offline database

Throws:

TraversalException - if no provider has been chosen and a new provider cannot be created.

onExit

public void onExit(TraversableContext data)
            throws TraversalException

Gets (or creates) the chosen offline database and puts it in the TravserableContext under the panel's data key.

Specified by:

onExit in interface Traversable

Overrides:

onExit in class DefaultTraversablePanel

Parameters:

data - the wizard traversable context

Throws:

TraversalException - if a provider must be created and it fails

See Also:

Traversable.onExit(TraversableContext)

getProviderDataKey

protected java.lang.String getProviderDataKey()

Gets the key that the OfflineDBObjectProvider will be put under in the TraversableContext passed to onExit. Default is to return UIConstants.PROVIDER_KEY, override if required.

Returns:

the data key for the provider.

setOtherOfflineProvider

@Deprecated
public final void setOtherOfflineProvider(OfflineDBObjectProvider otherOfflineProvider)

Deprecated. no longer used.

getDefaultFocusComponent

public final java.awt.Component getDefaultFocusComponent()

This panels choice for default focus.

setAllowNull

public final void setAllowNull(boolean allowNull)

Sets whether a null entry should appear in the picker for the offlinedb.

Parameters:

allowNull - whether the user can choose null

isAllowNull

public final boolean isAllowNull()

Tests whether the offlinedb chooser contains a null entry

Returns:

whether the user can choose null