Package velox.api.layer1.messages

Class Layer1ApiAlertGuiMessage

java.lang.Object

velox.api.layer1.messages.Layer1ApiAlertGuiMessage

All Implemented Interfaces:

Layer1ApiStrategiesEchoMessagesLayer.StrategyEchoMessageFromLayer

public class Layer1ApiAlertGuiMessage
extends java.lang.Object
implements Layer1ApiStrategiesEchoMessagesLayer.StrategyEchoMessageFromLayer

Use this message to send GUI panels for configuration of Layer1ApiSoundAlertMessage's, created by your addon (specified via source

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Layer1ApiAlertGuiMessage.Builder

Field Summary

Fields

Modifier and Type	Field	Description
java.util.function.Function<Layer1ApiSoundAlertDeclarationMessage,StrategyPanel[]>	guiPanelsProvider	Function that returns GUI panels based on Layer1ApiSoundAlertDeclarationMessage If your GUI panels are opened with the intent to declare a new alert - the passed argument is null.
java.lang.String	id	Id can be used to reference this message
boolean	isAdd	True if this message adds GUI panels.
java.lang.Class<?>	source	Class that created this message.
java.lang.String	strategyName	Name of the strategy that created this message, extracted from Layer1StrategyName.value(), displayed on the UI

Method Summary

Modifier and Type	Method	Description
static Layer1ApiAlertGuiMessage.Builder	builder()	Creates builder to build Layer1ApiAlertGuiMessage.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Details

id

public final java.lang.String id

Id can be used to reference this message

source

public final java.lang.Class<?> source

Class that created this message. The class must be annotated with Layer1StrategyName

strategyName

public final java.lang.String strategyName

Name of the strategy that created this message, extracted from Layer1StrategyName.value(), displayed on the UI

guiPanelsProvider

public final java.util.function.Function<Layer1ApiSoundAlertDeclarationMessage,StrategyPanel[]> guiPanelsProvider

Function that returns GUI panels based on Layer1ApiSoundAlertDeclarationMessage
If your GUI panels are opened with the intent to declare a new alert - the passed argument is null. Otherwise a user wants to modify an existing Layer1ApiSoundAlertDeclarationMessage - in that case the function obtains this declaration as an argument. You can use this declaration to pre-populate fields in your GUI.

isAdd

public final boolean isAdd

True if this message adds GUI panels. Otherwise, the panels from a message with the same id will be removed

Method Details

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static Layer1ApiAlertGuiMessage.Builder builder()

Creates builder to build Layer1ApiAlertGuiMessage.

Returns:

created builder