Extension SDK

oracle.ide.log
Class MessagePage

java.lang.Object
  |
  +--oracle.ide.addin.AbstractView
        |
        +--oracle.ide.log.AbstractLogPage
              |
              +--oracle.ide.log.MessagePage
All Implemented Interfaces:
Helpable, LogPage, Subview, View
Direct Known Subclasses:
RunLogPage

public class MessagePage
extends AbstractLogPage

The MessagePage class provides a simple text field where clients can log their messages.


Field Summary
static java.lang.String MESSAGE_PAGE_ID
           
 
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
  MessagePage()
          Default constructor.
protected MessagePage(ViewId viewId)
          Creates a MessagePage using the specified ViewId.
protected MessagePage(ViewId viewId, javax.swing.Icon icon)
          Creates a MessagePage using the specified ViewId and Icon.
protected MessagePage(ViewId viewId, javax.swing.Icon icon, boolean addPage)
          Creates a MessagePage using the specified ViewId and Icon.
 
Method Summary
 void addMouseListener(java.awt.event.MouseListener listener)
          This implemenation does nothing.
protected  boolean checkLogOpen()
           
 void clearAll()
          Clear all currently displayed messages.
 ContextMenu getContextMenu()
          Gets the ContextMenu object, if any, managed by this instance.
 Controller getController()
          Gets the Controller associated with this view.
 java.awt.Component getGUI()
          Gets the view's root graphical user interface component
 HelpInfo getHelpInfo()
           
protected  void logMsg(java.lang.Object msg)
          Display the specified msg.
 void removeMouseListener(java.awt.event.MouseListener listener)
          This implemenation does nothing.
protected  void setLogFileName(java.lang.String fn)
           
 
Methods inherited from class oracle.ide.log.AbstractLogPage
checkCommands, close, getContext, getTabIcon, getTabName, getTitleName, getToolTip, isVisible, log, requestShow, setOwner, show
 
Methods inherited from class oracle.ide.addin.AbstractView
activate, addViewListener, addViewSelectionListener, deactivate, fireViewActivated, fireViewClosed, fireViewDeactivated, fireViewSelectionChanged, getContext, getId, getSelection, getToolbar, loadToolbar, newId, owner, removeViewListener, removeViewSelectionListener, setId, setOwner, updateTitle
 
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, getId, getSelection, getToolbar, removeViewListener, removeViewSelectionListener, updateTitle
 
Methods inherited from interface oracle.ide.addin.Subview
getContext, owner
 

Field Detail

MESSAGE_PAGE_ID

public static final java.lang.String MESSAGE_PAGE_ID
Constructor Detail

MessagePage

public MessagePage()
Default constructor. Creates a MessagePage using the message page view identifier.

MessagePage

protected MessagePage(ViewId viewId)
Creates a MessagePage using the specified ViewId.

MessagePage

protected MessagePage(ViewId viewId,
                      javax.swing.Icon icon)
Creates a MessagePage using the specified ViewId and Icon.

MessagePage

protected MessagePage(ViewId viewId,
                      javax.swing.Icon icon,
                      boolean addPage)
Creates a MessagePage using the specified ViewId and Icon.

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.

Method Detail

getContextMenu

public ContextMenu getContextMenu()
Gets the ContextMenu object, if any, managed by this instance.
Overrides:
getContextMenu in class AbstractView

checkLogOpen

protected boolean checkLogOpen()

setLogFileName

protected void setLogFileName(java.lang.String fn)

clearAll

public void clearAll()
Description copied from interface: LogPage
Clear all currently displayed messages.
Overrides:
clearAll in class AbstractLogPage

addMouseListener

public void addMouseListener(java.awt.event.MouseListener listener)
Description copied from class: AbstractLogPage
This implemenation does nothing. Subclasses must override this method in order to correctly set the specified listener on the graphical components that receive mouse events.
Overrides:
addMouseListener in class AbstractLogPage
Following copied from interface: oracle.ide.log.LogPage
Parameters:
listener - mouse listener responsible for displaying a context menu.

removeMouseListener

public void removeMouseListener(java.awt.event.MouseListener listener)
Description copied from class: AbstractLogPage
This implemenation does nothing. Subclasses must override this method in order to correctly remove the specified listener from the graphical components that receive mouse events.
Overrides:
removeMouseListener in class AbstractLogPage
Following copied from interface: oracle.ide.log.LogPage
Parameters:
listener - mouse listener responsible for displaying a context menu.

getGUI

public java.awt.Component getGUI()
Description copied from interface: Subview
Gets the view's root graphical user interface component
Following copied from interface: oracle.ide.addin.Subview
Returns:
the view's root graphical user interface component

getHelpInfo

public HelpInfo getHelpInfo()
Overrides:
getHelpInfo in class AbstractView

getController

public Controller getController()
Description copied from interface: Subview
Gets the Controller associated with this view.
Overrides:
getController in class AbstractLogPage
Following copied from interface: oracle.ide.addin.Subview
Returns:
the controller associated with this view.

logMsg

protected void logMsg(java.lang.Object msg)
Description copied from class: AbstractLogPage
Display the specified msg. Subclasses must override this method instead of the log method. The log method makes sure that the page is visible before calling this method.
Overrides:
logMsg in class AbstractLogPage
Following copied from class: oracle.ide.log.AbstractLogPage
Parameters:
msg - the message to display.

Extension SDK