oracle.ide.log

Interface LogPage

All Known Implementing Classes:

AbstractLogPage, AuditLogPage, DefaultLogPage, LogWindow, MessagePage, RunLogPage, UIEditorLogPage

public interface LogPage

The LogPage interface should be implemented by addins that report information to the user. The framework provides an abstract implementation, AbstractLogPage, for convenience.

Method Summary

Modifier and Type	Method and Description
void	addMouseListener(java.awt.event.MouseListener listener) Implemenations should add the specified listener to the graphical components used in the page implementation.
void	clearAll() Clear all currently displayed messages.
View	getLogPageView() Returns the View implementation backing this LogPage.
javax.swing.Icon	getTabIcon() Get the icon to display when this page is tabbed.
java.lang.String	getTabName() Get the name to display when this page is tabbed.
java.lang.String	getTitleName() Get the title to be displayed in the log window hosting this page.
java.lang.String	getToolTip() Get the tooltip to display when this page is tabbed.
void	log(java.lang.Object msg) Display the specified msg.
void	removeMouseListener(java.awt.event.MouseListener listener) Removes the specified listener from the graphical components used in the page implementation.
void	setOwner(LogOwner owner) Set the view that owns this page.

Method Detail

log

void log(java.lang.Object msg)

Display the specified msg.

Parameters:

msg - the message to display.

clearAll

void clearAll()

Clear all currently displayed messages.

getTitleName

java.lang.String getTitleName()

Get the title to be displayed in the log window hosting this page.

Returns:

the title to display in the host's title bar.

getTabName

java.lang.String getTabName()

Get the name to display when this page is tabbed.

Returns:

the name to display when tabbed.

getTabIcon

javax.swing.Icon getTabIcon()

Get the icon to display when this page is tabbed.

Returns:

the icon to display when tabbed.

getToolTip

java.lang.String getToolTip()

Get the tooltip to display when this page is tabbed.

Returns:

the tooltip to display when tabbed.

setOwner

void setOwner(LogOwner owner)

Set the view that owns this page.

Parameters:

owner - view the hosting view.

addMouseListener

void addMouseListener(java.awt.event.MouseListener listener)

Implemenations should add the specified listener to the graphical components used in the page implementation. The specified listener is responsible for showing the ContextMenu.

Parameters:

listener - mouse listener responsible for displaying a context menu.

removeMouseListener

void removeMouseListener(java.awt.event.MouseListener listener)

Removes the specified listener from the graphical components used in the page implementation.

Parameters:

listener - mouse listener responsible for displaying a context menu.

getLogPageView

View getLogPageView()

Returns the View implementation backing this LogPage. If the LogPage itself is a View, then getLogPageView should return this.