- getAllApplications(AckListener) - Method in class com.openfin.desktop.System
-
Retrieves an array of data (uuid, running/active state) for all application windows
The object passed to callback takes the form:
[
{
uuid: (string) uuid of the application,
isRunning: (bool) true when the application is running/active
},
...
- getAllWindows(AckListener) - Method in class com.openfin.desktop.System
-
The object passed to callback takes the form:
[
{
uuid: (string) uuid of the application,
mainWindow: {
name: (string) name of the main window,
top: (integer) top-most coordinate of the main window,
right: (integer) right-most coordinate of the main window,
bottom: (integer) bottom-most coordinate of the main window,
left: (integer) left-most coordinate of the main window
},
childWindows: [{
name: (string) name of the child window,
top: (integer) top-most coordinate of the child window,
right: (integer) right-most coordinate of the child window,
bottom: (integer) bottom-most coordinate of the child window,
left: (integer) left-most coordinate of the child window
},
...
- getAlwaysOnBottom() - Method in class com.openfin.desktop.WindowOptions
-
The AlwaysOnBottom property represents a flag to always position
the window at the bottom of the window stack.
- getApplicationIcon() - Method in class com.openfin.desktop.ApplicationOptions
-
Gets URL of application icon
- getAutoShow() - Method in class com.openfin.desktop.WindowOptions
-
The AutoShow property represents a flag to automatically
show the Window when it is created.
- getBooleanValue(JSONObject, String) - Static method in class com.openfin.desktop.JsonUtils
-
- getBooleanValue(String) - Method in class com.openfin.desktop.WindowOptions
-
Helper method to extract data field from underlying JSONObject
- getBounds(AsyncCallback<WindowBounds>, AckListener) - Method in class com.openfin.desktop.Window
-
Gets the current bounds (top, left, width, height) of the window
- getCommandLineArguments(AckListener) - Method in class com.openfin.desktop.System
-
Retrieves the command line argument string that started App Desktop
- getConfig(String, AckListener) - Method in class com.openfin.desktop.System
-
Retrieves the App Desktop's configuration
- getConnection() - Method in class com.openfin.desktop.Application
-
Returns the applications connection object
- getContextMenu() - Method in class com.openfin.desktop.WindowOptions
-
The ContextMenu property represents a flag to show the
context menu when right-clicking on a window.
- getCornerRoundingHeight() - Method in class com.openfin.desktop.WindowOptions
-
The CornerRoundingHeight property represents the rounded
corners to apply.
- getCornerRoundingWidth() - Method in class com.openfin.desktop.WindowOptions
-
The CornerRoundingHeight property represents the rounded
corners to apply.
- getData() - Method in class com.openfin.desktop.Ack
-
Returns the value of "data" from message as JObject
- getDefaultHeight() - Method in class com.openfin.desktop.WindowOptions
-
The DefaultWidth property represents the window's
default height in pixels.
- getDefaultLeft() - Method in class com.openfin.desktop.WindowOptions
-
The DefaultLeft property represents the window's
default left position.
- getDefaultTop() - Method in class com.openfin.desktop.WindowOptions
-
The DefaultTop property represents the window's
default top position.
- getDefaultWidth() - Method in class com.openfin.desktop.WindowOptions
-
The DefaultWidth property represents the window's
default width in pixels.
- getDeviceId(AckListener) - Method in class com.openfin.desktop.System
-
Gets Device ID
- getDoubleValue(JSONObject, String) - Static method in class com.openfin.desktop.JsonUtils
-
- getDoubleValue(String) - Method in class com.openfin.desktop.WindowOptions
-
Helper method to extract data field from underlying JSONObject
- getDraggable() - Method in class com.openfin.desktop.WindowOptions
-
The Draggable property represents a flag to allow
the user to drag the window by its client area.
- getDuration() - Method in class com.openfin.desktop.animation.OpacityTransition
-
Gets value of duration
- getDuration() - Method in class com.openfin.desktop.animation.PositionTransition
-
Gets value of duration
- getDuration() - Method in class com.openfin.desktop.animation.SizeTransition
-
Gets value of duration
- getEventObject() - Method in class com.openfin.desktop.ActionEvent
-
Gets event data object
- getFrame() - Method in class com.openfin.desktop.WindowOptions
-
The Frame property represents a flag to show the frame.
- getGroup(AsyncCallback<List<Window>>, AckListener) - Method in class com.openfin.desktop.Window
-
Passes a list of wrapped windows in the same group
An empty list is returned if the window is not in a group.
- getHeight() - Method in class com.openfin.desktop.animation.SizeTransition
-
Gets value of height
- getHeight() - Method in class com.openfin.desktop.WindowBounds
-
- getHideOnClose() - Method in class com.openfin.desktop.WindowOptions
-
The HideOnClose property represents a flag to allow a window
to be hidden when the close button is clicked.
- getIntegerValue(JSONObject, String) - Static method in class com.openfin.desktop.JsonUtils
-
- getIntegerValue(String) - Method in class com.openfin.desktop.WindowOptions
-
Helper method to extract data field from underlying JSONObject
- getInterApplicationBus() - Method in class com.openfin.desktop.DesktopConnection
-
Gets the Inter-Application message dispatcher associated with this DesktopConnection
- getInterrupt() - Method in class com.openfin.desktop.animation.AnimationOptions
-
Gets value of interrupt
The Interrupt property represents a flag which determines if a call to Window.animate
will interrupt all pending transitions, or add itself to the queue.
- getJson() - Method in class com.openfin.desktop.ApplicationOptions
-
Gets JSON representation of options
- getJson() - Method in class com.openfin.desktop.WindowOptions
-
Helper method to copy a JSONObject
- getJsonObject() - Method in class com.openfin.desktop.Ack
-
Returns the message as a JObject
- getJsonValue(JSONObject, String) - Static method in class com.openfin.desktop.JsonUtils
-
- getJsonValue(String) - Method in class com.openfin.desktop.WindowOptions
-
Helper method to extract data field from underlying JSONObject
- getLeft() - Method in class com.openfin.desktop.animation.PositionTransition
-
Gets value of left
- getLeft() - Method in class com.openfin.desktop.WindowBounds
-
- getLog(String, AckListener) - Method in class com.openfin.desktop.System
-
Retrieves the contents of the log with the specified filename
- getLogList(AckListener) - Method in class com.openfin.desktop.System
-
Retrieves an array of data objects for all available logs
Each object in the returned array takes the form:
{
name: (string) the filename of the log,
size: (integer) the size of the log in bytes,
date: (integer) the unix time at which the log was created
}
- getMainWindowOptions() - Method in class com.openfin.desktop.ApplicationOptions
-
Get options of main window
- getManifest(AckListener) - Method in class com.openfin.desktop.Application
-
Retrieves the JSON manifest that was used to create the application.
- getMaxHeight() - Method in class com.openfin.desktop.WindowOptions
-
The MaxHeight property represents the maximum height of a window.
- getMaximizable() - Method in class com.openfin.desktop.WindowOptions
-
The Maximizable property represents a flag that lets the window be maximized.
- getMaxWidth() - Method in class com.openfin.desktop.WindowOptions
-
The MaxWidth property represents the maximum width of a window.
- getMessage() - Method in class com.openfin.desktop.NotificationOptions
-
Gets Message property of the notification
- getMinHeight() - Method in class com.openfin.desktop.WindowOptions
-
The MinHeight property represents the minimum height of a window.
- getMinimizable() - Method in class com.openfin.desktop.WindowOptions
-
- getMinWidth() - Method in class com.openfin.desktop.WindowOptions
-
The MinWidth property represents the minimum width of a window.
- getMonitorInfo(AckListener) - Method in class com.openfin.desktop.System
-
Retrieves an object that contains data about the about the
monitor setup of the computer that App Desktop is running on.
- getMousePosition(AckListener) - Method in class com.openfin.desktop.System
-
Returns the mouse in virtual screen coordinates (left, top)
The returned object takes the form:
{
top: (integer) the top position of the mouse in virtual screen
coordinates,
left: (integer) the left position of the mouse in virtual screen
coordinates
}
- getName() - Method in class com.openfin.desktop.ApplicationOptions
-
Gets name of the application
- getName() - Method in class com.openfin.desktop.Window
-
Gets name
- getOpacity() - Method in class com.openfin.desktop.animation.AnimationTransitions
-
Sets Opacity transition
- getOpacity() - Method in class com.openfin.desktop.animation.OpacityTransition
-
Gets value of Opacity
- getOpacity() - Method in class com.openfin.desktop.WindowOptions
-
The Opacity property represents a flag that specifies
how transparent the window will be.
- getOptions() - Method in class com.openfin.desktop.animation.AnimationOptions
-
Gets options in JSON format
- getOptions() - Method in class com.openfin.desktop.Application
-
Get the ApplicationOptions object for the application
- getOptions(AsyncCallback<WindowOptions>, AckListener) - Method in class com.openfin.desktop.Window
-
Returns the current options as stored in the desktop
- getParentApplication() - Method in class com.openfin.desktop.Window
-
Returns the wrapped application that this window belongs to
- getParentWindow() - Method in class com.openfin.desktop.Window
-
Get parent window
- getPosition() - Method in class com.openfin.desktop.animation.AnimationTransitions
-
Gets position transition
- getProcessList(AckListener) - Method in class com.openfin.desktop.System
-
Retrieves an array of all App Desktop processes that are currently running
Each element in the array is an object containing the uuid
and the name of the application to which the process belongs.
- getProcessUuid() - Method in class com.openfin.desktop.LaunchExternalProcessResult
-
Gets process UUID
- getProcessUuid() - Method in class com.openfin.desktop.TerminateExternalProcessResult
-
- getProxySettings(AckListener) - Method in class com.openfin.desktop.System
-
Retrieves the proxy settings object
The proxy object the callback receives takes the following form:
{
type: (string) "system" or "named",
proxyAddress: (string) the address of the proxy server,
proxyPort: (integer) the port of proxy server
}
- getReason() - Method in class com.openfin.desktop.Ack
-
Return reason if Ack has error
- getResizable() - Method in class com.openfin.desktop.WindowOptions
-
The Resizable property represents a flag which allows
the user to resize the window.
- getResizeRegionBottomRightCorner() - Method in class com.openfin.desktop.WindowOptions
-
The ResizeRegionBottomRightCorner property defines an additional square region located at the bottom
right corner of a frameless window.
- getResizeRegionSize() - Method in class com.openfin.desktop.WindowOptions
-
The ResizeRegionSize property defines a region in pixels that will respond to user mouse interaction for
resizing a frameless window
- getResult() - Method in class com.openfin.desktop.TerminateExternalProcessResult
-
- getShowTaskbarIcon() - Method in class com.openfin.desktop.WindowOptions
-
The ShowTaskbarIcon property represents a flag to show
the Window's icon in the taskbar.
- getSize() - Method in class com.openfin.desktop.animation.AnimationTransitions
-
Gets size transition
- getSnapshot(AckListener) - Method in class com.openfin.desktop.Window
-
Gets a base64 encoded PN snapshot of the window
- getState(AckListener) - Method in class com.openfin.desktop.Window
-
Gets the current state ("minimized", "maximized", or "restored") of the window
- getState() - Method in class com.openfin.desktop.WindowOptions
-
The State property represents a string that sets the
window to be "minimized", "maximized", or "normal" on creation.
- getStringValue(String) - Method in class com.openfin.desktop.ApplicationOptions
-
Helper method for retrieving string value of a property
- getStringValue(JSONObject, String) - Static method in class com.openfin.desktop.JsonUtils
-
- getStringValue(String) - Method in class com.openfin.desktop.WindowOptions
-
Helper method to extract data field from underlying JSONObject
- getTaskbarIcon() - Method in class com.openfin.desktop.WindowOptions
-
The TaskbarIcon property represents the URL of
an icon to be shown on the desktop.
- getTimeout() - Method in class com.openfin.desktop.NotificationOptions
-
Gets timeout property of the notification
- getTop() - Method in class com.openfin.desktop.animation.PositionTransition
-
Gets value of top
- getTop() - Method in class com.openfin.desktop.WindowBounds
-
- getType() - Method in class com.openfin.desktop.ActionEvent
-
Gets event type
- getURL() - Method in class com.openfin.desktop.ApplicationOptions
-
Gets URL of the application
- getURL() - Method in class com.openfin.desktop.NotificationOptions
-
Gets URL property of the notification
- getUuid() - Method in class com.openfin.desktop.Application
-
Get UUID of this Application
- getUUID() - Method in class com.openfin.desktop.ApplicationOptions
-
Gets UUID of the application
- getUuid() - Method in class com.openfin.desktop.Window
-
Gets UUID
- getVersion() - Method in class com.openfin.desktop.ApplicationOptions
-
Gets version of the application
- getVersion(AckListener) - Method in class com.openfin.desktop.System
-
Gets AppDesktop version number
- getWidth() - Method in class com.openfin.desktop.animation.SizeTransition
-
Gets value of width
- getWidth() - Method in class com.openfin.desktop.WindowBounds
-
- getWindow() - Method in class com.openfin.desktop.Application
-
Returns an instance to the main Window of the application.
- send(boolean, String) - Method in interface com.openfin.desktop.ExternalMessageResultHandler
-
- send(String, String, Object) - Static method in class com.openfin.desktop.InterApplicationBus
-
Sends a message to an application
- sendAction(String, JSONObject) - Method in class com.openfin.desktop.DesktopConnection
-
Sends a message to AppDesktop
- sendAction(String, JSONObject, AckListener, Object) - Method in class com.openfin.desktop.DesktopConnection
-
Sends a message to AppDesktop
- sendActionToNotificationsCenter(String, JSONObject, AckListener, Object) - Method in class com.openfin.desktop.DesktopConnection
-
- setAlwaysOnBottom(boolean) - Method in class com.openfin.desktop.WindowOptions
-
The AlwaysOnBottom property represents a flag to always position
the window at the bottom of the window stack.
- setApplicationIcon(String) - Method in class com.openfin.desktop.ApplicationOptions
-
Sets URL of application icon
- setAsForeground(AckListener) - Method in class com.openfin.desktop.Window
-
Set's the window as the foreground window
The window is activated(focused) and brought to front
- setAutoShow(boolean) - Method in class com.openfin.desktop.WindowOptions
-
The AutoShow property represents a flag to automatically
show the Window when it is created.
- setBounds(int, int, int, int, AckListener) - Method in class com.openfin.desktop.Window
-
Sets the current bounds (top, left, width, height) of the window
- setContextMenu(boolean) - Method in class com.openfin.desktop.WindowOptions
-
The ContextMenu property represents a flag to show the
context menu when right-clicking on a window.
- setCornerRounding(int, int) - Method in class com.openfin.desktop.WindowOptions
-
The CornerRoundingHeight property represents the rounded
corners to apply.
- setDefaultHeight(int) - Method in class com.openfin.desktop.WindowOptions
-
The DefaultWidth property represents the window's
default height in pixels.
- setDefaultLeft(int) - Method in class com.openfin.desktop.WindowOptions
-
The DefaultLeft property represents the window's
default left position.
- setDefaultTop(int) - Method in class com.openfin.desktop.WindowOptions
-
The DefaultTop property represents the window's
default top position.
- setDefaultWidth(int) - Method in class com.openfin.desktop.WindowOptions
-
- setDraggable(boolean) - Method in class com.openfin.desktop.WindowOptions
-
The Draggable property represents a flag to allow
the user to drag the window by its client area.
- setDuration(Integer) - Method in class com.openfin.desktop.animation.OpacityTransition
-
Sets value of duration
- setDuration(Integer) - Method in class com.openfin.desktop.animation.PositionTransition
-
Sets value of duration
- setDuration(Integer) - Method in class com.openfin.desktop.animation.SizeTransition
-
Sets value of duration
- setFrame(boolean) - Method in class com.openfin.desktop.WindowOptions
-
The Frame property represents a flag to show the frame.
- setHeight(Integer) - Method in class com.openfin.desktop.animation.SizeTransition
-
Sets value of height
- setHeight(Integer) - Method in class com.openfin.desktop.WindowBounds
-
- setHideOnClose(boolean) - Method in class com.openfin.desktop.WindowOptions
-
The HideOnClose property represents a flag to allow a window
to be hidden when the close button is clicked.
- setLeft(Integer) - Method in class com.openfin.desktop.animation.PositionTransition
-
Sets value of left
- setLeft(Integer) - Method in class com.openfin.desktop.WindowBounds
-
- setMainWindowOptions(WindowOptions) - Method in class com.openfin.desktop.ApplicationOptions
-
Sets options of main window of the application
- setMaxHeight(int) - Method in class com.openfin.desktop.WindowOptions
-
The MaxHeight property represents the maximum height of a window.
- setMaximizable(boolean) - Method in class com.openfin.desktop.WindowOptions
-
The Maximizable property represents a flag that lets the window be maximized.
- setMaxWidth(int) - Method in class com.openfin.desktop.WindowOptions
-
The MaxWidth property represents the maximum width of a window.
- setMessage(JSONObject) - Method in class com.openfin.desktop.NotificationOptions
-
Sets URL property of the notification
- setMinHeight(int) - Method in class com.openfin.desktop.WindowOptions
-
The MinHeight property represents the minimum height of a window.
- setMinimizable(boolean) - Method in class com.openfin.desktop.WindowOptions
-
The Minimizable property represents a flag that lets the window be minimized.
- setMinWidth(int) - Method in class com.openfin.desktop.WindowOptions
-
The MinWidth property represents the minimum width of a window.
- setOpacity(OpacityTransition) - Method in class com.openfin.desktop.animation.AnimationTransitions
-
Sets opacity transition
- setOpacity(Double) - Method in class com.openfin.desktop.animation.OpacityTransition
-
Sets value of opacity
- setOpacity(double) - Method in class com.openfin.desktop.WindowOptions
-
The Opacity property represents a flag that specifies
how transparent the window will be.
- setPosition(PositionTransition) - Method in class com.openfin.desktop.animation.AnimationTransitions
-
Sets position transition
- setResizable(boolean) - Method in class com.openfin.desktop.WindowOptions
-
The Resizable property represents a flag which allows
the user to resize the window.
- setResizeRegionBottomRightCorner(int) - Method in class com.openfin.desktop.WindowOptions
-
The ResizeRegionBottomRightCorner property defines an additional square region located at the bottom
right corner of a frameless window.
- setResizeRegionSize(int) - Method in class com.openfin.desktop.WindowOptions
-
The ResizeRegionSize property defines a region in pixels that will respond to user mouse interaction for
resizing a frameless window
Default value: 2
- setShowTaskbarIcon(boolean) - Method in class com.openfin.desktop.WindowOptions
-
The ShowTaskbarIcon property represents a flag to show
the Window's icon in the taskbar.
- setSize(SizeTransition) - Method in class com.openfin.desktop.animation.AnimationTransitions
-
Sets size transition
- setState(String) - Method in class com.openfin.desktop.WindowOptions
-
The State property represents a string that sets the
window to be "minimized", "maximized", or "normal" on creation.
- setTaskbarIcon(String) - Method in class com.openfin.desktop.WindowOptions
-
The TaskbarIcon property represents the URL of
an icon to be shown on the desktop.
- setTimeout(Integer) - Method in class com.openfin.desktop.NotificationOptions
-
Sets timeout property of the notification
- setTop(Integer) - Method in class com.openfin.desktop.animation.PositionTransition
-
Sets value of top
- setTop(Integer) - Method in class com.openfin.desktop.WindowBounds
-
- setURL(String) - Method in class com.openfin.desktop.NotificationOptions
-
Sets URL property of the notification
- setVersion(String) - Method in class com.openfin.desktop.ApplicationOptions
-
Sets version of the application
- setWidth(Integer) - Method in class com.openfin.desktop.animation.SizeTransition
-
Sets value of width
- setWidth(Integer) - Method in class com.openfin.desktop.WindowBounds
-
- show() - Method in class com.openfin.desktop.Window
-
Shows the window if it is hidden
- show(AckListener) - Method in class com.openfin.desktop.Window
-
Shows the window if it is hidden
- showAt(int, int, boolean) - Method in class com.openfin.desktop.Window
-
Shows the window if it is hidden at the specified location
- showAt(int, int, boolean, AckListener) - Method in class com.openfin.desktop.Window
-
Shows the window if it is hidden at the specified location
- showDeveloperTools(String, String, AckListener) - Method in class com.openfin.desktop.System
-
Shows Developer tool
- showStartWindow() - Method in class com.openfin.desktop.System
-
Shows the start menu window
- showStartWindow(AckListener) - Method in class com.openfin.desktop.System
-
Shows the start menu window
- SizeTransition - Class in com.openfin.desktop.animation
-
A class representing a transition of a Window's dimensions.
- SizeTransition() - Constructor for class com.openfin.desktop.animation.SizeTransition
-
- SizeTransition(Integer, Integer, Integer) - Constructor for class com.openfin.desktop.animation.SizeTransition
-
- subscribe(String, String, BusListener) - Static method in class com.openfin.desktop.InterApplicationBus
-
Subscribes to messages on the specified topic
- subscribed(String, String) - Method in interface com.openfin.desktop.SubscriptionListener
-
- SubscriptionListener - Interface in com.openfin.desktop
-
A Description.
- System - Class in com.openfin.desktop
-
An object representing the core of the OpenFin Desktop.
- System(DesktopConnection) - Constructor for class com.openfin.desktop.System
-
Constructor