public abstract class AbstractLogPage extends View implements LogPage
EMPTY_SELECTION, PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP
Modifier | Constructor and Description |
---|---|
protected |
AbstractLogPage(java.lang.String viewId,
java.lang.String displayName,
javax.swing.Icon icon,
boolean addPage) |
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 . |
Modifier and Type | Method and Description |
---|---|
void |
addMouseListener(java.awt.event.MouseListener listener)
This implemenation does nothing.
|
void |
clearAll()
Clear all currently displayed messages.
|
void |
close() |
java.awt.Component |
getBottomComponent()
Gets the component to put in the bottom component position in the log page
display.
|
Controller |
getController()
Get the
Controller associated with this view. |
View |
getLogPageView()
Returns the
View implementation backing this LogPage. |
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.
|
java.awt.Component |
getTopComponent()
Gets the component to put in the top component position in the log page display
By default returns getLogPageView().getToolbar()
|
boolean |
isDisplayComponentScrollable()
Gets whether the component returned from getGUI should be treated
as a scrollable component
|
boolean |
isVisible() |
void |
log(java.lang.Object msg)
Display the specified
msg . |
void |
log(java.lang.Object msg,
boolean forceDisplay)
Display the specified
msg . |
protected void |
logMsg(java.lang.Object msg)
Display the specified
msg . |
void |
logQuietly(java.lang.Object msg)
Adds the specified
msg as silently as possible. |
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.
|
protected void |
requestShow(boolean forceDisplay)
Requests the show of the log window and log tab.
|
void |
setOwner(LogOwner owner)
Set the
view that owns this page. |
void |
show()
Shows the view if hidden.
|
void |
tabNameUpdated()
Notifies the LogWindow of the change
TODO Not part of the LogPage interface (yet)
|
activate, addViewListener, addViewSelectionListener, addViewStateListener, deactivate, fireViewCollapsed, fireViewExpanded, fireViewSelectionChanged, getContext, getContext, getContextMenu, getGUI, getHelpInfo, getId, getSelection, getSelectionFromUI, getToolbar, getViewWithoutDecoration, loadLayout, loadManifestToolbar, loadManifestToolbar, newId, owner, removeViewListener, removeViewSelectionListener, removeViewStateListener, saveLayout, scheduleUpdateSelection, setId, setOwner, setToolbarVisible, toString, updateSelection, updateSelectionImpl, updateTitle, updateToolbarActions, updateVisibleActions, updateVisibleActions
protected AbstractLogPage(java.lang.String viewId, java.lang.String displayName, javax.swing.Icon icon, boolean addPage)
protected AbstractLogPage(ViewId viewId, javax.swing.Icon icon, boolean addPage)
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.
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
protected AbstractLogPage(ViewId viewId, javax.swing.Icon icon)
AbstractLogPage
. It uses the
ViewId.getDisplayName()
method to determine the tab name used
by this page.viewId
- the ViewId
identifying this view.icon
- the page icon to be displayed in a tab.
to the LogWindow
public void log(java.lang.Object msg)
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
logMsg
method.public void log(java.lang.Object msg, boolean forceDisplay)
msg
. This method allows the caller
to specify whether the log window should be forced to become visible.msg
- the message to displayforceDisplay
- true if the log window and log page should be forced
to display; false if the log window should only open if the user hasn't closed
it and the log page's tab should just be highlighted. Subclasses
should not override this method. Instead they should override the
logMsg
method.public void logQuietly(java.lang.Object msg)
msg
as silently as possible. That is, the
log window will not be displayed if it is hidden and the tab will not highlight
to indicate it's content has changed.msg
- the message to add to the displaypublic void clearAll()
LogPage
public java.lang.String getTitleName()
LogPage
getTitleName
in interface LogPage
public java.lang.String getTabName()
LogPage
getTabName
in interface LogPage
getTabName
in class View
public void tabNameUpdated()
public javax.swing.Icon getTabIcon()
LogPage
getTabIcon
in interface LogPage
public java.lang.String getToolTip()
LogPage
getToolTip
in interface LogPage
public void setOwner(LogOwner owner)
LogPage
view
that owns this page.public void addMouseListener(java.awt.event.MouseListener listener)
addMouseListener
in interface LogPage
listener
- mouse listener responsible for displaying a context menu.public void removeMouseListener(java.awt.event.MouseListener listener)
removeMouseListener
in interface LogPage
listener
- mouse listener responsible for displaying a context menu.public View getLogPageView()
LogPage
View
implementation backing this LogPage. If
the LogPage itself is a View, then getLogPageView should return
this
.getLogPageView
in interface LogPage
public boolean isDisplayComponentScrollable()
public java.awt.Component getTopComponent()
public java.awt.Component getBottomComponent()
protected void logMsg(java.lang.Object msg)
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.msg
- the message to display.protected void requestShow(boolean forceDisplay)
forceDisplay
- protected void requestShow()
log
method and it will make
sure that this page is the selected page if the log window has
not been closed by the user.public Controller getController()
ControllerProvider
Controller
associated with this view.getController
in interface ControllerProvider
getController
in class View
public void show()
View