public abstract class LogPage extends View
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
.
PROP_ICON_PATH, PROP_LABEL, PROP_VISIBLE
Constructor and Description |
---|
LogPage() |
Modifier and Type | Method and Description |
---|---|
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 . |
activate, deactivate, getContext, getController, getGUI, isVisible, parent, setVisible
addPropertyChangeListener, firePropertyChange, getIcon, getLabel, removePropertyChangeListener, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
getID
public abstract void log(java.lang.Object msg)
msg
.msg
- the message to display.public abstract void clearAll()
public abstract java.lang.String getLongTitle()
public abstract java.lang.String getShortTitle()
public abstract java.lang.String getToolTip()
getToolTip
in interface Viewable
getToolTip
in class DefaultViewable