|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.7.2) E13403-10 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.jdevimpl.audit.preferences.AuditPreferencesPanel
public class AuditPreferencesPanel
The basic Audit preferences panel.
Constructor Summary | |
---|---|
AuditPreferencesPanel(ProfileModel profiles) |
Method Summary | |
---|---|
void |
actionPerformed(java.awt.event.ActionEvent 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 . |
void |
onEntry(TraversableContext context) This method is called when the Traversable is being entered. |
void |
onExit(TraversableContext context) This method is called when the Traversable is being exited. |
java.util.Collection<java.lang.String> |
searchTags() Returns the search tags for this navigable. |
void |
valueChanged(javax.swing.event.ListSelectionEvent event) |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AuditPreferencesPanel(ProfileModel profiles)
Method Detail |
---|
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 Traversable
Component
that the user interacts with for creating or editing an object.public void actionPerformed(java.awt.event.ActionEvent e)
actionPerformed
in interface java.awt.event.ActionListener
public void valueChanged(javax.swing.event.ListSelectionEvent event)
valueChanged
in interface javax.swing.event.ListSelectionListener
public void onEntry(TraversableContext context)
Traversable
Traversable
is being entered. The data that the Traversable
should use to populate its UI components comes from the specified TraversableContext
.
When the same Traversable
is entered more than once in the course of interacting with the user, the Traversable
needs to reload the data directly from the TraversableContext
rather than caching data objects. Some reasons for this include:
Traversable
s may edit the data objects or even replace them.Traversable
instance may be used for editing multiple different instances of the same object type.TraversableContext
is the best way to ensure that the Traversable
will not be editing the wrong data.
The Traversable
should not even cache references to data objects between invocations of onEntry
and Traversable.onExit(TraversableContext)
because the UI container is not required to guarantee that the references will be identical.
onEntry
in interface Traversable
context
- The data wrapper where the Traversable
locates the data that it needs to populate the UI.public void onExit(TraversableContext context) throws TraversalException
Traversable
Traversable
is being exited. At this point, the Traversable
should copy the data from its associated UI back into the data structures in the TraversableContext
.
If the Traversable
should not be exited because the user has entered either incomplete, invalid, or inconsistent data, then this method can throw a TraversalException
to indicate to the property dialog or wizard that validation failed and that the user should not be allowed to exit the current Traversable
. Refer to the TraversalException
javadoc for details on passing the error message that should be shown to the user.
onExit
in interface Traversable
context
- 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 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 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.util.Collection<java.lang.String> searchTags()
ProvidesSearchTags
The implementor of this method should never return null, but it may return an empty collection. The returned collection may not be modified by the caller.
searchTags
in interface ProvidesSearchTags
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.7.2) E13403-10 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |