com.caplin.motif.fx.blotter.message

Class FXBlotterMessage

java.lang.Object

com.caplin.motif.fx.blotter.message.FXBlotterMessage

All Implemented Interfaces:

SendableBlotterMessage

public class FXBlotterMessage
extends Object
implements SendableBlotterMessage

Instances of this class should be created using FXBlotterMessageFactory.createBlotterMessage(String) or FXBlotterMessageFactory.createBlotterMessage(com.caplin.motif.fx.blotter.subject.FXBlotterSubjectInfo)

Field Summary

Fields

Modifier and Type	Field and Description
protected FXBlotter	blotter
protected Map<String,ContainerAction>	containerActions
protected boolean	isImage
protected String	subject
protected String	username

Method Summary

Modifier and Type	Method and Description
void	addItem(FXBlotter blotter, String itemId) Adds an element to the top of the blotter.
void	addItem(String itemId) Adds an element to the top of the blotter.
FXBlotter	getBlotter() Returns the FXBlotter object that this object was instantiated with.
List<ContainerAction>	getContainerActions() A List of actions represented by ContainerAction to be performed on the Container.
String	getSubject() The subject for this Container
String	getUsername() The username for which this Container belongs to.
boolean	isImage() Returns the value of the image flag
void	removeItem(FXBlotter blotter, String itemId) Removes the element from the blotter, with the item subject as created by the given FXBlotter object
void	removeItem(String itemId) Removes the element from the container with the specified item id
void	setImage(boolean isImage) Sets the image flag for this Container message.

Methods inherited from class java.lang.Object

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

Field Detail

blotter

protected final FXBlotter blotter

username

protected final String username

subject

protected String subject

isImage

protected boolean isImage

containerActions

protected final Map<String,ContainerAction> containerActions

Method Detail

setImage

public void setImage(boolean isImage)

Sets the image flag for this Container message. If the image flag is set to true, this message replaces any current state of the Container that has been aggregated from previous messages, and represents the new definitive state of the Container.

Specified by:

setImage in interface SendableBlotterMessage

Parameters:

isImage - True if this message should be treated as an image, or false if it represents an update.

addItem

public void addItem(String itemId)

Adds an element to the top of the blotter. This only adds the subject and not the data. A data for the item should come as a request on FXBlotterItemProvider.onItemRequest(com.caplin.motif.fx.blotter.subject.FXBlotterItemSubjectInfo)

Parameters:

itemId - The id of the Record Item, to be part of the item subject

addItem

public void addItem(FXBlotter blotter,
                    String itemId)

Adds an element to the top of the blotter. The item subject however is created using the FXBlotter object provided. Prefer this method over addItem(String) if you have a Blotter with Record constituents with different item subjects.

This only adds the subject and not the data. A data for the item should come as a request on FXBlotterItemProvider.onItemRequest(com.caplin.motif.fx.blotter.subject.FXBlotterItemSubjectInfo)

Parameters:

blotter - The object containing the item regex, to be used when creating the item subject.

itemId - The id of the Record Item, to be part of the item subject

removeItem

public void removeItem(String itemId)

Removes the element from the container with the specified item id

Parameters:

itemId - The ID of the Record item.

removeItem

public void removeItem(FXBlotter blotter,
                       String itemId)

Removes the element from the blotter, with the item subject as created by the given FXBlotter object

Parameters:

blotter - The object containing the item regex, to be used when creating the item subject.

itemId - The ID of the Record Item

getBlotter

public FXBlotter getBlotter()

Returns the FXBlotter object that this object was instantiated with.

Returns:

The FXBlotter item that this object was instantiated with.

isImage

public boolean isImage()

Description copied from interface: SendableBlotterMessage

Returns the value of the image flag

Specified by:

isImage in interface SendableBlotterMessage

Returns:

The value of the image flag

getSubject

public String getSubject()

Description copied from interface: SendableBlotterMessage

The subject for this Container

Specified by:

getSubject in interface SendableBlotterMessage

Returns:

The subject for this Container

getUsername

public String getUsername()

Description copied from interface: SendableBlotterMessage

The username for which this Container belongs to.

Specified by:

getUsername in interface SendableBlotterMessage

Returns:

The username for which this Container belongs to.

getContainerActions

public List<ContainerAction> getContainerActions()

Description copied from interface: SendableBlotterMessage

A List of actions represented by ContainerAction to be performed on the Container.

Specified by:

getContainerActions in interface SendableBlotterMessage

Returns:

A List of actions represented by ContainerAction to be performed on the Container.