oracle.ide.log
Interface LogPage

All Superinterfaces:

ControllerProvider, Helpable, View

All Known Subinterfaces:

LogWindow

All Known Implementing Classes:

AbstractLogPage

public interface LogPage

extends View

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

Field Summary

Fields inherited from interface oracle.ide.addin.View

PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP

Method Summary

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.
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.

Methods inherited from interface oracle.ide.addin.View

activate, addViewListener, addViewSelectionListener, close, deactivate, getContext, getContext, getContextMenu, getGUI, getId, getSelection, getToolbar, isVisible, owner, removeViewListener, removeViewSelectionListener, setToolbarVisible, show, updateTitle, updateVisibleActions

Methods inherited from interface oracle.ide.addin.ControllerProvider

getController

Methods inherited from interface oracle.ide.help.Helpable

getHelpInfo

Method Detail

log

public void log(java.lang.Object msg)

Display the specified msg.

Parameters:

msg - the message to display.

clearAll

public void clearAll()

Clear all currently displayed messages.

getTitleName

public 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

public java.lang.String getTabName()

Get the name to display when this page is tabbed.

Returns:

the name to display when tabbed.

getTabIcon

public javax.swing.Icon getTabIcon()

Get the icon to display when this page is tabbed.

Returns:

the icon to display when tabbed.

getToolTip

public java.lang.String getToolTip()

Get the tooltip to display when this page is tabbed.

Returns:

the tooltip to display when tabbed.

setOwner

public void setOwner(LogOwner owner)

Set the view that owns this page.

Parameters:

owner - view the hosting view.

addMouseListener

public 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

public 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.