oracle.ide.db.controls

Class SchemaObjectTargetPicker

java.lang.Object

oracle.bali.ewt.shuttle.ListPicker

oracle.ide.db.controls.DBObjectListPicker

oracle.ide.db.controls.SchemaObjectTargetPicker

All Implemented Interfaces:

java.util.EventListener, javax.swing.event.DocumentListener, javax.swing.event.ListSelectionListener, oracle.bali.ewt.shuttle.ItemPicker, oracle.bali.ewt.shuttle.ShuttleListener, Traversable

public class SchemaObjectTargetPicker
extends DBObjectListPicker
implements javax.swing.event.DocumentListener, javax.swing.event.ListSelectionListener, oracle.bali.ewt.shuttle.ShuttleListener, Traversable

ItemPicker designed to be used as the target (right or to) picker in the shuttle on a SelectDBObjectsPanel.

Since:

10.1.3

Field Summary

Fields inherited from interface oracle.bali.ewt.shuttle.ItemPicker

PROPERTY_SELECTION

Constructor Summary

Constructors

Constructor and Description
SchemaObjectTargetPicker()
SchemaObjectTargetPicker(javax.swing.JList list)
SchemaObjectTargetPicker(NameController nameController)

Method Summary

Modifier and Type	Method and Description
boolean	addSelectedItems(java.awt.datatransfer.Transferable[] add) By default, unless overridden by subclasses, the objects themselves are added to the list picker.
void	changedUpdate(javax.swing.event.DocumentEvent e)
java.awt.Component	getComponent() Normally, the Traversable class will itself be the UI Component.
java.lang.Object	getExitTransition() Returns the exit transition that can be used by a Traversable-aware wizard.
java.lang.String	getHelpID() Returns the context-sensitive help topic ID to use for this Traversable.
javax.swing.JLabel	getLabel()
DBObjectProvider	getProvider() Returns the provider for this target picker.
void	insertUpdate(javax.swing.event.DocumentEvent e)
void	onEntry(TraversableContext tc) By default the SchemaObjectTargetPicker uses the TARGET_PROVIDER_KEY to find its provider.
void	onExit(TraversableContext tc) Will throw a TraversalException if the current edited name doesn't commit properly.
void	removeAllSelectableItems()
void	removeSelectedItems()
void	removeUpdate(javax.swing.event.DocumentEvent e)
void	setTitleControlBar(ControlBar bar)
void	setTitleLabel(javax.swing.JLabel label)
void	shuttleItemsMoved(oracle.bali.ewt.shuttle.ShuttleEvent p0)
void	shuttleItemsRemoved(oracle.bali.ewt.shuttle.ShuttleEvent p0)
void	shuttleItemsReordered(oracle.bali.ewt.shuttle.ShuttleEvent p0)
void	valueChanged(javax.swing.event.ListSelectionEvent e)

Methods inherited from class oracle.ide.db.controls.DBObjectListPicker

addDBObject, cachePath, canAcceptFlavors, createTransferable, filterForAdd, getListModel, getRenderer, getSelectionDataFlavors, setAcceptTypes, setRemoveOnShuttle

Methods inherited from class oracle.bali.ewt.shuttle.ListPicker

addActionListener, addPropertyChangeListener, deselectAll, dispose, dragEnter, dragExit, dragOver, drop, dropActionChanged, getAllSelectableItems, getComparator, getDnDComponent, getItemsSorted, getList, getSelectedItems, isItemSelected, isOkayToDrag, isOkayToDrop, isSelectableItemPresent, processDnDReorder, removeActionListener, removePropertyChangeListener, setItemsSorted, sortItems

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaObjectTargetPicker

public SchemaObjectTargetPicker()

SchemaObjectTargetPicker

public SchemaObjectTargetPicker(NameController nameController)

SchemaObjectTargetPicker

public SchemaObjectTargetPicker(javax.swing.JList list)

Method Detail

getLabel

public javax.swing.JLabel getLabel()

getComponent

public java.awt.Component getComponent()

Description copied from interface: Traversable

Normally, the Traversable class will itself be the UI Component. Therefore, getComponent() typically just returns this. In this situation the getComponent() method then is simply a means of avoiding a type cast.

In other cases, it would be useful to have the ability to return a different Component based on the contents of the TraversableContext that is passed to the Traversable.onEntry(TraversableContext) method. UI containers (e.g. property dialogs and wizards) that are designed to use the Traversable interface must call the Traversable.onEntry(TraversableContext) method before calling getComponent(). This allows a Traversable implementation to have the opportunity to configure the UI Component or even create a new one before it is displayed.

In either situation, the implementation should strive to return the same Component instance as often as possible rather than creating a new instance becaues the UI container will call this method frequently.

Specified by:

getComponent in interface oracle.bali.ewt.shuttle.ItemPicker

Specified by:

getComponent in interface Traversable

Overrides:

getComponent in class oracle.bali.ewt.shuttle.ListPicker

Returns:

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

addSelectedItems

public boolean addSelectedItems(java.awt.datatransfer.Transferable[] add)

Description copied from class: DBObjectListPicker

By default, unless overridden by subclasses, the objects themselves are added to the list picker.

Specified by:

addSelectedItems in interface oracle.bali.ewt.shuttle.ItemPicker

Overrides:

addSelectedItems in class DBObjectListPicker

removeSelectedItems

