DefaultFileMessage Class

com.bea.ide.ui.output
DefaultFileMessage Class

public class DefaultFileMessage

    extends OutputMessage

The Default file message provides a simple way to output a message relevant to a line and column of a particular file for example: compiler errors or find results. It's a fairly simple extension of the OutputMessage class.

Related Topics

OutputMessage


Hierarchy
Object
  OutputMessage
    DefaultFileMessage
All Implemented Interfaces

ActionListener, EventListener

Field Summary

public static final Icon
ERROR_ICON
The error icon for messages corresponding to errors
public static final Icon
WARNING_ICON
The warning icon for messages corresponding to warnings
   
Fields from  com.bea.ide.ui.output.OutputMessage
_color, _hitArea, _icon, _obj, _res, _showIcons, COLOR_DEFAULT, COLOR_ERROR, COLOR_IGNORE, COLOR_INFO, COLOR_WARNING
 

Constructor Summary

DefaultFileMessage(URI fileURI, String fileDisplay, int line, int col, String description, String prescription, boolean isError)

Constructor that takes all relevant information and builds a message to output it.
 

Method Summary

public int
getColumn()
getLine() and getColumn() are used in conjunction with getURI() to indicate where to position cursor when the document is opened.
public Icon
getIcon()
Icon to be displayed, can be over-ridden to delay compute the desired icon.
public int
getLine()
getLine() and getColumn() are used in conjunction with getURI() to indicate where to position cursor when the document is opened.
public String
getText()
Overrides getText() to return the same text as toString()
public URI
getURI()
The URI for the file.
public String
toString()
Overrides toString() to output the filename, followed by line and column and description
 
Methods from  com.bea.ide.ui.output.OutputMessage
actionPerformed, getColor, getHitArea, getUserObject, hasAction, setHitArea, setShowIcons, setText, StandardColor, useFixedCellHeight
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   
Methods from interface java.awt.event.ActionListener
actionPerformed
 

Field Detail

ERROR_ICON

public static final Icon ERROR_ICON
The error icon for messages corresponding to errors


WARNING_ICON

public static final Icon WARNING_ICON
The warning icon for messages corresponding to warnings

 

Constructor Detail

DefaultFileMessage

public DefaultFileMessage(URI fileURI, 
                          String fileDisplay, 
                          int line, 
                          int col, 
                          String description, 
                          String prescription, 
                          boolean isError)
Constructor that takes all relevant information and builds a message to output it.
 

Method Detail

getColumn() Method

public int getColumn()
Description copied from OutputMessage.getColumn()
getLine() and getColumn() are used in conjunction with getURI() to indicate where to position cursor when the document is opened.

Overrides
OutputMessage.getColumn()

Returns

returns the column to which the message pertains

getIcon() Method

public Icon getIcon()
Description copied from OutputMessage.getIcon()
Icon to be displayed, can be over-ridden to delay compute the desired icon.

Overrides
OutputMessage.getIcon()

Returns

error icon if isError passed to constructor, otherwise returns the warning icon

getLine() Method

public int getLine()
Description copied from OutputMessage.getLine()
getLine() and getColumn() are used in conjunction with getURI() to indicate where to position cursor when the document is opened.

Overrides
OutputMessage.getLine()

Returns

returns the line to which the message pertains

getText() Method

public String getText()
Overrides getText() to return the same text as toString()

Overrides
OutputMessage.getText()

Returns

string containing the text of this message

getURI() Method

public URI getURI()
The URI for the file.

Overrides
OutputMessage.getURI()

Returns

the URI passed in during the constructor

toString() Method

public String toString()
Overrides toString() to output the filename, followed by line and column and description

Overrides
OutputMessage.toString()

Returns

formatted string representing this message