Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.1.0)

E13403-02

oracle.ide.runner
Class RunLogPage

java.lang.Object
  extended by oracle.ide.view.View
      extended by oracle.ide.log.AbstractLogPage
          extended by oracle.ide.log.MessagePage
              extended by oracle.ide.runner.RunLogPage
All Implemented Interfaces:
ControllerProvider, Helpable, LogPage

public final class RunLogPage
extends MessagePage
implements Helpable

The RunLogPage class is the LogPage used for a running process.


Nested Class Summary
 
Nested classes/interfaces inherited from class oracle.ide.log.MessagePage
MessagePage.CustomTextPane
 
Field Summary
 
Fields inherited from class oracle.ide.log.MessagePage
_scrollPane, _textComponent, MESSAGE_PAGE_ID
 
Fields inherited from class oracle.ide.view.View
EMPTY_SELECTION, PROJECT_PROP, VISIBLE_PROP, WORKSPACE_PROP
 
Method Summary
protected  void appendToTextComponent(java.lang.String msg, int maxLogLines)
          Adds the given message to the message page, removing lines from the top, if necessary, so it contains no more than maxLogLines
protected  void clearTextComponent()
          Clears the text component
 void close()
           
protected  MessagePage.CustomTextPane createStyledTextPane()
           
protected  void deleteFromStartOfTextComponent(int linesToDelete, int offset)
          Deletes the linesToDelete from the message page
 java.awt.Component getBottomComponent()
          Gets the component to put in the bottom component position in the log page display.
 Context getContext(java.util.EventObject event)
          Returns the Context that is associated with this log page.
 boolean getDontForceOutput()
           
 java.awt.Component getGUI()
          This method is for internal use only and should not be called directly by an addin.
 HelpInfo getHelpInfo()
          Returns the HelpInfo for this log page.
 java.lang.String getName()
          Returns the name for this log page.
 Project getProject()
          Returns the Project associated with this log page.
 RunProcess getRunProcess()
          Returns the RunProcess associated with this log page.
 java.lang.String getTitleName()
          Returns the title name for this log page.
 java.lang.String getToolTip()
          Returns the tooltip for this log page.
 java.lang.String getToolTipText()
           
 java.awt.Component getTopComponent()
          Gets the component to put in the top component position in the log page display By default returns getLogPageView().getToolbar()
 Workspace getWorkspace()
          Returns the Workspace associated with this log page.
 boolean isProcessAlive()
          Returns whether any process using this log page is still alive.
 void log(java.lang.Object msg)
          Display the specified msg in this log page.
 void logWithoutShow(java.lang.Object msg)
           
 void setDontForceOutput(boolean dfo)
           
 void setNorthComponent(java.awt.Component northComponent)
          Sets the component to be positioned in the NORTH section of the RunLogPage.
 void show()
          Shows the view if hidden.
 void showPage()
           
 void updateVisibleActions(UpdateMessage updateMessage)
          Called when the IDE or an extension requests that the View updates the enabled state of any actions that are visible on screen.
 
Methods inherited from class oracle.ide.log.MessagePage
addHref, addMouseListener, addStyle, checkLogOpen, clearAll, findHrefByOffset, getContextMenu, getController, getText, getWrapLines, logMsg, removeMouseListener, replaceTextComponentDocument, setController, setLogFileName, setWrapLines, updateToolTipText
 
Methods inherited from class oracle.ide.log.AbstractLogPage
getLogPageView, getTabIcon, getTabName, isDisplayComponentScrollable, isVisible, log, logQuietly, requestShow, requestShow, setOwner, tabNameUpdated
 
Methods inherited from class oracle.ide.view.View
activate, addViewListener, addViewSelectionListener, addViewStateListener, deactivate, fireViewCollapsed, fireViewExpanded, fireViewSelectionChanged, getContext, getId, getSelection, getSelectionFromUI, getToolbar, getViewWithoutDecoration, loadLayout, loadManifestToolbar, loadManifestToolbar, newId, owner, removeViewListener, removeViewSelectionListener, removeViewStateListener, saveLayout, scheduleUpdateSelection, setId, setOwner, setToolbarVisible, toString, updateSelection, updateSelectionImpl, updateTitle, updateToolbarActions, updateVisibleActions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getTopComponent

public java.awt.Component getTopComponent()
Description copied from class: AbstractLogPage
Gets the component to put in the top component position in the log page display By default returns getLogPageView().getToolbar()

Overrides:
getTopComponent in class AbstractLogPage
Returns:
the component to put in the top component position in the log page display

