Package velox.api.layer1.annotations
-
Enum Summary Enum Description Layer1ApiVersionValue List of API versions. -
Annotation Types Summary Annotation Type Description Layer1ApiDisableOnLoad Marks strategy that can not be auto enabled on load based on settings, no matter what it's previous state wasLayer1ApiPublic Items marked with this annotation are exposed as part of L1 API.Layer1ApiVersion Accepts integer value specifying API version that was used to write this module.Layer1Attachable Marks classes that can be loaded from GUI as a strategy.
Should implement AutoCloseable, close will be called when unloading.
When strategy is loaded and is correctly injected in layers chain, it will receive
UserMessageLayersChainCreatedTargetedmessage viaLayer1ApiAdminListener.onUserMessage(Object)(you need to implement it)
After this, you can interact withLayer1ApiProvider, received in your constructor.
When strategy is no longer in layers chain,Layer1ApiFinishable.finish()will be called (you need to implement it)
You can interact withLayer1ApiProviderinsideLayer1ApiFinishable.finish()method, if your previous state allowed it (see below for details*)
After method is completed, you can not interact withLayer1ApiProvider.
*Note, that there is no guarantee that ifLayer1ApiFinishable.finish()is called,UserMessageLayersChainCreatedTargetedfor this strategy was received.
(i.e.Layer1ChartControlVisbility User will be able to control this strategy (enable/disable) via visibility popup menu
Note that this menu is intended to control only visual components present on main chart, not bottom panelLayer1Injectable Marks classes that can be loaded from GUI as a strategy.
Class will be injected in layers chain.
Should implement AutoCloseable, close will be called when unloading.
When strategy is loaded and is correctly injected in layers chain, it will recieve
UserMessageLayersChainCreatedTargetedmessage viaLayer1ApiAdminListener.onUserMessage(Object)(you need to implement it)
After this, you can interact withLayer1ApiProvider, received in your construtor.
When strategy is no longer in layers chain,Layer1ApiFinishable.finish()will be called (you need to implement it)
You can interact withLayer1ApiProviderinsideLayer1ApiFinishable.finish()method, if your previous state allowed it (see below for details*)
After method is completed, you can not interact withLayer1ApiProvider.
*Note, that there is no guarantee that ifLayer1ApiFinishable.finish()is called,UserMessageLayersChainCreatedTargetedfor this strategy was received.
(i.e.Layer1SimpleAttachable Marks classes that can be loaded from GUI as a strategy.
Simplified version of Layer1 API, for more advanced (but more complex) version useLayer1AttachableLayer1StrategyDateLicensed Use this annotation if your strategy should only be available if it user has corresponding license field set to a date ahead of current date.Layer1StrategyName Specifies a name for strategy that will be displayed in strategies dialogLayer1TradingStrategy Mark strategy as trading strategy, not allowing it to be used in non demo real tradingLayer1UpstreamDataEditor Tells bookmap that strategy will be modifying upstream data (e.g.MaximumSupportedFeatures Similar toLayer1ApiAdminProvider.getSupportedFeatures(), but is used to declare provider capabilities before provider is actually instantiated.PublishWithoutJavadoc UnrestrictedData Bookmap will only trust this annotation if module is signed.