javax.ide.log
Class LogPage

java.lang.Object
  javax.ide.view.DefaultViewable
      javax.ide.view.View
          javax.ide.log.LogPage

All Implemented Interfaces:

Identifiable, Viewable

public abstract class LogPage
extends View

The LogPage interface defines the methods to log and clear messages from a page.

Extensions that introduce new page types need to implemente this interface. A new page is introduced by declaring it in the extension deployment descriptor (EDD) file. There, the page implementation class is associated with a unique string identifying the page type.

When an LogPage implementation is instantiated, the page type string and a page specific name are used as the components of page ID.

Field Summary

Fields inherited from interface javax.ide.view.Viewable

PROP_ICON_PATH, PROP_LABEL, PROP_VISIBLE

Constructor Summary

LogPage()

Method Summary

abstract void	clearAll() Clear all currently displayed messages.
abstract java.lang.String	getLongTitle() Get the title to be displayed in the log window hosting this page.
abstract java.lang.String	getShortTitle() Get the name to display when this page is tabbed.
abstract java.lang.String	getToolTip() Get the tooltip to display when this page is tabbed.
abstract void	log(java.lang.Object msg) Display the specified msg.

Methods inherited from class javax.ide.view.View

activate, deactivate, getContext, getController, getGUI, isVisible, parent, setVisible

Methods inherited from class javax.ide.view.DefaultViewable

addPropertyChangeListener, firePropertyChange, getIcon, getLabel, removePropertyChangeListener, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.ide.Identifiable

getID

Constructor Detail

LogPage

public LogPage()

Method Detail

log

public abstract void log(java.lang.Object msg)

Display the specified msg.

Parameters:

msg - the message to display.

clearAll

public abstract void clearAll()

Clear all currently displayed messages.

getLongTitle

public abstract java.lang.String getLongTitle()

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

Returns:

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

getShortTitle

public abstract java.lang.String getShortTitle()

Get the name to display when this page is tabbed.

Returns:

the name to display when tabbed.

getToolTip

public abstract java.lang.String getToolTip()

Get the tooltip to display when this page is tabbed.

Specified by:

getToolTip in interface Viewable

Overrides:

getToolTip in class DefaultViewable

Returns:

the tooltip to display when tabbed.