|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.6.0) E13403-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.bali.ewt.shuttle.ListPicker oracle.ide.db.controls.DBObjectListPicker oracle.ide.db.controls.SchemaObjectTargetPicker
public class SchemaObjectTargetPicker
ItemPicker designed to be used as the target (right or to) picker in the shuttle on a SelectDBObjectsPanel.
Field Summary |
---|
Fields inherited from interface oracle.bali.ewt.shuttle.ItemPicker |
---|
PROPERTY_SELECTION |
Constructor Summary | |
---|---|
SchemaObjectTargetPicker()
|
|
SchemaObjectTargetPicker(javax.swing.JList list)
|
|
SchemaObjectTargetPicker(NameController nameController)
|
Method Summary | |
---|---|
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 |
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 |
---|
public SchemaObjectTargetPicker()
public SchemaObjectTargetPicker(NameController nameController)
public SchemaObjectTargetPicker(javax.swing.JList list)
Method Detail |
---|
public javax.swing.JLabel getLabel()
public java.awt.Component getComponent()
Traversable
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.
getComponent
in interface oracle.bali.ewt.shuttle.ItemPicker
getComponent
in interface Traversable
getComponent
in class oracle.bali.ewt.shuttle.ListPicker
Component
that the user interacts with
for creating or editing an object.public boolean addSelectedItems(java.awt.datatransfer.Transferable[] add)
DBObjectListPicker
addSelectedItems
in interface oracle.bali.ewt.shuttle.ItemPicker
addSelectedItems
in class DBObjectListPicker
public void removeSelectedItems()
removeSelectedItems
in interface oracle.bali.ewt.shuttle.ItemPicker
removeSelectedItems
in class DBObjectListPicker
public void removeAllSelectableItems()
removeAllSelectableItems
in interface oracle.bali.ewt.shuttle.ItemPicker
removeAllSelectableItems
in class DBObjectListPicker
public void onExit(TraversableContext tc) throws TraversalException
onExit
in interface Traversable
tc
- The data object where changes made in the UI
should be copied so that the changes can be accessed by other
Traversable
s.
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.public void onEntry(TraversableContext tc)
onEntry
in interface Traversable
tc
- The data wrapper where the
Traversable
locates the data that it needs to
populate the UI.public DBObjectProvider getProvider()
public java.lang.String getHelpID()
Traversable
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:
MetaTraversable.getHelpID()
Traversable.getHelpID()
. This may lead into a
recursion if the Traversable's Component is a nested
Navigable container.
Traversable.getComponent()
)
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).
getHelpID
in interface Traversable
public java.lang.Object getExitTransition()
Traversable
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
.
getExitTransition
in interface Traversable
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
.public void insertUpdate(javax.swing.event.DocumentEvent e)
insertUpdate
in interface javax.swing.event.DocumentListener
public void removeUpdate(javax.swing.event.DocumentEvent e)
removeUpdate
in interface javax.swing.event.DocumentListener
public void changedUpdate(javax.swing.event.DocumentEvent e)
changedUpdate
in interface javax.swing.event.DocumentListener
public void valueChanged(javax.swing.event.ListSelectionEvent e)
valueChanged
in interface javax.swing.event.ListSelectionListener
public void shuttleItemsMoved(oracle.bali.ewt.shuttle.ShuttleEvent p0)
shuttleItemsMoved
in interface oracle.bali.ewt.shuttle.ShuttleListener
public void shuttleItemsRemoved(oracle.bali.ewt.shuttle.ShuttleEvent p0)
shuttleItemsRemoved
in interface oracle.bali.ewt.shuttle.ShuttleListener
public void shuttleItemsReordered(oracle.bali.ewt.shuttle.ShuttleEvent p0)
shuttleItemsReordered
in interface oracle.bali.ewt.shuttle.ShuttleListener
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.6.0) E13403-07 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |