oracle.ide.log
Interface LogManager

All Superinterfaces:

Controller

All Known Implementing Classes:

AbstractLogManager

public interface LogManager

extends Controller

The LogManager interface should be implemented to provide customized management of LogPages. The framework provides an implementation that manages the log pages as tabbed sub-views inside a Dockable view: the LogWindow.

Method Summary

void	addPage(LogPage page) Add and display the specified page to the LogWindow.
ContextMenu	getContextMenu() Get the ContextMenu.
LogWindow	getLogWindow() Get the LogWindow.
LogPage	getMsgPage() Get the MessagePage.
int	getPageCount() Find out the number of opened LogPages.
LogPage[]	getPages() Get a list of all the pages currently opened.
LogPage	getSelectedPage()
void	hideLog() Hide the LogWindow.
void	initialize() Initialize the log window management.
boolean	isLogVisible() Find out if the LogWindow is visible.
void	removePage(LogPage page) Remove the specified page from the LogWindow.
void	showLog() Show the LogWindow.
void	shutdown() Cleanup the log window management.
void	toggleLog(Context context) Shows/Hide the LogWindow.

Methods inherited from interface oracle.ide.addin.Controller

checkCommands, handleEvent, supervisor, update

Method Detail

initialize

public void initialize()

Initialize the log window management. This method is called during the system startup process.

shutdown

public void shutdown()

Cleanup the log window management. This method is called during the system shutdown process.

getContextMenu

public ContextMenu getContextMenu()

Get the ContextMenu. In general, subclasses should get the context menu to add custom menu items.

Returns:

the context menu.

addPage

public void addPage(LogPage page)

Add and display the specified page to the LogWindow.

Parameters:

page - the page to add.

removePage

public void removePage(LogPage page)

Remove the specified page from the LogWindow.

Parameters:

page - the page to removed.

getPageCount

public int getPageCount()

Find out the number of opened LogPages.

Returns:

the number of log pages opened.

getPages

public LogPage[] getPages()

Get a list of all the pages currently opened.

Returns:

The list of pages opened.

isLogVisible

public boolean isLogVisible()

Find out if the LogWindow is visible.

Returns:

true if the log window is visible.

showLog

public void showLog()

Show the LogWindow.

hideLog

public void hideLog()

Hide the LogWindow.

toggleLog

public void toggleLog(Context context)

Shows/Hide the LogWindow.

getLogWindow

public LogWindow getLogWindow()

Get the LogWindow.

getMsgPage

public LogPage getMsgPage()

Get the MessagePage. The message page can be used as the default page to display messages for the user.

Returns:

get the default message page.

getSelectedPage

public LogPage getSelectedPage()

Returns:

the currently selected page.