Package com.openfin.desktop
Class WindowGroupChangeEvent
java.lang.Object
com.openfin.desktop.WindowGroupChangeEvent
public class WindowGroupChangeEvent
extends java.lang.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 Description WindowGroupChangeEvent(Ack payload, DesktopConnection desktopConnection)
Constructor -
Method Summary
Modifier and Type Method Description java.lang.String
getMemberOf()
Which group array the window that the event listener was registered on is included in.java.lang.String
getName()
Name of the windowjava.lang.String
getReason()
The reason this event was triggered.java.util.List<Window>
getSourceGroup()
All the windows in the group the sourceWindow originated fromjava.lang.String
getSourceWindowAppUuid()
The UUID of the application the sourceWindow belongs to.java.lang.String
getSourceWindowName()
The name of the sourcewindow.java.util.List<Window>
getTargetGroup()
All the windows in the group the targetWindow orginated fromjava.lang.String
getTargetWindowAppUuid()
The UUID of the application the targetWindow belongs to.java.lang.String
getTargetWindowName()
The name of the targetWindow.java.lang.String
getUuid()
The UUID of the application the window belongs to
-
Constructor Details
-
WindowGroupChangeEvent
public WindowGroupChangeEvent(Ack payload, DesktopConnection desktopConnection) throws org.json.JSONExceptionConstructor- Parameters:
payload
- JSONObject payloaddesktopConnection
- desktop connection- Throws:
org.json.JSONException
-
-
Method Details
-
getMemberOf
public java.lang.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 java.lang.String getName()Name of the window- Returns:
- value of name
-
getReason
public java.lang.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
All the windows in the group the sourceWindow originated from- Returns:
- list of Windows
-
getSourceWindowAppUuid
public java.lang.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 java.lang.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
All the windows in the group the targetWindow orginated from- Returns:
- list of Windows
-
getTargetWindowAppUuid
public java.lang.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 java.lang.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 java.lang.String getUuid()The UUID of the application the window belongs to- Returns:
- application UUID
-