TriggerableEventReference (adams-pom 24.11.0-SNAPSHOT API)

java.lang.Object
- adams.core.base.BaseObject
- - adams.core.base.AbstractBaseString
  - - adams.flow.core.AbstractActorReference
    - - adams.flow.core.EventReference
      - adams.flow.core.TriggerableEventReference

All Implemented Interfaces:

CloneHandler<BaseObject>, Serializable, Comparable
```
public class TriggerableEventReference
extends EventReference
```
Wrapper around the name of a triggerable event (= string).

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- Fields inherited from class adams.core.base.BaseObject
  m_Internal, m_Properties, SUFFIX_DISPLAY, SUFFIX_VALUE

Constructor Summary

Constructors
Constructor	Description
`TriggerableEventReference()`	Initializes the string with length 0.
`TriggerableEventReference(String s)`	Initializes the object with the string to parse.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

String getTipText()
Returns a tool tip for the GUI editor (ignored if null is returned).
- Methods inherited from class adams.core.base.AbstractBaseString
  convert, getValue, initialize, isEmpty, isValid, length, setValue, stringValue
- Methods inherited from class adams.core.base.BaseObject
  compareTo, equals, getClone, getInternal, getTemplates, getUnicode, hasFavoritesSupport, hashCode, isValidUnicode, newInstance, setUnicode, toObjectArray, toObjectArray, toString, toStringArray, toStringList
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TriggerableEventReference
```
public TriggerableEventReference()
```
    Initializes the string with length 0.
  - TriggerableEventReference
```
public TriggerableEventReference(String s)
```
    Initializes the object with the string to parse.
    
    Parameters:
    
    s - the string to parse
- Method Detail
  - getTipText
```
public String getTipText()
```
    Returns a tool tip for the GUI editor (ignored if null is returned).
    
    Overrides:
    
    getTipText in class EventReference
    
    Returns:
    
    the tool tip