org.eclipse.rse.ui.messages
Class SystemDialogPageMessageLine

java.lang.Object
  org.eclipse.rse.ui.messages.SystemDialogPageMessageLine

All Implemented Interfaces:

EventListener, ISystemMessageLine, MouseListener, SWTEventListener

Deprecated.

DO NOT USE THIS CLASS!

This class attempts to wrap the message constructs of eclipse provided property and wizard pages with an ISystemMessageLine interface. It fails to do this properly and is extremely fragile since it depends on knowledge of the internal structure of eclipse provided windows.

Use SystemMessageLine instead.

public class SystemDialogPageMessageLine

extends Object

implements ISystemMessageLine, MouseListener

Method Summary

void	clearErrorMessage() Deprecated. Clears the currently displayed error message and redisplayes the message which was active before the error message was set.
void	clearMessage() Deprecated. Clears the currently displayed non-error message.
static SystemDialogPageMessageLine	createPropertyPageMsgLine(PropertyPage propertyPage) Deprecated. Factory method for property pages.
static SystemDialogPageMessageLine	createWizardMsgLine(WizardPage wizardPage) Deprecated. Factory method for wizard pages.
SystemMessage	getCurrentMessage() Deprecated. Method to return the current system message to display.
String	getErrorMessage() Deprecated. Get the currently displayed error text.
String	getMessage() Deprecated. Get the currently displayed message.
protected SystemMessage	getSysErrorMessage() Deprecated.
protected SystemMessage	getSysMessage() Deprecated.
SystemMessage	getSystemErrorMessage() Deprecated. Get the currently displayed error text.
void	internalSetErrorMessage(String msg) Deprecated. Someone has called setErrorMessage(String) on the dialog page.
void	internalSetMessage(String msg) Deprecated. Someone has called setMessage(String) on the dialog page.
void	mouseDoubleClick(MouseEvent event) Deprecated. User double clicked with the mouse
void	mouseDown(MouseEvent event) Deprecated. User pressed the mouse button
void	mouseUp(MouseEvent event) Deprecated. User released the mouse button after pressing it
void	setErrorMessage(String emessage) Deprecated. DO NOT CALL THIS METHOD!
void	setErrorMessage(SystemMessage emessage) Deprecated. Display the given error message.
void	setErrorMessage(Throwable exc) Deprecated. Convenience method to set an error message from an exception
void	setMessage(String msg) Deprecated. DO NOT CALL THIS METHOD!
void	setMessage(SystemMessage smessage) Deprecated. Set a non-error message to display.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

createWizardMsgLine

public static SystemDialogPageMessageLine createWizardMsgLine(WizardPage wizardPage)

Deprecated.

Factory method for wizard pages. We only need to configure a single message line for all pages in a given wizard, so this method looks after ensuring there is only one such message line created.

Parameters:

wizardPage - - the wizard page we are configuring

createPropertyPageMsgLine

public static SystemDialogPageMessageLine createPropertyPageMsgLine(PropertyPage propertyPage)

Deprecated.

Factory method for property pages. We only need to configure a single message line for all pages in a properties dialog, so this method looks after ensuring there is only one such message line created.

Parameters:

propertyPage - - the property page we are configuring

getSysErrorMessage

protected SystemMessage getSysErrorMessage()

Deprecated.

getSysMessage

protected SystemMessage getSysMessage()

Deprecated.

getSystemErrorMessage

public SystemMessage getSystemErrorMessage()

Deprecated.

Get the currently displayed error text.

Specified by:

getSystemErrorMessage in interface ISystemMessageLine

Returns:

The error message. If no error message is displayed null is returned.

clearErrorMessage

public void clearErrorMessage()

Deprecated.

Clears the currently displayed error message and redisplayes the message which was active before the error message was set.

Specified by:

clearErrorMessage in interface ISystemMessageLine

clearMessage

public void clearMessage()

Deprecated.

Clears the currently displayed non-error message.

Specified by:

clearMessage in interface ISystemMessageLine

getErrorMessage

public String getErrorMessage()

Deprecated.

Get the currently displayed error text.

Specified by:

getErrorMessage in interface ISystemMessageLine

Returns:

The error message. If no error message is displayed null is returned.

getMessage

public String getMessage()

Deprecated.

Get the currently displayed message.

Specified by:

getMessage in interface ISystemMessageLine

Returns:

The message. If no message is displayed null is returned.

setErrorMessage

public void setErrorMessage(String emessage)

Deprecated.

DO NOT CALL THIS METHOD! IT IS ONLY HERE BECAUSE THE INTERFACE NEEDS IT. RATHER, CALL THE SAME MSG THAT DIALOGPAGE NOW SUPPORTS, AND THEN CALL setInternalErrorMessage HERE. WE HAVE TO AVOID INFINITE LOOPS.

Specified by:

setErrorMessage in interface ISystemMessageLine

setErrorMessage

public void setErrorMessage(SystemMessage emessage)

Deprecated.

Display the given error message. A currently displayed message is saved and will be redisplayed when the error message is cleared.

Specified by:

setErrorMessage in interface ISystemMessageLine

setErrorMessage

public void setErrorMessage(Throwable exc)

Deprecated.

Convenience method to set an error message from an exception

Specified by:

setErrorMessage in interface ISystemMessageLine

setMessage

public void setMessage(String msg)

Deprecated.

DO NOT CALL THIS METHOD! IT IS ONLY HERE BECAUSE THE INTERFACE NEEDS IT. RATHER, CALL THE SAME MSG THAT DIALOGPAGE NOW SUPPORTS, AND THEN CALL setInternalMessage HERE. WE HAVE TO AVOID INFINITE LOOPS.

Specified by:

setMessage in interface ISystemMessageLine

setMessage

public void setMessage(SystemMessage smessage)

Deprecated.

Set a non-error message to display. If the message line currently displays an error, the message is stored and will be shown after a call to clearErrorMessage

Specified by:

setMessage in interface ISystemMessageLine

internalSetMessage

public void internalSetMessage(String msg)

Deprecated.

Someone has called setMessage(String) on the dialog page. It needs to then call this method after calling super.setMessage(String) so we can keep track of what is happening.

internalSetErrorMessage

public void internalSetErrorMessage(String msg)

Deprecated.

Someone has called setErrorMessage(String) on the dialog page. It needs to then call this method after calling super.setErrorMessage(String) so we can keep track of what is happening.

mouseDoubleClick

public void mouseDoubleClick(MouseEvent event)

Deprecated.

User double clicked with the mouse

Specified by:

mouseDoubleClick in interface MouseListener

mouseDown

public void mouseDown(MouseEvent event)

Deprecated.

User pressed the mouse button

Specified by:

mouseDown in interface MouseListener

mouseUp

public void mouseUp(MouseEvent event)

Deprecated.

User released the mouse button after pressing it

Specified by:

mouseUp in interface MouseListener

getCurrentMessage

public SystemMessage getCurrentMessage()

Deprecated.

Method to return the current system message to display. If error message is set, return it, else return message.