JDeveloper SCM API

oracle.ide.scm
Interface SCMDialogSpecification

All Known Implementing Classes:
SCMDialogSpecificationObject

public interface SCMDialogSpecification

Interface to dialog specifications, as requested by the framework from client operations. These provide all the information for the configuration of a standard editable file lister dialog, which is displayed when the supplying operation is invoked.


Method Summary
 java.lang.String getCaption()
          Gets the title bar caption for this dialog specification.
 java.lang.String getLongPrompt()
          Gets the descriptive prompt String for this dialog specification.
 SCMOptionsCustomizer getOptionsCustomizer()
          Gets the options customizer for the dialog.
 java.awt.Dimension getSize()
          Gets the required size of the dialog.
 java.lang.String getWatcherDescription()
          Gets the committer (progress watcher) dialog's description string.
 boolean isLayoutVertical()
          Asks whether the dialog is layed out in a vertical manner, with options south.
 boolean isModifiable()
          Asks whether the dialog should permit the user to change the file selection.
 boolean isWatcherIndeterminate()
          Asks whether the watcher should use indeterminate progress indication, rather than indication based on an operation's use of the iterator over selected files.
 

Method Detail

getCaption

public java.lang.String getCaption()
Gets the title bar caption for this dialog specification.
Returns:
the specification's caption value.

getLongPrompt

public java.lang.String getLongPrompt()
Gets the descriptive prompt String for this dialog specification.
Returns:
the specification's prompt value.

getWatcherDescription

public java.lang.String getWatcherDescription()
Gets the committer (progress watcher) dialog's description string. This should be a short indication of the action which is presently taking place
Returns:
a description for the watcher dialog action.

isWatcherIndeterminate

public boolean isWatcherIndeterminate()
Asks whether the watcher should use indeterminate progress indication, rather than indication based on an operation's use of the iterator over selected files.
Returns:
a verdict on indeterminate progress indication.

getOptionsCustomizer

public SCMOptionsCustomizer getOptionsCustomizer()
Gets the options customizer for the dialog.
Returns:
the newly created options customizer, or null if no customizer is required to be used.

isModifiable

public boolean isModifiable()
Asks whether the dialog should permit the user to change the file selection.
Returns:
a verdict on whether the dialog should feature a modifiable list of selected files.

isLayoutVertical

public boolean isLayoutVertical()
Asks whether the dialog is layed out in a vertical manner, with options south. The alternative positions the options panel east.
Returns:
the vertical layout mode.

getSize

public java.awt.Dimension getSize()
Gets the required size of the dialog.
Returns:
the dialog's preferred size, or null for the default.

Copyright © 2002 Oracle Corporation