synergynet3.projector.network.messages

Class ContentTransferedMessage

java.lang.Object

synergynet3.web.shared.messages.PerformActionMessage

synergynet3.projector.network.messages.ContentTransferedMessage

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ContentTransferedMessage>

public class ContentTransferedMessage
extends PerformActionMessage
implements java.io.Serializable, java.lang.Comparable<ContentTransferedMessage>

Structured message representing the item, its target and trajectory when transferred through a network flick.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class synergynet3.web.shared.messages.PerformActionMessage

PerformActionMessage.MESSAGESTATE

Constructor Summary

Constructors

Constructor and Description
ContentTransferedMessage() Empty Constructor used to initialise value in the network cluster.
ContentTransferedMessage(java.lang.String[] targetDeviceIDs, GalleryItemDatabaseFormat galleryItem, float x, float y, float targetAngle, float targetScale, int zOrder, boolean visible, java.lang.String itemName) Create a structured network flick message for transmission through the cluster.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(ContentTransferedMessage other) Allows sorting of items by their Z-Orders.
GalleryItemDatabaseFormat	getGalleryItem() Get the object representing the transfered item and its attached feedback.
java.lang.String	getItemName() Get the item name.
float	getRotation() Get the rotation of the transfered item on arrival.
float	getScale() Get the scale of the transfered item on arrival.
java.lang.String[]	getTargetDeviceIDs() Get the target device's IDs in the cluster.
float	getX() Get the X value of the transfered item's arrival location.
float	getY() Get the Y value of the transfered item's arrival location.
int	getZOrder() Get the transfered item's z level.
boolean	isVisible()
void	setGalleryItem(GalleryItemDatabaseFormat galleryItem) Set the object representing the transfered item and its attached feedback.
void	setItemName(java.lang.String itemName) Set the item name.
void	setRotation(float rotation) Set the rotation of the transfered item on arrival.
void	setScale(float scale) Set the scale of the transfered item on arrival.
void	setTargetDeviceIDs(java.lang.String[] targetDeviceIDs) Set the target device's IDs in the cluster.
void	setVisible(boolean visible)
void	setX(float x) Set the X value of the transfered item's arrival location.
void	setY(float y) Set the Y value of the transfered item's arrival location.
void	setZOrder(int zOrder) Set the transfered item's z level.

Methods inherited from class synergynet3.web.shared.messages.PerformActionMessage

getMessageID, getMessageState, messageAlreadyReceived, regenerateID

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentTransferedMessage

public ContentTransferedMessage()

Empty Constructor used to initialise value in the network cluster.

ContentTransferedMessage

public ContentTransferedMessage(java.lang.String[] targetDeviceIDs,
                        GalleryItemDatabaseFormat galleryItem,
                        float x,
                        float y,
                        float targetAngle,
                        float targetScale,
                        int zOrder,
                        boolean visible,
                        java.lang.String itemName)

Create a structured network flick message for transmission through the cluster.

Parameters:

targetDeviceIDs - List of target table's identity in the cluster.

galleryItem - Object representing the transfered item and its attached feedback.

x - The X value of the transfered item's arrival location.

y - The Y value of the transfered item's arrival location.

targetAngle - Rotation of the transfered item on arrival.

targetScale - Scale of the transfered item on arrival. *

zOrder - the zOrder ID of the transfered item.

Visibility - of the item being transferred.

itemName - the unique ID of the transfered item.

Method Detail

compareTo

public int compareTo(ContentTransferedMessage other)

Allows sorting of items by their Z-Orders.

Specified by:

compareTo in interface java.lang.Comparable<ContentTransferedMessage>

Parameters:

other - Another instance of ContentTransferedMessage.

getGalleryItem

public GalleryItemDatabaseFormat getGalleryItem()

Get the object representing the transfered item and its attached feedback.

Returns:

Object representing the transfered item and its attached feedback.

getItemName

public java.lang.String getItemName()

Get the item name.

Returns:

String representing the transfered item's name.

getRotation

public float getRotation()

Get the rotation of the transfered item on arrival.

Returns:

The rotation of the transfered item on arrival.

getScale

public float getScale()

Get the scale of the transfered item on arrival.

Returns:

The scale of the transfered item on arrival.

getTargetDeviceIDs

public java.lang.String[] getTargetDeviceIDs()

Get the target device's IDs in the cluster.

Returns:

String representing the target devices' IDs

getX

public float getX()

Get the X value of the transfered item's arrival location.

Returns:

The X value of the transfered item's arrival location.

getY

public float getY()

Get the Y value of the transfered item's arrival location.

Returns:

The Y value of the transfered item's arrival location.

getZOrder

public int getZOrder()

Get the transfered item's z level.

Returns:

String representing Z level of the transfered item.

isVisible

public boolean isVisible()

Returns:

the visible

setGalleryItem

public void setGalleryItem(GalleryItemDatabaseFormat galleryItem)

Set the object representing the transfered item and its attached feedback.

Parameters:

galleryItem - Object representing the transfered item and its attached feedback.

setItemName

public void setItemName(java.lang.String itemName)

Set the item name.

Parameters:

itemName - Name of the item.

setRotation

public void setRotation(float rotation)

Set the rotation of the transfered item on arrival.

Parameters:

rotation - The rotation of the transfered item on arrival.

setScale

public void setScale(float scale)

Set the scale of the transfered item on arrival.

Parameters:

scale - The scale of the transfered item on arrival.

setTargetDeviceIDs

public void setTargetDeviceIDs(java.lang.String[] targetDeviceIDs)

Set the target device's IDs in the cluster.

Parameters:

targetDeviceIDs - The target devices' IDs

setVisible

public void setVisible(boolean visible)

Parameters:

visible - the visible to set

setX

public void setX(float x)

Set the X value of the transfered item's arrival location.

Parameters:

x - The X value of the transfered item's arrival location.

setY

public void setY(float y)

Set the Y value of the transfered item's arrival location.

Parameters:

y - The Y value of the transfered item's arrival location.

setZOrder

public void setZOrder(int zOrder)

Set the transfered item's z level.

Parameters:

sourceID - Z level of the transfered item.