Package ca.phon.app.session.editor

Record Class EditorEventType<T>

java.lang.Object

java.lang.Record

ca.phon.app.session.editor.EditorEventType<T>

public record EditorEventType<T>(String eventName, Class<T> type)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	EditorEventType.RecordAddedData
static final record	EditorEventType.RecordChangedData
static final record	EditorEventType.RecordDeletedData
static final record	EditorEventType.RecordExcludedChangedData
static final record	EditorEventType.RecordMovedData
static final record	EditorEventType.SessionDateChangedData
static final record	EditorEventType.SessionLangChangedData
static final record	EditorEventType.SessionMediaChangedData
static final record	EditorEventType.SpeakerChangedData
static final record	EditorEventType.TierChangeData
static final record	EditorEventType.TierLockChangedData
static final record	EditorEventType.TierViewChangedData

Field Summary

Fields

Modifier and Type	Field	Description
static final EditorEventType<Void>	EditorClosing	Called when the editor is about to close
static final EditorEventType<Void>	EditorFinishedLoading	Fired after the editor has been initialized
static final EditorEventType<Void>	EditorReloadFromDisk	Editor should reload contents from disk
static final EditorEventType<Void>	GroupListChange	Fired when the number of phonetic groups changes
static final EditorEventType<Boolean>	ModifiedFlagChanged	Notifies on changes to the modification flag
static final EditorEventType<Participant>	ParticipantAdded	A participant was added
static final EditorEventType<Participant>	ParticipantChanged	Participant data has changed
static final EditorEventType<Participant>	ParticipantRemoved	A participant was removed
static final EditorEventType<EditorEventType.RecordAddedData>	RecordAdded	Called when a new record is added to the open session
static final EditorEventType<EditorEventType.RecordChangedData>	RecordChanged	Current record has changed in editor
static final EditorEventType<EditorEventType.RecordDeletedData>	RecordDeleted	Called when a record is removed from the open session
static final EditorEventType<EditorEventType.RecordExcludedChangedData>	RecordExcludedChanged	Fired when user clicks on the exclude record from searches box
static final EditorEventType<EditorEventType.RecordMovedData>	RecordMoved	Called when a record is moved
static final EditorEventType<EditorEventType.RecordChangedData>	RecordRefresh	Called when the editor wants a refresh of the view for the current record
static final EditorEventType<MediaSegment>	SegmentPlayback	Request playback of provided media segment
static final EditorEventType<Session>	SessionChanged	Session has changed in editor
static final EditorEventType<EditorEventType.SessionDateChangedData>	SessionDateChanged	Session date change
static final EditorEventType<EditorEventType.SessionLangChangedData>	SessionLangChanged	Session language change
static final EditorEventType<SessionLocation>	SessionLocationChanged	Position of caret changed in record tiers
static final EditorEventType<EditorEventType.SessionMediaChangedData>	SessionMediaChanged	Session media change
static final EditorEventType<Session>	SessionSaved	Editor has saved the session
static final EditorEventType<EditorEventType.SpeakerChangedData>	SpeakerChanged	Change to speaker for record
static final EditorEventType<EditorEventType.TierChangeData>	TierChange	Changes in tier data, usually fired during value adjustments.
static final EditorEventType<EditorEventType.TierChangeData>	TierChanged	Changes in tier data.
static final EditorEventType<EditorEventType.TierLockChangedData>	TierLockChanged	Tier lock has changed
static final EditorEventType<EditorEventType.TierViewChangedData>	TierViewChanged	Tier view has changed

Constructor Summary

Constructors

Constructor	Description
EditorEventType(String eventName, Class<T> type)	Creates an instance of a EditorEventType record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	eventName()	Returns the value of the eventName record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
Class<T>	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

EditorFinishedLoading

public static final EditorEventType<Void> EditorFinishedLoading

Fired after the editor has been initialized

EditorReloadFromDisk

public static final EditorEventType<Void> EditorReloadFromDisk

Editor should reload contents from disk

EditorClosing

public static final EditorEventType<Void> EditorClosing

Called when the editor is about to close

SessionSaved

public static final EditorEventType<Session> SessionSaved

Editor has saved the session

SessionChanged

public static final EditorEventType<Session> SessionChanged

Session has changed in editor

SessionDateChanged

public static final EditorEventType<EditorEventType.SessionDateChangedData> SessionDateChanged

Session date change

SessionLangChanged

public static final EditorEventType<EditorEventType.SessionLangChangedData> SessionLangChanged

Session language change

SessionMediaChanged

public static final EditorEventType<EditorEventType.SessionMediaChangedData> SessionMediaChanged

Session media change

TierViewChanged

public static final EditorEventType<EditorEventType.TierViewChangedData> TierViewChanged

Tier view has changed

TierLockChanged

public static final EditorEventType<EditorEventType.TierLockChangedData> TierLockChanged

Tier lock has changed

ParticipantAdded

public static final EditorEventType<Participant> ParticipantAdded

A participant was added

ParticipantRemoved

public static final EditorEventType<Participant> ParticipantRemoved

A participant was removed

ParticipantChanged

public static final EditorEventType<Participant> ParticipantChanged

Participant data has changed

RecordAdded

public static final EditorEventType<EditorEventType.RecordAddedData> RecordAdded

Called when a new record is added to the open session

RecordDeleted

public static final EditorEventType<EditorEventType.RecordDeletedData> RecordDeleted

Called when a record is removed from the open session

RecordMoved

public static final EditorEventType<EditorEventType.RecordMovedData> RecordMoved

Called when a record is moved

RecordChanged

public static final EditorEventType<EditorEventType.RecordChangedData> RecordChanged

Current record has changed in editor

RecordRefresh

public static final EditorEventType<EditorEventType.RecordChangedData> RecordRefresh

Called when the editor wants a refresh of the view for the current record

SessionLocationChanged

public static final EditorEventType<SessionLocation> SessionLocationChanged

Position of caret changed in record tiers

SpeakerChanged

public static final EditorEventType<EditorEventType.SpeakerChangedData> SpeakerChanged

Change to speaker for record

TierChange

public static final EditorEventType<EditorEventType.TierChangeData> TierChange

Changes in tier data, usually fired during value adjustments.

TierChanged

public static final EditorEventType<EditorEventType.TierChangeData> TierChanged

Changes in tier data. This event is fired when tier data has been committed (such as when the current record field is changed)

RecordExcludedChanged

public static final EditorEventType<EditorEventType.RecordExcludedChangedData> RecordExcludedChanged

Fired when user clicks on the exclude record from searches box

GroupListChange

public static final EditorEventType<Void> GroupListChange

Fired when the number of phonetic groups changes

ModifiedFlagChanged

public static final EditorEventType<Boolean> ModifiedFlagChanged

Notifies on changes to the modification flag

SegmentPlayback

public static final EditorEventType<MediaSegment> SegmentPlayback

Request playback of provided media segment

Constructor Details

EditorEventType

public EditorEventType(String eventName,
 Class<T> type)

Creates an instance of a EditorEventType record class.

Parameters:

eventName - the value for the eventName record component

type - the value for the type record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

eventName

public String eventName()

Returns the value of the eventName record component.

Returns:

the value of the eventName record component

type

public Class<T> type()

Returns the value of the type record component.

Returns:

the value of the type record component