oracle.jdevimpl.bookmarks
Class BookmarkAddin

java.lang.Object
  oracle.jdevimpl.bookmarks.BookmarkAddin

All Implemented Interfaces:

Addin, ShutdownHook, ContextMenuListener, Controller

public final class BookmarkAddin
extends java.lang.Object
implements Addin, ShutdownHook, Controller, ContextMenuListener

The BookmarkAddin is the Addin implementation and Controller implementation for the bookmark support.

Field Summary

static int	GOTO_BOOKMARK_CMD_ID
static int	NEXT_BOOKMARK_CMD_ID
static int	PREV_BOOKMARK_CMD_ID
static int	REMOVE_ALL_BOOKMARKS_CMD_ID
static int	REMOVE_BOOKMARKS_FROM_FILE_CMD_ID
static int	TOGGLE_BOOKMARK_CMD_ID
static java.lang.String	VIEW_TYPE

Fields inherited from interface oracle.ide.controller.Controller

UPDATE_FROM_ACTION_PERFORMED, UPDATE_FROM_ACTIVE_VIEW_CHANGED, UPDATE_FROM_UNDO, UPDATE_FROM_USER_EXTENSION, UPDATE_FROM_VIEW_SELECTION_CHANGED

Constructor Summary

BookmarkAddin()
Contructs a new BookmarkAddin.

Method Summary

boolean	canShutdown() Called on shutdown hooks in the order they were registered prior to shutting down the IDE.
boolean	handleDefaultAction(Context context) Called when the user double clicks on an item that has a popup menu.
boolean	handleEvent(IdeAction action, Context context) This method is called when a user interaction with a View triggers the execution of a command.
void	initialize() This method is called by the IDE to request that the feature be initialized.
void	menuWillHide(ContextMenu popup) Called just before the context menu is popping down.
void	menuWillShow(ContextMenu popup) Called just before the context menu is popping up.
void	shutdown() This method is called by the IDE to request that the feature be shutdown.
boolean	update(IdeAction action, Context context) This method updates the enabled status of the specified action within the specified context.

Methods inherited from class java.lang.Object

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

Field Detail

TOGGLE_BOOKMARK_CMD_ID

public static final int TOGGLE_BOOKMARK_CMD_ID

GOTO_BOOKMARK_CMD_ID

public static final int GOTO_BOOKMARK_CMD_ID

NEXT_BOOKMARK_CMD_ID

public static final int NEXT_BOOKMARK_CMD_ID

PREV_BOOKMARK_CMD_ID

public static final int PREV_BOOKMARK_CMD_ID

REMOVE_BOOKMARKS_FROM_FILE_CMD_ID

public static final int REMOVE_BOOKMARKS_FROM_FILE_CMD_ID

REMOVE_ALL_BOOKMARKS_CMD_ID

public static final int REMOVE_ALL_BOOKMARKS_CMD_ID

VIEW_TYPE

public static final java.lang.String VIEW_TYPE

See Also:

Constant Field Values

Constructor Detail

BookmarkAddin

public BookmarkAddin()

Contructs a new BookmarkAddin. This also takes care of creating our actions and menu items.

Method Detail

initialize

public void initialize()

This method is called by the IDE to request that the feature be initialized.

Specified by:

initialize in interface Addin

See Also:

AddinManager

canShutdown

public boolean canShutdown()

Description copied from interface: ShutdownHook

Called on shutdown hooks in the order they were registered prior to shutting down the IDE. If any hook returns false, the shutdown sequence will be aborted and no further hooks will be queried.

Specified by:

canShutdown in interface ShutdownHook

Returns:

true if shutdown can proceed, false to abort shutdown.

shutdown

public void shutdown()

This method is called by the IDE to request that the feature be shutdown.

Specified by:

shutdown in interface ShutdownHook

handleEvent

public boolean handleEvent(IdeAction action,
                           Context context)

This method is called when a user interaction with a View triggers the execution of a command.

Specified by:

handleEvent in interface Controller

Parameters:

action - action whose command is to be executed.

Returns:

true if the controller handles the specified command.

update

public boolean update(IdeAction action,
                      Context context)

This method updates the enabled status of the specified action within the specified context.

Specified by:

update in interface Controller

Parameters:

action - action whose command is to be executed.

context - the current context

Returns:

true if the controller handles the specified command.

menuWillShow

public void menuWillShow(ContextMenu popup)

Called just before the context menu is popping up.

Specified by:

menuWillShow in interface ContextMenuListener

Parameters:

popup - the current view context

menuWillHide

public void menuWillHide(ContextMenu popup)

Called just before the context menu is popping down.

Specified by:

menuWillHide in interface ContextMenuListener

Parameters:

popup - the current view context

handleDefaultAction

public boolean handleDefaultAction(Context context)

Called when the user double clicks on an item that has a popup menu. Only one listener should return true from this menu.

Specified by:

handleDefaultAction in interface ContextMenuListener

Parameters:

context - the current context