HelpMessageEvent (jPicEdt 1.4.1_03 API documentation)

java.lang.Object
- jpicedt.graphic.event.HelpMessageEvent

```
public class HelpMessageEvent
extends java.lang.Object
```
A class that allows an EditorKit to post help-messages (or tooltips) that make sense with the current operation being performed. This may be used e.g. by the UI machinery.

Since:

jpicedt 1.3.2

Version:

$Id: HelpMessageEvent.java,v 1.5.2.1 2007/09/02 11:56:18 reynal Exp $

Author:

Sylvain Reynal

Constructor Summary

Constructors
Constructor Description

HelpMessageEvent(EditorKit source, java.lang.String message)
contruct a new event

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getMessage()`	Return the help-message.
`EditorKit`	`getSource()`	Return the editor kit that sourced this event.
`java.lang.String`	`toString()`	Return a String representation of this event for debugging purpose.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - HelpMessageEvent
```
public HelpMessageEvent(EditorKit source,
                        java.lang.String message)
```
    contruct a new event
    
    Parameters:
    
    source - the editorkit that sourced the event
    
    message - the help-message
- Method Detail
  - getSource
```
public EditorKit getSource()
```
    Return the editor kit that sourced this event.
  - getMessage
```
public java.lang.String getMessage()
```
    Return the help-message.
  - toString
```
public java.lang.String toString()
```
    Return a String representation of this event for debugging purpose.
    
    Overrides:
    
    toString in class java.lang.Object