AbstractLogPage

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Extension SDK 10.1.2

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.ide.log
Class AbstractLogPage

java.lang.Object
  oracle.ide.addin.AbstractView
      oracle.ide.log.AbstractLogPage

All Implemented Interfaces:: ControllerProvider, Helpable, LogPage, View

Direct Known Subclasses:: DefaultLogPage, MessagePage

public abstract class AbstractLogPage
extends AbstractView
implements LogPage

The AbstractLogPage is a convenience class that should be extended by integrators that need to add their own LogPage to the LogWindow.

Field Summary

Fields inherited from class oracle.ide.addin.AbstractView

owner, SEPARATOR, viewListeners, viewSelectionListeners

Fields inherited from interface oracle.ide.addin.View

PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP

Constructor Summary
`protected`	`AbstractLogPage(ViewId viewId)` Creates an `AbstractLogPage`.
`protected`	`AbstractLogPage(ViewId viewId, javax.swing.Icon icon)` Creates an `AbstractLogPage`.
`protected`	`AbstractLogPage(ViewId viewId, javax.swing.Icon icon, boolean addPage)` Creates an `AbstractLogPage`.

Method Summary
`void`	`addMouseListener(java.awt.event.MouseListener listener)` This implemenation does nothing.
`void`	`checkCommands(Context context, Controller activeController)`
`void`	`clearAll()` Clear all currently displayed messages.
`void`	`close()` Close the view
`Context`	`getContext(java.util.EventObject event)` Get the current view context for the given EventObject.
`Controller`	`getController()` Get the `Controller` associated with this view.
`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.
`boolean`	`isVisible()` Determine whether the View is visible.
`void`	`log(java.lang.Object msg)` Display the specified `msg`.
`protected void`	`logMsg(java.lang.Object msg)` Display the specified `msg`.
`void`	`removeMouseListener(java.awt.event.MouseListener listener)` This implemenation does nothing.
`protected void`	`requestShow()` Show the log window only if it has not been closed by the user.
`void`	`setOwner(LogOwner owner)` Set the `view` that owns this page.
`void`	`show()` Show the view if hidden.

Methods inherited from class oracle.ide.addin.AbstractView

activate, addViewListener, addViewSelectionListener, deactivate, fireViewActivated, fireViewClosed, fireViewDeactivated, fireViewSelectionChanged, getContext, getContextMenu, getHelpInfo, getId, getSelection, getToolbar, loadToolbar, loadToolbar, newId, owner, removeViewListener, removeViewSelectionListener, setId, setOwner, setToolbarVisible, updateTitle, updateToolbarActions, updateVisibleActions, updateVisibleActions

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

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

Methods inherited from interface oracle.ide.help.Helpable

getHelpInfo

Constructor Detail

AbstractLogPage

protected AbstractLogPage(ViewId viewId,
                          javax.swing.Icon icon,
                          boolean addPage)

Creates an AbstractLogPage. If the addPage parameter is true it adds the page to LogWindow. It uses the ViewId.getDisplayName() method to determine the tab name used by this page.

Some subclasses will pass false for the addPage argument, which means DO NOT add the page to the log manager during the execution of the constructor. The reason why a subclass would pass false is because they are overriding methods which are called during the addPage process and the overriding methods depend on field initialization which does not take place until after the super constructor returns. For example, a subclass which overrides getToolTip will likely want to pass false for the addPage argument.

Parameters:

viewId - the ViewId identifying this view.

icon - the page icon to be displayed in a tab.

addPage - specifies whether this page should be immediately added to the LogWindow

AbstractLogPage

protected AbstractLogPage(ViewId viewId,
                          javax.swing.Icon icon)

Creates an AbstractLogPage. It uses the ViewId.getDisplayName() method to determine the tab name used by this page.
Parameters:: viewId - the ViewId identifying this view.; icon - the page icon to be displayed in a tab. to the LogWindow

AbstractLogPage

protected AbstractLogPage(ViewId viewId)

Creates an AbstractLogPage. It uses the ViewId.getDisplayName() method to determine the tab name used by this page.
Parameters:: viewId - the ViewId identifying this view. to the LogWindow

Method Detail

log

public void log(java.lang.Object msg)

Display the specified msg. This method first makes sure that the page is visible and then calls the logMsg method to do the actual displaying of the message. Subclasses should not override this method. Instead they should override the logMsgmethod.

Specified by:: log in interface LogPage

Parameters:: msg - the message to display.