oracle.javatools.ui.actiontip

Class ActionTipManager

java.lang.Object

oracle.javatools.ui.actiontip.ActionTipManager

public final class ActionTipManager
extends java.lang.Object

ActionTips should only be displayed to the user one at a time. The ActionTipManager ensures this and manages a queue of tips to be displayed. Clients can add and remove ActionTipTaks to display a tip and the ActionTipManager processes them, calling back the client when it is time for a task to display its tip. Tips are displayed for a short while, giving the opportunity for the user to read, iteract, or cancel the tip. This manager is part of Swing and is not thread safe. All interactions with it must be made on the event thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ActionTipManager.TaskResult

Method Summary

Modifier and Type	Method and Description
void	acceptTipTask(ActionTipTask task) Accept a previously submitted task.
void	cancelTipTask(ActionTipTask task) Remove a tip task from the queue as it is no longer needed.
static ActionTipManager	getActionTipManager()
static int	getTipDisplayDuration()
static void	setTipDisplayDuration(int tipDisplayDuration)
void	submitTipTask(ActionTipTask task) Submit a task to the ActionTipManager to display a actionTip.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getActionTipManager

public static ActionTipManager getActionTipManager()

submitTipTask

public void submitTipTask(ActionTipTask task)

Submit a task to the ActionTipManager to display a actionTip. The manager only display one tip at a time, so the request might have to wait until other tips have been displayed. When an opprtunity arises the manager will call back the supplied ActionTipProvider passing the Object id supplied at submission time. The provider can then provide details of the tip to display. Previously submitted requests can be canceled by calling cancelTip.

Parameters:

task - the provider to call back to display a tip

cancelTipTask

public void cancelTipTask(ActionTipTask task)

Remove a tip task from the queue as it is no longer needed. The ActionTipManager will automatically remove tasks once they have been processed, so there is no need to call this unless it is necessary to remove a task before it is processed. If the canceled task is currently being displayed then the task is treated as 'RESULT.REJECTED'

Parameters:

task -

acceptTipTask

public void acceptTipTask(ActionTipTask task)

Accept a previously submitted task. The task can be the currently displayed tip task, or a queued one. Either way the task is removed and completed with a RESULT.ACCEPTED status.

Parameters:

task -

setTipDisplayDuration

public static void setTipDisplayDuration(int tipDisplayDuration)

getTipDisplayDuration

public static int getTipDisplayDuration()