wt.eff
Class EffGroupAssistantEvent

java.lang.Object
  extended by wt.events.KeyedEvent
      extended by wt.eff.EffGroupAssistantEvent
All Implemented Interfaces:
Serializable, wt.events.summary.SummarizedEvent

public class EffGroupAssistantEvent
extends KeyedEvent
implements Serializable

Events emitted by the EffGroupAssistant for customization purposes.

Supported API: true

Extendable: false

See Also:
Serialized Form

Field Summary
static String POST_APPEND_EFF_GROUPS
          A constant that defines an event key that marks the occurrence of the pre-append (by the appendEffGroups API) event.
static String POST_APPEND_EFF_VECTOR
          A constant that defines an event key that marks the occurrence of the post-append event.
static String POST_REPLACE_EFF_VECTOR
          A constant that defines an event key that marks the occurrence of the post-replace event.
static String PRE_APPEND_EFF_GROUPS
          A constant that defines an event key that marks the occurrence of the pre-append (by the appendEffGroups API) event.
static String PRE_APPEND_EFF_VECTOR
          A constant that defines an event key that marks the occurrence of the pre-append event.
static String PRE_REPLACE_EFF_VECTOR
          A constant that defines an event key that marks the occurrence of the pre-replace event.
 
Method Summary
 EffGroup[] getEffGroups()
          Gets the value of the attribute: effGroups; The groups (used only by the PRE/POST_APPEND_EFF_GROUPS events.
 EffRecordable[] getEffRecordables()
          Gets the value of the attribute: effRecordables; The target of the event.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PRE_REPLACE_EFF_VECTOR

public static final String PRE_REPLACE_EFF_VECTOR
A constant that defines an event key that marks the occurrence of the pre-replace event.

Supported API: true

See Also:
Constant Field Values

POST_REPLACE_EFF_VECTOR

public static final String POST_REPLACE_EFF_VECTOR
A constant that defines an event key that marks the occurrence of the post-replace event.

Supported API: true

See Also:
Constant Field Values

PRE_APPEND_EFF_VECTOR

public static final String PRE_APPEND_EFF_VECTOR
A constant that defines an event key that marks the occurrence of the pre-append event.

Supported API: true

See Also:
Constant Field Values

POST_APPEND_EFF_VECTOR

public static final String POST_APPEND_EFF_VECTOR
A constant that defines an event key that marks the occurrence of the post-append event.

Supported API: true

See Also:
Constant Field Values

PRE_APPEND_EFF_GROUPS

public static final String PRE_APPEND_EFF_GROUPS
A constant that defines an event key that marks the occurrence of the pre-append (by the appendEffGroups API) event.

Supported API: true

See Also:
Constant Field Values

POST_APPEND_EFF_GROUPS

public static final String POST_APPEND_EFF_GROUPS
A constant that defines an event key that marks the occurrence of the pre-append (by the appendEffGroups API) event.

Supported API: true

See Also:
Constant Field Values
Method Detail

getEffRecordables

public EffRecordable[] getEffRecordables()
Gets the value of the attribute: effRecordables; The target of the event.

Supported API: true

Returns:
EffRecordable[]

getEffGroups

public EffGroup[] getEffGroups()
Gets the value of the attribute: effGroups; The groups (used only by the PRE/POST_APPEND_EFF_GROUPS events.

Supported API: true

Returns:
EffGroup[]