oracle.javatools.editor
Interface FeedbackManager

All Known Implementing Classes:

EditorStatusBar, StatusBarPlugin

public interface FeedbackManager

A FeedbackManager is an interface used for different editor plugins or sub-components to display text feedback to a user. For example, the multi-key handler may use it for displaying a partial key combination in progress. A common place to display text feedback is to display it in one of the cells of a status bar.

The purpose of this interface is to allow for the possibility of having clients use their own custom status bars, and also to provide dependency separation between components that want to display feedback (multi-key handler) from plugins capable of displaying the feedback (status bar.)

It is up to implementations (of the FeedbackManager) whether they are associated with a single editor pane, or multiple editor panes. (There may be implementations that can display feedback for multiple editor panes.) The StatusBarPlugin can be associated with only one editor pane.

See Also:

BasicEditorPane

Method Summary

void	hideFeedback(BasicEditorPane editorPane) Clears the text feedback message last displayed for the given editor pane.
void	showFeedback(BasicEditorPane editorPane, java.lang.String feedbackMessage) Displays a text feedback message to the user associated with the given editor pane.
void	showFeedback(BasicEditorPane editorPane, java.lang.String feedbackMessage, int milliSeconds) Displays a text feedback message to the user associated with the given editor pane.

Method Detail

showFeedback

public void showFeedback(BasicEditorPane editorPane,
                         java.lang.String feedbackMessage)

Displays a text feedback message to the user associated with the given editor pane.

Parameters:

editorPane - the editor pane the message is associated with

feedbackMessage - the message to display

showFeedback

public void showFeedback(BasicEditorPane editorPane,
                         java.lang.String feedbackMessage,
                         int milliSeconds)

Displays a text feedback message to the user associated with the given editor pane. The message will only be displayed for the time period specified.

Parameters:

editorPane - the editor pane the message is associated with

feedbackMessage - the message to display

milliSeconds - the length of time to display the message

hideFeedback

public void hideFeedback(BasicEditorPane editorPane)

Clears the text feedback message last displayed for the given editor pane. This is meant to be used in conjunction with the non-timeout version of showFeedback() to clear the feedback area.

Parameters:

editorPane - the editor pane the last message was associated with