getBottomComponent

public java.awt.Component getBottomComponent()
Description copied from class: AbstractLogPage
Gets the component to put in the bottom component position in the log page display. By default returns null.

Overrides:
getBottomComponent in class AbstractLogPage
Returns:
the component to put in the bottom component position in the log page display

getGUI

public java.awt.Component getGUI()
This method is for internal use only and should not be called directly by an addin.

Overrides:
getGUI in class MessagePage
Returns:
component that provides the UI for the message page

createStyledTextPane

protected MessagePage.CustomTextPane createStyledTextPane()
Overrides:
createStyledTextPane in class MessagePage
Returns:
the text pane used for displaying styled text.

getContext

public Context getContext(java.util.EventObject event)
Returns the Context that is associated with this log page.

Overrides:
getContext in class View
Parameters:
event - event associated with the context.
Returns:
the Context

updateVisibleActions

public void updateVisibleActions(UpdateMessage updateMessage)
Description copied from class: View
Called when the IDE or an extension requests that the View updates the enabled state of any actions that are visible on screen. Typically this will involve updating actions that are in visible toolbars. If a View contains or manages other nested instances of View, the outer call to updateVisibleActions should propagate inward to call the updateVisibleActions of all visible, nested Views.

Overrides:
updateVisibleActions in class View
Parameters:
updateMessage - information on what is triggering the update. Implementations may make use of this information to decide whether or not an update is necessary, since updating the enabled state of a toolbar button may be a lengthy operation. For example, buttons that control a remote debugger would involve network I/O and evaluating their updated state could be avoided if the updateMessage indicates that the source of the update is not relevant to the debugger.

getName

public java.lang.String getName()
Returns the name for this log page.

Returns:
the name

getWorkspace

public Workspace getWorkspace()
Returns the Workspace associated with this log page.


getProject

public Project getProject()
Returns the Project associated with this log page.


getToolTipText

public java.lang.String getToolTipText()

getToolTip

public java.lang.String getToolTip()
Returns the tooltip for this log page.

Specified by:
getToolTip in interface LogPage
Overrides:
getToolTip in class AbstractLogPage
Returns:
the tooltip to display when tabbed.

getTitleName

public java.lang.String getTitleName()
Returns the title name for this log page.

Specified by:
getTitleName in interface LogPage
Overrides:
getTitleName in class AbstractLogPage
Returns:
the title to display in the host's title bar.

getHelpInfo

public HelpInfo getHelpInfo()
Returns the HelpInfo for this log page.

Specified by:
getHelpInfo in interface Helpable
Overrides:
getHelpInfo in class MessagePage
Returns:
the help info associated with the message page

isProcessAlive

public boolean isProcessAlive()
Returns whether any process using this log page is still alive.


getRunProcess

public RunProcess getRunProcess()
Returns the RunProcess associated with this log page.


log

public void log(java.lang.Object msg)
Display the specified msg in this log page.

Specified by:
log in interface LogPage
Overrides:
log in class AbstractLogPage
Parameters:
msg - the message to display.

logWithoutShow

public void logWithoutShow(java.lang.Object msg)

setDontForceOutput

public void setDontForceOutput(boolean dfo)

getDontForceOutput

public boolean getDontForceOutput()

appendToTextComponent

protected void appendToTextComponent(java.lang.String msg,
                                     int maxLogLines)
Description copied from class: MessagePage
Adds the given message to the message page, removing lines from the top, if necessary, so it contains no more than maxLogLines

Overrides:
appendToTextComponent in class MessagePage
Parameters:
msg - the message to add
maxLogLines - the maximum number of lines to display

deleteFromStartOfTextComponent

protected void deleteFromStartOfTextComponent(int linesToDelete,
                                              int offset)
Description copied from class: MessagePage
Deletes the linesToDelete from the message page

Overrides:
deleteFromStartOfTextComponent in class MessagePage

clearTextComponent

protected void clearTextComponent()
Description copied from class: MessagePage
Clears the text component

Overrides:
clearTextComponent in class MessagePage

showPage

public void showPage()

setNorthComponent

public void setNorthComponent(java.awt.Component northComponent)
Sets the component to be positioned in the NORTH section of the RunLogPage.


show

public void show()
Description copied from class: View
Shows the view if hidden. Raises the view to the top if covered by other windows.

Overrides:
show in class AbstractLogPage

close

public void close()
Overrides:
close in class AbstractLogPage

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.1.0)

E13403-02

Copyright © 1997, 2009, Oracle. All rights reserved.