public void removeSelectedItems()

Specified by:

removeSelectedItems in interface oracle.bali.ewt.shuttle.ItemPicker

Overrides:

removeSelectedItems in class DBObjectListPicker

removeAllSelectableItems

public void removeAllSelectableItems()

Specified by:

removeAllSelectableItems in interface oracle.bali.ewt.shuttle.ItemPicker

Overrides:

removeAllSelectableItems in class DBObjectListPicker

onExit

public void onExit(TraversableContext tc)
            throws TraversalException

Will throw a TraversalException if the current edited name doesn't commit properly.

Specified by:

onExit in interface Traversable

Parameters:

tc - The data object where changes made in the UI should be copied so that the changes can be accessed by other Traversables.

Throws:

TraversalException - if the user has entered either incomplete, invalid, or inconsistent data. This exception prevents the property dialog or wizard from continuing and forces the user to stay on the current Traversable until the data entered is valid or the user cancels. The exception class itself is capable of carrying an error message that will be shown to the user. Refer to its javadoc for details.

onEntry

public void onEntry(TraversableContext tc)

By default the SchemaObjectTargetPicker uses the TARGET_PROVIDER_KEY to find its provider.

Specified by:

onEntry in interface Traversable

Parameters:

tc - The data wrapper where the Traversable locates the data that it needs to populate the UI.

getProvider

public DBObjectProvider getProvider()

Returns the provider for this target picker. Will return null if onEntry() hasn't been called yet.

getHelpID

public java.lang.String getHelpID()

Description copied from interface: Traversable

Returns the context-sensitive help topic ID to use for this Traversable. A null return value means that the Traversable implementation doesn't specify a help topic ID. However, there are other ways that a help topic ID could get associated with a Traversable.

Specifically, when a Traversable instance is created by a MetaTraversable such as Step or Navigable in the context of a Navigable container such as MDDPanel, TabbedPanel or FSMWizard, the help ID is searched according to the following order:

1. MetaTraversable.getHelpID()
2. Traversable.getHelpID(). This may lead into a recursion if the Traversable's Component is a nested Navigable container.
3. oracle.bali.ewt.help.HelpUtils.getHelpID( Traversable.getComponent() )
4. oracle.bali.ewt.help.HelpUtils.getHelpID(...) on the Navigable container itself.
5. null

The search returns the first non-null help ID encountered or else null if all possible sources of a help ID returned null.

Since a Navigable wraps a Traversable, and a Traversable wraps a Component, the priority order for determining the help ID is based on giving the outer-most wrapper the opportunity to override. The Navigable container has the lowest priority because containers such as MDDPanel, TabbedPanel, and FSMWizard don't normally have a help topic ID of their own, since help topics tend to be on a per page basis.

For most cases the recommended approach is to have the Traversable specify the help ID. However, when the same Traversable can be used in different contexts, then specifying or overriding the help ID from the MetaTraversable could be better, especially if that avoids the need for conditional logic in Traversable.getHelpID(). If no dynamic behavior is needed in determining the help ID, then the implementation can probably just subclass DefaultTraversablePanel and call the DefaultTraversablePanel.setHelpID(String) method from the subclass constructor.

The getHelpID() method is called only when the user requests help, so the actual help ID may be determined dynamically (e.g. return a different ID depending on the state of the UI).

Specified by:

getHelpID in interface Traversable

getExitTransition

public java.lang.Object getExitTransition()

Description copied from interface: Traversable

Returns the exit transition that can be used by a Traversable-aware wizard. The wizard can use the exit transition to direct the user through an alternate or streamlined set of panels based on their current input.

If the Traversable implementation does not support multiple exit transitions or is not used in a wizard, then this method should just return null.

Specified by:

getExitTransition in interface Traversable

Returns:

The exit transition for the Traversable that is used by dynamic interview-style wizards to determine the next course of action. A Traversable class that does not support multiple possible transitions should just return null.

insertUpdate

public void insertUpdate(javax.swing.event.DocumentEvent e)

Specified by:

insertUpdate in interface javax.swing.event.DocumentListener

removeUpdate

public void removeUpdate(javax.swing.event.DocumentEvent e)

Specified by:

removeUpdate in interface javax.swing.event.DocumentListener

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent e)

Specified by:

changedUpdate in interface javax.swing.event.DocumentListener

valueChanged

public void valueChanged(javax.swing.event.ListSelectionEvent e)

Specified by:

valueChanged in interface javax.swing.event.ListSelectionListener

shuttleItemsMoved

public void shuttleItemsMoved(oracle.bali.ewt.shuttle.ShuttleEvent p0)

Specified by:

shuttleItemsMoved in interface oracle.bali.ewt.shuttle.ShuttleListener

shuttleItemsRemoved

public void shuttleItemsRemoved(oracle.bali.ewt.shuttle.ShuttleEvent p0)

Specified by:

shuttleItemsRemoved in interface oracle.bali.ewt.shuttle.ShuttleListener

shuttleItemsReordered

public void shuttleItemsReordered(oracle.bali.ewt.shuttle.ShuttleEvent p0)

Specified by:

shuttleItemsReordered in interface oracle.bali.ewt.shuttle.ShuttleListener

setTitleLabel

public void setTitleLabel(javax.swing.JLabel label)

setTitleControlBar

public void setTitleControlBar(ControlBar bar)