oracle.ide.log
Class LogManager

java.lang.Object
  oracle.ide.log.LogManager

All Implemented Interfaces:

Controller, Module

Direct Known Subclasses:

AbstractLogManager

public abstract class LogManager

extends java.lang.Object

implements Controller, Module

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.

Constructor Summary

LogManager()

Method Summary

abstract void	addPage(LogPage page) Add and display the specified page to the LogWindow.
abstract ContextMenu	getContextMenu() Get the ContextMenu.
static LogWindow	getIdeLogWindow() Returns the LogWindow instance that is used by the currently active LogManager.
static LogManager	getLogManager() Returns the LogManager instance that is active in the IDE.
abstract LogWindow	getLogWindow() Get the LogWindow.
abstract LogPage	getMsgPage() Get the MessagePage.
abstract int	getPageCount() Find out the number of opened LogPages.
abstract LogPage[]	getPages() Get a list of all the pages currently opened.
abstract LogPage	getSelectedPage() Gets the currently selected page.
abstract void	hideLog() Hide the LogWindow.
abstract boolean	isLogVisible() Find out if the LogWindow is visible.
abstract void	registerLogRecognizer(LogRecognizer logRecognizer) Register a LogRecognizer Registered LogRecognizers determine what files can be opened in the log window and define what class will be used to present the data from the file.
abstract void	removePage(LogPage page) Remove the specified page from the LogWindow.
static void	setLogManager(LogManager logManager) Publishes the specified LogManager as the active instance in the IDE.
abstract void	showLog() Show the LogWindow.
abstract void	shutdown() Cleanup the log window management.
abstract void	toggleLog(Context context) Shows/Hide the LogWindow.
abstract void	unregisterLogRecognizer(LogRecognizer logRecognizer) Unregister a LogRecognizer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.ide.addin.Controller

handleEvent, update

Methods inherited from interface oracle.javatools.Module

initialize

Constructor Detail

LogManager

public LogManager()

Method Detail

getLogManager

public static LogManager getLogManager()

Returns the LogManager instance that is active in the IDE.

setLogManager

public static void setLogManager(LogManager logManager)

Publishes the specified LogManager as the active instance in the IDE.

getIdeLogWindow

public static LogWindow getIdeLogWindow()

Returns the LogWindow instance that is used by the currently active LogManager.

shutdown

public abstract void shutdown()

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

getContextMenu

public abstract ContextMenu getContextMenu()

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

Returns:

the context menu.

addPage

public abstract void addPage(LogPage page)

Add and display the specified page to the LogWindow.

Parameters:

page - the page to add.

removePage

public abstract void removePage(LogPage page)

Remove the specified page from the LogWindow.

Parameters:

page - the page to removed.

getPageCount

public abstract int getPageCount()

Find out the number of opened LogPages.

Returns:

the number of log pages opened.

getPages

public abstract LogPage[] getPages()

Get a list of all the pages currently opened.

Returns:

The list of pages opened.

isLogVisible

public abstract boolean isLogVisible()

Find out if the LogWindow is visible.

Returns:

true if the log window is visible.

showLog

public abstract void showLog()

Show the LogWindow.

hideLog

public abstract void hideLog()

Hide the LogWindow.

toggleLog

public abstract void toggleLog(Context context)

Shows/Hide the LogWindow.

Parameters:

context - that should be toggled

getLogWindow

public abstract LogWindow getLogWindow()

Get the LogWindow.

Returns:

the LogWindow

getMsgPage

public abstract 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 abstract LogPage getSelectedPage()

Gets the currently selected page.

Returns:

the currently selected page.

registerLogRecognizer

public abstract void registerLogRecognizer(LogRecognizer logRecognizer)

Register a LogRecognizer Registered LogRecognizers determine what files can be opened in the log window and define what class will be used to present the data from the file.

Parameters:

logRecognizer - to register

unregisterLogRecognizer

public abstract void unregisterLogRecognizer(LogRecognizer logRecognizer)

Unregister a LogRecognizer.

Parameters:

logRecognizer - to unregister