Home | Class Index

SDK Version: 3.3.0-262647

Documentation generated on 14 June 2013

Class
caplin.workbench.statemodelvisualiser

WorkbenchMiniStateModelVisualiser

Implements caplin.workbench.ui.WorkbenchComponent

The caplin.workbench.statemodelvisualiser.WorkbenchMiniStateModelVisualiser will create a state model ui representation that can be manually controlled by the user.

This workbench widget will use a TradeService which will have to implement the caplin.trading.workbench.model.StateMonitorImplementor interface in order to provide a way of exposing the state machine.


To use this class, configure the desired server events and add it to a {@link caplin.workbench.ui.Workbench} object. E.g.
var oStateModelVisualiser = new caplin.workbench.statemodelvisualiser.WorkbenchMiniStateModelVisualiser();

oStateModelVisualiser.setServerDataForTransition("OpenAck", {"TradeID": "1234567"});
oStateModelVisualiser.setAutoServerEvents(["OpenAck", "PriceUpdate", "Execute", "ExecuteAck", "TradeConfirmation"]);

workbench.addToLeftWing(oStateModelVisualiser, "StateVisualiser"); .

Constructor Summary

Attributes Name and Description
caplin.workbench.statemodelvisualiser.WorkbenchMiniStateModelVisualiser()

Method Summary

Attributes Name and Description
void getElement()

void setAutoServerEvents(Array pServerEvents)

Define which will be the events that will automatically be served.
void setServerDataForTransition(String sTransitionName, Map mData)

Defines the data that is needed for the server transitions received by the caplin.trading.trademodel.TradeMessageService when 'auto server data' switch is on.

Constructor Detail

► caplin.workbench.statemodelvisualiser.WorkbenchMiniStateModelVisualiser()

Method Detail

► void setAutoServerEvents(Array pServerEvents)

Define which will be the events that will automatically be served.

Parameters
Array pServerEvents The array of events that will be served in case no user interaction is selected.

► void setServerDataForTransition(String sTransitionName, Map mData)

Defines the data that is needed for the server transitions received by the caplin.trading.trademodel.TradeMessageService when 'auto server data' switch is on. If is is off, the data will be selected by the user.

Parameters
String sTransitionName The transition name
Map mData Map with the data the transition will generate