Caplin Trader 3.11.4
Series manages data fetching from a backend system using the service aliased by
caplin.chart-service.
caplin.chart-service service.
ComponentLifecycleEvents interface is implemented by classes that need to observe a particular
component's life-cycle events.
CompositeComponent class represents the view, in MVC terms, of the composite component.
CompositeComponentFactory class is a blueprint for a factory
that parses the serialized representation of a CompositeComponent
and instantiates and returns a corresponding instance.
CompositeComponentFactoryProxy class is a blueprint for proxy
objects that parse the XML DOM representation of a CompositeComponent
and instantiates and returns a corresponding instance on behalf of the
CompositeComponentFactory.
caplin.component.ErrorComponent when it fails to create a normal
caplin.component.Component.
ComponentFactory is the interface component factories that are to be accessed via the
caplin.component.ComponentFactory should implement.
ComponentFrame are used to wrap components before they are displayed on the
screen.
DialogFrame are used to wrap components displayed within floating
windows.
FrameManager interface allows caplin.component.Component
instances to be viewed within the application.
PanelFrame are used to wrap components displayed as part of the main
application or page.
InstrumentReceiver interface is primarily implemented by components that wish to
participate in drag&drop operations.
AbstractMenu contains all the functionality for the following classes:
The concrete Menu classes themselves merely provide helpful constructor methods to making using
AbstractMenu easier.
Menu interface is implemented by the following concrete classes:
This is a basic control that is used to display an image and capture user gestures (when an appropriate handler is configured).
FilterInputControl is a composite control for displaying a low and high values together using
one Renderer.
PriceControl is the most basic implementation of a piece of text on the screen that is
controlled through the Renderer framework.
RangeInputControl is used to display low/high ranges.
SpreadControl is used to display bid/ask price.
Control is a screen control with which a user interacts, such as an input box, a drop-down box, or a
straightforward text label.
ControlFramework interface specifies those lifecycle functions that are necessary for a control
implementation to be managed by the Control Framework.
The core library is responsible for providing low level language extensions to JavaScript.
AliasRegistry is used to provide access to the aliases used within
the application.
caplin.core.Error extends the built in Error and allows the
error type to be specified in the constructor.
Like OpenAjax Hub, the caplin EventHub class facilitates
inter-component communication between components that have no prior knowledge of each other.
Observable is a generic implementation of the Observer design pattern that
allows an object that wants to notify other objects (the observers) of events that it raises to
do so by using the Observable to handle the boiler plate code, such as the
registration and management of the list of observers.
ThreadVisualizer allows the scheduling information generated by caplin.core.scheduler.ThreadScheduler
to be visualised as a graphical time-line.
ServiceRegistry is used to allow a given application access to application services.
caplin.dom.alert.StandardAlertDispatcher is an implementation
of the caplin.services.UserPromptService service.
Event class provides a uniform interface over the W3C event object, which is implemented
differently in IE than it is in standards compliant browsers.
The ViewFixture enables interacting with the rendered view via ViewFixtureHandlers.
BackgroundImage ViewFixtureHandler can be used to test the background image value.
Blurred ViewFixtureHandler can be used to trigger blur or focus events on the view element.
BorderColor ViewFixtureHandler can be used to test the border color of an element.
BorderWidth ViewFixtureHandler can be used to test the border width of an element.
BottomMarginWidth ViewFixtureHandler can be used to test the bottom margin width of an element.
Checked ViewFixtureHandler can be used to trigger checked property of a checkbox or a radiobutton.
ChildrenCount ViewFixtureHandler can be used to get number of child elements for a view element.
ClassName ViewFixtureHandler can be used to get a class of a view element.
Clicked ViewFixtureHandler can be used to trigger a click on a view element.
Color ViewFixtureHandler can be used to test the bottom margin width of an element.
DoesNotHaveClass ViewFixtureHandler can be used to verify that a view element
does not have a particular class.
Enabled ViewFixtureHandler can be used to enable and disable a view element
by setting the disabled attribute.
Focused ViewFixtureHandler can be used to trigger focus and blur on a view element.
FocusIn ViewFixtureHandler can be used to trigger focusin on a view element.
FocusOut ViewFixtureHandler can be used to trigger focusout on a view element.
HasClass ViewFixtureHandler can be used to verify that a view element
has a particular class.
Height ViewFixtureHandler can be used to get height of a view element.
IsVisible ViewFixtureHandler can be used to check if a view element is visible.
LeftMarginWidth ViewFixtureHandler can be used to test the left margin width of an element.
MouseDown ViewFixtureHandler can be used to trigger mousedown event for a view element.
MouseMove ViewFixtureHandler can be used to trigger mousemove event for a view element.
MouseOut ViewFixtureHandler can be used to trigger mouseout event for a view element.
MouseOver ViewFixtureHandler can be used to trigger mouseover event for a view element.
MouseUp ViewFixtureHandler can be used to trigger mouseup event for a view element.
Options ViewFixtureHandler can be used to set or get the value of options property
for a SELECT view element.
ReadOnly ViewFixtureHandler can be used to set or get the readonly attribute of an input view element
Example usage:
then("ticket.view.
RightClicked ViewFixtureHandler can be used to trigger contextmenu event for a view element.
RightMarginWidth ViewFixtureHandler can be used to test the right margin width of an element.
ScrolledHorizontal ViewFixtureHandler can be used to trigger a horizontal scroll on a view element.
ScrolledVertical ViewFixtureHandler can be used to trigger a vertical scroll on a view element.
Selected ViewFixtureHandler can be used to get or set selected
property of an OPTION view element.
Text ViewFixtureHandler can be used to set or get text property of a view element.
Top ViewFixtureHandler can be used to get style.top value of a view element.
TopMarginWidth ViewFixtureHandler can be used to test the top margin width of an element.
TypedValue ViewFixtureHandler can be used to simulate typing a value into an input view element.
Value ViewFixtureHandler can be used to set or get value property of a view element.
Classes implementing ViewFixtureHandler interface are used by ViewFixture to interact
with the elements in the rendered view.
Width ViewFixtureHandler can be used to get width of a view element.
DisplayBuffer class manages a 'throttle thread' that wakes up at regular intervals and refreshes
buffered controls that have registered a request to refresh and/or flash.
Renderer based on pre-loaded XML renderer definitions.
Formatter is used to convert values from one format to another.
ct.i18n.time.format.separator to give two digit groups.
Handler is used to trap specific user-gestures on a control
and inform all registered listeners.
CombinedFilterHandler handles filter changes when used in conjunction with
a caplin.control.basic.InputControl, usually specified in a rendereDefinitions.xml file.
Parser is typically used to take a user-input string and convert
it to a machine-readable format.
Renderer transforms machine readable data to a screen caplin.control.Control, and
captures user gestures which are then communicated back to one or more
caplin.element.RendererEventListeners.
RendererEventListener should be implemented by an object that is interested in receiving Renderer events.
ControlFramework interface specifies those lifecycle functions that are necessary
for a control implementation to be managed by the Control Framework.
Styler is used to changes some visual aspect of a control.
NumericSignStyler adds a 'positive' class to numbers greater than zero, a 'negative' class to numbers less than zero,
and a 'zero' class to numbers that are exactly zero.
caplin.presenter.node.AutoCompleteSelectionField
caplin.fx.services.CurrencyPairService
that uses the permission service for a source of currency pairs.
caplin.fx.services.TenorService
that uses the permission service for a source of tenors.
The interface represents a service that retrieves FX business date information.
BusinessDateGenerator serves to create settlement dates and calendars.
BusinessDateServiceFixture serves to interact with the mock business date provider by
setting business dates on it.
FXTradeLeg is a concrete implementation of {@link caplin.trading.trademodel.TradeLeg TradeLeg} that
aims to provide most of the fields typically used for FX Trades.
The SLJSContainerDataProvider class allows grids to be populated using an RTTP container available on
a Liberator that is connected to using StreamLinkJS.
DataProviderRowModel is the default implementation of caplin.grid.GridRowModel,
and attempts to perform all the generic tasks that a caplin.grid.GridRowModel can provide, but
delegates all the implementation specific jobs of caplin.grid.GridRowModel to the
caplin.grid.GridDataProvider it is associated with.
The ColumnMenuDecorator adds a menu to each column that allows the user to add or remove columns as
necessary.
The ColumnMenuDecorator adds a menu to each column that allows the user to add or remove columns as
necessary.
ColumnReorderingDecorator adds the ability to change the order of columns.
The ColumnResizingDecorator allows the user to resize columns.
ColumnSortDecorator adds sort behaviour to the column headers.
ContainerExportDecorator enable exporting of container contents to CSV file
Via eventhub
The drag decorator is used to allow the dragging of instruments from within grids configured with the drag decorator, to other grids or trade panels configured with the drop decorator.
The drop decorator is used to allow receiving instruments that have been dragged onto a grid configured with this decorator from other grids or trade panels configured with the drag decorator.
GridDecorator interface is implemented by classes that wish to augment the functionality
provided by the core grid implementation.
The GroupHeaderDecorator adjusts the styling of rows that are intended to act as subheadings for groups of data.
The HoverDecorator is used to show which row the user is currently hovering over.
LoadingDataDecorator renders a spinning wait icon whenever the grid is
waiting for data to arrive, so that users can see what is happening.
NoDataFoundBubbleMessageDecorator renders a bubble containing an
explanatory message header and body over any grid when there is no data to be
displayed.
RemoveRowDecorator class provides immediate visual feedback of a rows pending
removal until the server round-trip has completed, and the row is actually removed from the view.
The ResetColumnsDecorator class provides a single button users can use to remove any column filters
they may have applied, and/or reset the column sort order to original state.
The RowLoadingDecorator provides a loading image (e.g.
ScrollTipDecorator is a grid decorator that is used to display a tooltip during scrolling.
The SelectionDecorator is used to allow the user to select rows, so that operations can be applied
to those rows.
StatusDecorator is a grid decorator that is used to inject the fields CONTAINER_STATUS and/or
RECORD_STATUS into the grid model when a record status change happens.
DummyGridDataProvider defines provider for grids that wish to connect to RTTP containers.
FilterExpression that represents a filter for a single field.
FilterExpression that represents how a collection of
FilterExpressions should be evaluated together to determine whether a particular
record matches their expectation.
oColumnFilter object.
A GridColumn represents a column within the grid, and allows
the width of the column, and any sort order or display filters to be accessed
and/or modified.
GridColumnFilter is a used to restrict the rows present within a grid by omitting all records that
do not match some given filter(s).
The GridColumnModel is one of the two models that are used within a grid assembly — the other
being the caplin.grid.GridRowModel.
GridColumnModelListener defines an interface for classes that wish to listen to
caplin.grid.GridColumnModel events.
GridComponentFactory is a factory that is used to create grids based on an XML definition file.
GridDataProvider classes allow data from different data sources to be displayed within a grid when
used in conjunction with an instance of caplin.grid.DataProviderRowModel.
This interface is implemented by the caplin.grid.DataProviderRowModel so that caplin.grid.GridDataProvider instances are able to communicate data changes as they occur.
The GridRowModel is one of the two models that are used within a grid assembly — the other
being the caplin.grid.GridColumnModel.
GridRowModelListener defines an interface for classes that wish to listen to
{@link caplin.grid.GridRowModel GridRowModel} events.
The class within the caplin.grid package that is responsible
for displaying the rows specified within the provided
caplin.grid.GridRowModel, and the columns specified within the
provided caplin.grid.GridColumnModel.
PersonalGridDataProvider builds on the caplin.grid.RttpContainerGridDataProvider
class, but allows users to define their own RTTP containers from the client-side.
Provides the caplin.grid.sort.SortRule interface, and related classes.
FieldSortRule class allows simple, non custom, sorting by a given field-name, using
standard comparator operators.
SyntheticGridDataProvider defines a provider for grids that generates a simple
increments each cells content every second.
This class can be used to supply a caplin grid's caplin.grid.DataProviderRowModel with data retrieved from a web service.
Provides the caplin.i18n.Translator class which is responsible for converting localization tokens
into translated text.
caplin.i18n package that is responsible for translating localization tokens in the
form of @{key.name} into translated text.
LayoutManagerWorkbenchTool is a caplin.workbench.ui.WorkbenchComponent that can be added to the
workbench tools.
caplin.menu.Control will be in charge of rendering into the screen any
caplin.menu.Model.
caplin.menu.Generator represents the view control for any
caplin.menu.Model inserted on a menu.
caplin.menu.Generator represents the default view control for any
caplin.menu.model.Item inserted in a menu.
caplin.menu.generator.Menu represents the default view control for
caplin.menu.model.Menu objects.
caplin.menu.Model represents an item that can be inserted into a menu with
some default enable/disable functionality.
caplin.menu.model.Item represents a default item that can be inserted into a menu.
caplin.menu.model.Menu is the model representation of a menu.
PresentationNode which will serve as the control node
for the caplin.menu.presenter.Control.
MenuModelFixture serves to create a context for testing the menu by interacting with a
provided caplin.menu.model.Menu.
The PresenterComponent class allows Caplin components (widgets that can be embedded
within a layout or opened within a dialog) to be constructed using a caplin.presenter.PresentationModel
and an HTML template.
OptionsNodeList that is populated with values retrieved from
the caplin.services.security.PermissionService singleton.
MessageServicePropertyFactory class allows caplin.presenter.property.Property instances to
be created for the fields of records subscribed to from a caplin.services.messaging.MessageService.
PresentationNode containing all of the attributes necessary to
model a button on screen.
PresentationNode containing all of the attributes necessary to model a
date input field on screen.
PresentationNode containing all of the attributes necessary to
model a non-input field on screen.
PresentationNode containing all of the attributes necessary to
model an input field on screen.
PresentationNode containing all of the attributes necessary to
model a multi-selection field on screen.
NodeList is a caplin.presenter.node.PresentationNode, that is itself a
list of presentation nodes.
OptionsNodeList class is used to store the options available within
caplin.presenter.node.SelectionField and caplin.presenter.node.MultiSelectionField
instances.
PresentationNode containing all of the attributes necessary to
model a selection field on screen.
PresentationNode containing all of the attributes necessary to
model an input field on screen with a tool tip box that will be displayed when
a validation error has been produced.
The PresentationModel is used to transform a set of domain models into
a form that is tightly aligned with the view that will be used to display and edit those
domain models.
Alias instances wrap instances of caplin.presenter.property.Property and keep the
values synchronised, to allow access to the same property from multiple paths (e.g.
DelayedNotificationProperty is a subclass of
caplin.presenter.property.Property that will allow you to
decide when to notify observers about a value change instead of
having this automatically done whenever the internal value changes.
EditableProperty is identical to caplin.presenter.property.WritableProperty,
except that it also has the ability to be edited by users.
ISODateProperty is a caplin.presenter.property.WritableProperty,
representing an ISO date
Property are used to store all the values held within a
presentation model.
The snapshot class allows the state of a collection of properties to be preserved, so that it becomes possible to roll the properties back to a known state at a future point in time.
WritableProperty is identical to caplin.presenter.property.Property,
except that it adds the ability to update the value stored within the property.
PresentationModelFixture serves to manipulate and verify the state of the presentation
model of a presenter component.
PresenterComponentFixture serves to create presenter components in order to test the
component behavior.
CrossValidationPropertyBinder is used to associate a single
caplin.presenter.validator.CrossPropertyValidator instance with multiple
caplin.presenter.property.Property instances.
Services within BladeRunner.
ConnectionService.
caplin.services.messaging.MessageService.
Implements UserPromptService service by using standard browser prompts from the
window object.
caplin.services.providers.OpenPermissionService returns ALL
to all permission requests.
ServiceRegistryLoader class loads the core set of
Services required by an Application.
The ConnectionServiceFixture serves to create a mocking interface for a ConnectionSevice
to enable tests to simulate connection status changes as follows:
given(PM shows connection-down message)
when("connection.statusChanged => ['OK', 'Liberator has connected']")
then(PM no longer shows connection-down message)
The ConnectionServiceFixture possible values are OK, ERROR or LIMITED
The ConnectionServiceStub serves to create a stub for a ConnectionService
to enable tests to simulate connection status changes.
A stub implementation of caplin.services.messaging.MessageService for use in tests and workbenches.
PermissionServiceFixture serves to provide a way for tests to interact with the PermissioningService providing
trading and view allow or deny permissions on tiles and instruments
Use of the Fixture assumes that a caplin.trading.testing.PermissioningServiceStub is registered as a service on the caplin.core.ServiceRegistry under the namespace "caplin.services.security.PermissionService".
PermissionServiceStub serves to provide a way for tests to stub a
caplin.services.security.PermissionService providing
trading and view allow or deny permissions on tiles and instruments.
StreamlinkFixture server to provide a way for tests to interact with the StreamlinkStub.
The SubscriptionServiceStub serves to create a stub for a SubscriptionService
to enable tests to simulate a subscription.
ServiceRegistryLoader class loads the core set of Testing
Services and stubs required for testing a blade or application.
The UserPromptServiceStub serves to create a stub for a UserPromptService
to enable tests to simulate a user prompt service.
The UserServiceStub serves to create a stub for a UserService
to enable tests to simulate a user service.
By implementing the UserPromptService interface, clients can implement their own strategy for how they
deal with messages that need to be displayed to the user.
SL4BServiceRegistryLoader class compliments the
caplin.services.ServiceRegitryLoader by loading services specific to SL4B.
StreamLinkSubscription class provides a StreamLinkJS transport implementation of the
caplin.services.messaging.Subscription interface.
StreamLinkUserService is an implementation of a caplin.services.UserService
which retrieves the username from the StreamLink system.
StreamLinkServiceRegistryLoader class compliments the
caplin.services.ServiceRegitryLoader by loading services specific to StreamLink.
AlertFixture allows for testing of browser alerts.
DataSubscriptionFixture serves to create a context for providing mock price message updates, through
the use of 'caplin.message-service'.
Fixture is the interface for individual fixtures added to the GWTTestRunner.
TimeFixture allows you to control when callbacks passed to window.setTimeout() and window.setInterval() are executed.
setUp method which will be called
before each test is executed and can be used to reset the state of a test and its stubs.
FixtureRegistry allows for registration of fixtures for a
specified scope.
Derivation specifies how derived field values can be calculated using fields from the trade model as
their input.
RowSource for displaying trades within a grid.
This package contains classes to facilitate in the restoration of Trades.
The TOBOUserService is the interface designed for managing the activities of a client
user who is permissioned to trade on behalf of other (TOBO) users.
The TOBOUserServiceListener is the interface designed to be implemented by
listeners of the caplin.trading.service.TOBOUserService.
TOBOUserServiceProvider class provides a implementation of the caplin.trading.service.TOBOUserService
which uses the caplin.trading.service.TOBOUserPermissionServiceListener and the provided
caplin.trading.service.TradePermissionService to get the permissions of the currently logged-in
user, which users he can trade on behalf of, and which of there TOBO users' accounts can be used to this
end.
TradeService behaves as both a factory and repository for trades.
This service is meant to be used to configure the desired server events which will be used to feed the caplin.trading.workbench.TradeStateVisualiser.
A State represents one of the conditions that a caplin.trading.statemachine.StateMachine
StateMachine can be in.
StateMachine tracks state and manages transitions between them.
A InstrumentDataSubscriberStub replaces the caplin.trading.trademodel.SL4BInstrumentDataSubscriber for the purpose of testing ESP trades and trading components in acceptance tests and workbenches by propagating instrument data sent from a mock server component to the subscribed trade leg.
TOBOFixture serves to provide a way for tests to interact with the TOBOUserService by setting
the ability for the test to act as a user who can trade on behalf of other users, setting the list of TOBO
users and accounts that the test can user to trade on behalf of, and setting and querying the selected TOBO
user and account to trade with.
TradeMessageFixture serves to create a context for testing trade interactions, through
the use of a trade subscriber mock object.
InstrumentDataSubscriber instances are responsible for receiving asynchronous instrument data streams
from some publisher (the server) and forwarding them to a trade leg that is connected with that instrument.
The InvalidServerEventListener interface allows interested parties to be informed when an invalid
server event is encountered during the processing of server messages within the
caplin.trading.trademodel.Trade object.
The LegManager class keeps track of the TradeLegs for a Trade
It remembers changes to the Legs as StructureChangedEvents, which can be
retrieved with getPendingStructureChanges and clear when processed with
clearPendingStructureChanges.
The StreamingInstrumentDataSubscriber class provides a streaming transport implementation of the caplin.trading.trademodel.InstrumentDataSubscriber
StructureChangedEvent is created dispatched to indicate that the structure of
a trade has changed.
A Trade represents the exchange of a number of financial instruments between counter-parties.
Map.
The TradeLeg class represents the exchange of a financial instrument and the resultant cash flow.
The TradeLegFactory class is responsible for creating the correct instance of
caplin.trading.trademodel.TradeLeg, based on a given asset class.
The TradeMessageService is the interface between a caplin.trading.trademodel.Trade and the connector
that will perform the actual communication with the back-end trading system.
The TradeOnBehalfOfListener interface allows interested parties to be informed when a
"trade on behalf of" change is initiated by the caplin.trading.trademodel.TradeOnBehalfOf
object, and when the "trade on behalf of" change is completed.
The TradingStatusChangedListener is the interface that interested listeners should implement
to be alerted when trading becomes available or unavailable.
DateValidator is a caplin.trading.validation.Validator that provides functions to ensure supplied data contains valid dates.
caplin.trading.workbench.TradeStateVisualiser will create a state model ui representation that can
be manually controlled by the user.
WorkbenchComponent that visualises trade state and allows
for a states within a trade model to be stepped through.
webcentric library provides a rich UI framework for building enterprise applications.
WebcentricAlertDispatcher is an implementation of the caplin.webcentric.alert.AlertDispatcher
AlertDispatcher interface that uses webcentric to display alerts.
workbench library provides a set of components for building
workbench within a bladerunner application.
The caplin.workbench.connectionstatuseditor.WorkbenchConnectionStatusEditor will create a connection state UI representation
that can be manually controlled by the user.
DataGenerator generates a list of updates for a given set of
seed values.
The MiniStateMachine provides a simple configurable state Machine.
QuickForm provides a way to create forms using presenter by defining a list
of field names, values and buttons that will be used in the form.
WorkbenchDataEditor allows for manipulation of the subscriber data (for example, pricing)
via a caplin.services.messaging.Subscription.
WorkbenchPanel is the main container for displaying components
within a workbench.
WorkbenchPermissionEditor allows manipulation of permissions in the fake permission
service.