com.openfin.desktop

Class WindowGroupChangeEvent

java.lang.Object

com.openfin.desktop.WindowGroupChangeEvent

public class WindowGroupChangeEvent
extends Object

Helper class for Populating values from the ACK of a window 'group-changed' payload

Since:

9/4/14

Author:

wche

Constructor Summary

Constructors

Constructor and Description
WindowGroupChangeEvent(Ack payload, DesktopConnection desktopConnection) Constructor

Method Summary

Modifier and Type	Method and Description
String	getMemberOf() Which group array the window that the event listener was registered on is included in.
String	getName() Name of the window
String	getReason() The reason this event was triggered.
List<Window>	getSourceGroup() All the windows in the group the sourceWindow originated from
String	getSourceWindowAppUuid() The UUID of the application the sourceWindow belongs to.
String	getSourceWindowName() The name of the sourcewindow.
List<Window>	getTargetGroup() All the windows in the group the targetWindow orginated from
String	getTargetWindowAppUuid() The UUID of the application the targetWindow belongs to.
String	getTargetWindowName() The name of the targetWindow.
String	getUuid() The UUID of the application the window belongs to

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowGroupChangeEvent

public WindowGroupChangeEvent(Ack payload,
                              DesktopConnection desktopConnection)
                       throws org.json.JSONException

Constructor

Parameters:

payload - JSONObject payload

desktopConnection - desktop connection

Throws:

org.json.JSONException

Method Detail

getMemberOf

public String getMemberOf()

Which group array the window that the event listener was registered on is included in. Possible values: 'source' The window is included in sourceGroup 'target' The window is included in targetGroup 'nothing' The window is not included in sourceGroup nor targetGroup,

Returns:

value of memberOf

getName

public String getName()

Name of the window

Returns:

value of name

getReason

public String getReason()

The reason this event was triggered. Possible values: 'leave' A window has left the group due to a leave or merge with group. 'join' A window has joined the group. 'merge' Two groups have been merged together. 'disband' There are no other windows in the group

Returns:

value of reason

getSourceGroup

public List<Window> getSourceGroup()

All the windows in the group the sourceWindow originated from

Returns:

list of Windows

getSourceWindowAppUuid

public String getSourceWindowAppUuid()

The UUID of the application the sourceWindow belongs to. The source window is the window in which (merge/join/leave)group(s) was called.

Returns:

value of sourceWindowAppUuid

getSourceWindowName

public String getSourceWindowName()

The name of the sourcewindow. The source window is the window in which (merge/join/leave)group(s) was called.

Returns:

value of sourceWindowName

getTargetGroup

public List<Window> getTargetGroup()

All the windows in the group the targetWindow orginated from

Returns:

list of Windows

getTargetWindowAppUuid

public String getTargetWindowAppUuid()

The UUID of the application the targetWindow belongs to. The target window is the window that was passed into (merge/join)group(s).

Returns:

value of targetWindowAppUuid

getTargetWindowName

public String getTargetWindowName()

The name of the targetWindow. The target window is the window that was passed into (merge/join)group(s)

Returns:

value of targetWindowName

getUuid

public String getUuid()

The UUID of the application the window belongs to

Returns:

application UUID