Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

javax.ide.log
Class LogPage  view LogPage download LogPage.java

java.lang.Object
  extended byjavax.ide.view.DefaultViewable
      extended byjavax.ide.view.View
          extended byjavax.ide.log.LogPage
All Implemented Interfaces:
javax.ide.Identifiable, javax.ide.view.Viewable

public abstract class LogPage
extends javax.ide.view.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 javax.ide.util.ID.


Field Summary
 
Fields inherited from class javax.ide.view.DefaultViewable
 
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.


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.


getShortTitle

public abstract java.lang.String getShortTitle()
Get the name to display when this page is tabbed.


getToolTip

public abstract java.lang.String getToolTip()
Get the tooltip to display when this page is tabbed.