oracle.javatools.ui.actiontip
Interface ActionTipTask

public interface ActionTipTask

A request to the ActionTipManager to (at some point in the near future) display a ActionTip. The ActionTip isn't displayed immediately, and may be canceled before it is displayed, so clients should not create all the tip specific objects until prompted by the manager (via getActionTipContent)

Method Summary

void	actionTipResult(ActionTipManager.TaskResult result) The manager has finished displaying this ActionTip and is returning the result to the client.
javax.swing.JComponent	getActionTipContent() The ActionTipManager has decided it is time for this provider to display the tip for this task.
java.awt.Rectangle	getLocation()
javax.swing.JComponent	getParentComponent() This tip will be displayed above a component at a fixed location supplied by the task.
boolean	isCancelable()

Method Detail

getActionTipContent

javax.swing.JComponent getActionTipContent()

The ActionTipManager has decided it is time for this provider to display the tip for this task. The provider can return a component to display in the ActionTip or can return a null if it decides that it no longer wishes to display the tip. As this callback is on the EventThread the provider must not do much work in returning else the application will appear hung to the user.

Returns:

the component to place in the tip or null if the provider no longer wishes to display the tip.

getParentComponent

javax.swing.JComponent getParentComponent()

This tip will be displayed above a component at a fixed location supplied by the task. If the component is scrolled or moved then the tip will adjust appropriately.

Returns:

The component above which the ActionTip will be displayed.

getLocation

java.awt.Rectangle getLocation()

Returns:

the rectangle (in parentComponent coordinates) bounding the location where the point of the tip will be placed. Returning null indicates that the tip can no longer be positioned and should no longer/not be displayed.

actionTipResult

void actionTipResult(ActionTipManager.TaskResult result)

The manager has finished displaying this ActionTip and is returning the result to the client.

Parameters:

result - whether the tip was accepted or rejected by the user, or other possible results.

isCancelable

boolean isCancelable()

Returns:

true if the user is able to cancel this operation via the UI, if false the ActionTip will appear and the user will not be able to cancel it, i.e. it is for information purposes only.