com.caplin.motif.fx.blotter

Class FXBlotterPublisher

java.lang.Object

com.caplin.motif.fx.blotter.FXBlotterPublisher

public class FXBlotterPublisher
extends Object

This class is responsible for creating and sending messages that relate to the blotter itself, for example the initial blotter image and subsequently any structural changes such as items being added or removed. Instances of this class are created by calling FXBlotterAdapter.createBlotterPublisher(FXBlotter, FXBlotterProvider).

This publisher only publishes the blotter container messages. A separate publisher FXBlotterItemPublisher must be created and used to publish the items within the blotter.

Prefer to use this publisher over FXCachedBlotterPublisher if you have your blotter configured to go through Liberator but not Transformer, and will be handling the sorting and filtering yourself.

Constructor Summary

Constructors

Constructor and Description
FXBlotterPublisher(CachedPublisher publisher, FXBlotterMessageFactory messageFactory) Deprecated. You should not need to create an instance of this. Instead instances should be obtained from the FXBlotterAdapter by calling FXBlotterAdapter.createBlotterPublisher(FXBlotter, FXBlotterProvider).

Method Summary

Modifier and Type	Method and Description
FXBlotterMessageFactory	getMessageFactory() Returns the message factory, to be used to create the FXBlotterMessage
void	publish(SendableBlotterMessage message) Should be used to publish an instance of SendableBlotterMessage Typically this is expected to be the FXBlotterMessage

Methods inherited from class java.lang.Object

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

Constructor Detail

FXBlotterPublisher

@Deprecated
public FXBlotterPublisher(CachedPublisher publisher,
                                      FXBlotterMessageFactory messageFactory)

Deprecated. You should not need to create an instance of this. Instead instances should be obtained from the FXBlotterAdapter by calling FXBlotterAdapter.createBlotterPublisher(FXBlotter, FXBlotterProvider).

Parameters:

publisher - The CachedPublisher to send container messages with.

messageFactory - The factory to build the container messages.

Method Detail

getMessageFactory

public FXBlotterMessageFactory getMessageFactory()

Returns the message factory, to be used to create the FXBlotterMessage

Returns:

The message factory.

publish

public void publish(SendableBlotterMessage message)

Should be used to publish an instance of SendableBlotterMessage Typically this is expected to be the FXBlotterMessage

Parameters:

message - The object representing the container message to be sent.