Package | Description |
---|---|
com.openfin.desktop | |
com.openfin.desktop.channel | |
com.openfin.desktop.win32 |
Modifier and Type | Method and Description |
---|---|
void |
DesktopConnection.addEventCallback(org.json.JSONObject subscriptionObject,
EventListener listener,
AckListener callback,
Object source)
Registers an event listener on the specified event
|
protected void |
OpenFinRuntime.addEventListener(org.json.JSONObject subscriptionObject,
EventListener listener,
AckListener callback)
Registers an event listener on the specified event
|
void |
Window.addEventListener(String type,
EventListener listener,
AckListener callback)
Registers an event listener on the specified event
|
void |
OpenFinRuntime.addEventListener(String type,
EventListener listener,
AckListener callback)
Registers an event listener on the specified event
|
void |
Application.addEventListener(String type,
EventListener listener,
AckListener callback)
Registers an event listener on the specified event.
|
void |
Window.animate(AnimationTransitions transitions,
AnimationOptions options,
AckListener listener)
Performs the specified window transitions
|
void |
Window.authenticate(String username,
String password,
boolean cancel,
AckListener listener)
authenticate a user.
|
void |
Window.blur(AckListener listener)
Removes focus to the window
|
void |
Window.bringToFront(AckListener listener)
Brings the window to the front of the window stack
|
void |
OpenFinRuntime.clearCache(boolean cache,
boolean cookies,
boolean localStorage,
boolean appcache,
boolean userData,
AckListener listener)
Clears cached data containing window state/positions,
application resource files (images, HTML, JavaScript files)
cookies, and items stored in the Local Storage.
|
void |
Window.close(AckListener listener)
Closes the window
|
void |
Window.close(Boolean force,
AckListener ackListener)
Closes the window
|
void |
Application.close(Boolean force,
AckListener listener)
Closes the application with a listener that gets called if the method succeeds
|
void |
Application.createChildWindow(WindowOptions windowOptions,
AckListener callback)
Create a child window of this application
|
static void |
Application.createFromManifest(String manifestUrl,
AsyncCallback<Application> callback,
AckListener listener,
DesktopConnection connection)
Deprecated.
use launchManifest() instead.
|
void |
OpenFinRuntime.deleteCacheOnRestart(AckListener listener)
Clears all cached data when App Desktop is restarted
|
void |
Window.disableFrame(AckListener listener)
Prevents a user from changing a window's size/position when using the window's frame
|
void |
Window.embedInto(long parentHwndId,
int width,
int height,
AckListener callback)
Embeds a window in a target window
|
void |
Window.embedInto(long parentHwndId,
int left,
int top,
int width,
int height,
AckListener callback)
Embeds a window in a target window
|
void |
Window.enableFrame(AckListener listener)
Allows a user from changing a window's size/position when using the window's frame
|
static void |
DesktopUtils.errorAck(AckListener callback,
Ack ack) |
static void |
DesktopUtils.errorAckOnException(AckListener ackListener,
Object source,
Exception ex)
Call onError of an AckListen for an exception
|
void |
Window.executeJavaScript(String code,
AsyncCallback<Object> callback,
AckListener listener)
Executes Javascript on the window, restricted to windows you own or windows owned by applications you have created.
|
void |
Window.flash(AckListener callback)
Draws attention to the window by flashing the taskbar and window caption.
|
void |
Window.focus(AckListener listener)
Gives focus to the window
|
void |
OpenFinRuntime.getAllApplications(AckListener listener)
Retrieves an array of data (uuid, running/active state) for all application windows
|
void |
OpenFinRuntime.getAllWindows(AckListener listener)
The object passed to callback takes the form:
|
void |
Window.getBounds(AsyncCallback<WindowBounds> callback,
AckListener listener)
Gets the current bounds (top, left, width, height) of the window
|
void |
Application.getChildWindows(AsyncCallback<List<Window>> callback,
AckListener listener)
Retrieves an list of wrapped fin.desktop.Windows for each of the
application’s child windows
|
void |
OpenFinRuntime.getCommandLineArguments(AckListener listener)
Retrieves the command line argument string that started App Desktop
|
void |
OpenFinRuntime.getConfig(String section,
AckListener callback)
Retrieves the Runtime's configuration
|
void |
OpenFinRuntime.getEntityInfo(String uuid,
String name,
AckListener listener)
Returns a frame info object relating to the entity specified by the uuid and name passed in.
|
void |
OpenFinRuntime.getEnvironmentVariable(String name,
AckListener callback)
Retrieve name of a environment variable
|
void |
OpenFinRuntime.getEnvironmentVariables(String[] names,
AckListener callback)
Retrieve name of environment variables
|
void |
Window.getGroup(AsyncCallback<List<Window>> groupHandler,
AckListener listener)
Passes a list of wrapped windows in the same group
An empty list is returned if the window is not in a group.
|
void |
Application.getGroups(AsyncCallback<List<List<Window>>> groupHandler,
AckListener callback)
Retrieves an array of active window groups for all of the application's windows.
|
void |
OpenFinRuntime.getHostSpecs(AckListener listener)
Get system information
|
void |
Application.getInfo(AsyncCallback<org.json.JSONObject> callback,
AckListener listener)
Retrieves information about the application.
|
void |
Window.getInfo(String code,
AsyncCallback<org.json.JSONObject> callback,
AckListener listener)
Gets the window information
|
void |
OpenFinRuntime.getLog(String logName,
AckListener listener)
Retrieves the contents of the log with the specified filename
|
void |
OpenFinRuntime.getLogList(AckListener listener)
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
}
|
void |
OpenFinRuntime.getMachineId(AckListener listener)
Gets Machine ID
|
void |
Application.getManifest(AckListener listener)
Retrieves the JSON manifest that was used to create the application.
|
void |
OpenFinRuntime.getMonitorInfo(AckListener listener)
Retrieves an object that contains data about the about the
|
void |
OpenFinRuntime.getMousePosition(AckListener listener)
Returns the mouse in virtual screen coordinates (left, top)
|
void |
Window.getNativeId(AckListener listener)
Gets HWND of the current window
|
void |
Window.getOptions(AsyncCallback<WindowOptions> callback,
AckListener listener)
Returns the current options as stored in the desktop
|
void |
Application.getParentUuid(AsyncCallback<String> callback,
AckListener listener)
Retrieves UUID of the application that launches this application.
|
void |
OpenFinRuntime.getProcessList(AckListener listener)
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.
|
void |
OpenFinRuntime.getProxySettings(AckListener listener)
Retrieves the proxy settings object
|
void |
OpenFinRuntime.getRuntimeInfo(AckListener callback)
Returns the version of the runtime
|
void |
OpenFinRuntime.getRvmInfo(AckListener callback)
Returns information about the running RVM
|
void |
Window.getSnapshot(AckListener callback)
Gets a base64 encoded PN snapshot of the window
|
void |
Window.getState(AckListener listener)
Gets the current state ("minimized", "maximized", or "restored") of the window
|
void |
Application.getTrayIconInfo(AsyncCallback<org.json.JSONObject> callback,
AckListener listener)
Retrieves information about the custom icon the application previously set in the system tray via setTrayIcon().
|
void |
OpenFinRuntime.getVersion(AckListener listener)
Gets AppDesktop version number
|
void |
Window.getZoomLevel(AsyncCallback<Double> callback,
AckListener listener)
Gets the current zoom level of the window
|
void |
Window.hide(AckListener listener)
Hides the window if it is shown
|
void |
Application.isRunning(AsyncCallback<Boolean> callback,
AckListener listener)
Determines if the application is currently running.
|
void |
Window.isShowing(AckListener listener)
Determines if the window is currently showing
|
void |
Window.joinGroup(Window window,
AckListener listener)
Joins the same window group as the specified window
|
void |
OpenFinRuntime.launchExternalProcess(org.json.JSONObject launchConfig,
AsyncCallback<LaunchExternalProcessResult> callback,
AckListener listener)
Runs an executable or batch file.
|
void |
OpenFinRuntime.launchExternalProcess(String path,
String commandLine,
AsyncCallback<LaunchExternalProcessResult> callback,
AckListener listener)
Runs an executable or batch file.
|
void |
OpenFinRuntime.launchManifest(String manifestUrl,
org.json.JSONObject rvmLaunchOptions,
AckListener listener)
Request Runtime to launch app from a manifest
Shape of rvmLaunchOptions
{
noUi: boolean;
userAppConfigArgs: JSONObject;
}
|
void |
Window.leaveGroup(AckListener listener)
Leaves the current window group so that the window
can be move independently of those in the group.
|
void |
OpenFinRuntime.log(String level,
String message,
AckListener listener)
Writes a message to the log
|
void |
Window.maximize(AckListener listener)
Maximizes the window
|
void |
Window.mergeGroups(Window window,
AckListener listener)
Merges the instance's window group with the same window group as the specified window.
|
void |
Window.minimize(AckListener listener)
Minimizes the window
|
void |
Window.moveBy(int deltaLeft,
int deltaTop,
AckListener listener)
Moves the window by a specified amount
|
void |
Window.moveTo(int left,
int top,
AckListener listener)
Moves the window to a specified location
|
void |
Window.navigate(String url,
AckListener listener)
Navigates the Widnow to the specified address
|
void |
Window.navigateBack(AckListener listener)
Navigates the window back one page.
|
void |
Window.navigateForward(AckListener listener)
Navigates the window forward one page.
|
void |
OpenFinRuntime.openUrlWithBrowser(AckListener listener)
Opens the passed URL
|
void |
InterApplicationBus.publish(String topic,
Object message,
AckListener callback)
Publishes a message to a topic
|
void |
Application.registerUser(String username,
String appName,
AckListener listener)
Manually registers a user with the licensing service.
|
void |
OpenFinRuntime.releaseExternalProcess(String processUuid,
AckListener callback)
Removes the process entry for the passed UUID obtained
from a previous call to DesktopSystem.launchExternalProcess().
|
void |
Window.reload(boolean ignoreCache,
AckListener listener)
Reloads the window current page
|
void |
DesktopConnection.removeEventCallback(org.json.JSONObject subscriptionObject,
EventListener listener,
AckListener callback,
Object source)
Removes a previously registered event listener from the specified event
|
void |
Window.removeEventListener(String type,
EventListener listener,
AckListener callback)
Removes a previously registered event listener from the specified event
|
void |
OpenFinRuntime.removeEventListener(String type,
EventListener listener,
AckListener callback)
Removes a previously registered event listener from the specified event
|
void |
Application.removeEventListener(String type,
EventListener listener,
AckListener callback)
Removes a previously registered event listener from the specified event
|
void |
Application.removeTrayIcon(AckListener callback)
Removes the application’s icon from the tray.
|
void |
Window.resizeBy(int deltaWidth,
int deltaHeight,
String anchor,
AckListener listener)
Resizes the window by the specified amount
|
void |
Window.resizeTo(int width,
int height,
AckListener listener)
Resizes the window to the specified dimensions
|
void |
Window.resizeTo(int width,
int height,
String anchor,
AckListener listener)
Resizes the window to the specified dimensions
|
void |
OpenFinRuntime.resolveProxy(String url,
AckListener listener)
Resolve proxy information for a given url
|
void |
Application.restart(AckListener listener)
Restarts the application with a listener that gets called if the method succeeds
|
void |
Window.restore(AckListener listener)
Restores the window
|
void |
Application.run(AckListener listener)
Runs the application with a listener that gets called if the method succeeds
|
void |
InterApplicationBus.send(String destinationUuid,
String topic,
Object message,
AckListener listener)
Sends a message to an application
|
void |
DesktopConnection.sendAction(String action,
org.json.JSONObject payload,
AckListener ackListener,
Object source)
Sends a message to Runtime
|
void |
Window.setAsForeground(AckListener listener)
Set's the window as the foreground window
The window is activated(focused) and brought to front
|
void |
Window.setBounds(int left,
int top,
int width,
int height,
AckListener listener)
Sets the current bounds (top, left, width, height) of the window
|
void |
OpenFinRuntime.setClipboard(String text,
AckListener callback)
Copies text to the clipboard
|
void |
OpenFinRuntime.setCookie(String url,
String name,
String value,
long ttl,
boolean secure,
boolean httpOnly,
AckListener callback)
Stores a cookie in the runtime
|
void |
OpenFinRuntime.setCookie(String url,
String name,
String value,
String domain,
String path,
long ttl,
boolean secure,
boolean httpOnly,
AckListener callback)
Stores a cookie in the runtime
|
void |
Application.setTrayIcon(String iconUrl,
EventListener listener,
AckListener callback)
Adds a customizable icon in the system tray and notifies the application when clicked
|
void |
Window.setZoomLevel(double level,
AckListener listener)
Sets the zoom level of the window
|
void |
Window.show(AckListener listener)
Shows the window if it is hidden
|
void |
Window.showAt(int left,
int top,
boolean toggle,
AckListener listener)
Shows the window if it is hidden at the specified location
|
void |
Window.showDeveloperTools(AckListener listener)
Shows window's developer tools
|
void |
OpenFinRuntime.showDeveloperTools(String applicationUUID,
String windowName,
AckListener callback)
Shows Developer tool
|
void |
Window.stopFlashing(AckListener callback)
Stops flashing of taskbar and window caption
|
void |
Window.stopWindowNavigation(AckListener listener)
Stops window navigation.
|
void |
InterApplicationBus.subscribe(String sourceUuid,
String topic,
BusListener listener,
AckListener callback)
Subscribes to messages on the specified topic
|
static void |
DesktopUtils.successAck(AckListener ackListener,
Ack ack)
Call onSuccess of an AckListen
|
void |
Application.terminate(AckListener listener)
Closes the application by terminating its process.
|
void |
OpenFinRuntime.terminateExternalProcess(String processUuid,
int timeout,
boolean killTree,
AsyncCallback<TerminateExternalProcessResult> callback,
AckListener listener)
Attempts to cleanly close an external process and terminates it
if the close has not occured after the elapsed timeout in milliseconds.
|
void |
InterApplicationBus.unsubscribe(String sourceUuid,
String topic,
BusListener listener,
AckListener callback)
Unsubscribes to messages on the specified topic
|
void |
Window.updateOptions(WindowOptions options,
AckListener listener)
Changes a window's options that were defined upon creation
|
void |
OpenFinRuntime.updateProxySettings(String type,
String proxyAddress,
int proxyPort,
AckListener listener)
Updates the proxy settings
The passed type can be either "system" or "named".
|
void |
Application.waitFor(AckListener listener)
Waits for a hanging application.
|
Constructor and Description |
---|
Application(ApplicationOptions options,
DesktopConnection connection,
AckListener listener)
Application Constructor
|
Modifier and Type | Method and Description |
---|---|
protected void |
Channel.addEventListener(org.json.JSONObject subscriptionObject,
EventListener listener,
AckListener callback)
Registers an event listener on the specified event
|
void |
Channel.addEventListener(String type,
EventListener listener,
AckListener callback)
Registers an event listener on the specified event
|
void |
AbstractServiceClient.connect(AckListener ackListener) |
void |
ChannelProvider.destroy(AckListener ackListener)
Destroy the channel
|
void |
ChannelClient.disconnect(AckListener ackListener)
Disconnect from the channel.
|
void |
ChannelBase.dispatch(org.json.JSONObject destinationIdentity,
String action,
org.json.JSONObject actionPayload,
AckListener ackListener)
Dispatch an action to a specified client.
|
void |
ChannelClient.dispatch(String action,
org.json.JSONObject actionPayload,
AckListener ackListener)
Dispatch the given action to the channel provider.
|
void |
LayoutClient.generateWorkspace(AsyncCallback<org.json.JSONObject> callback,
AckListener listener) |
void |
ChannelProvider.publish(String action,
org.json.JSONObject actionPayload,
AckListener ackListener)
Publish an action and payload to every connected client.
|
void |
Channel.removeEventListener(String type,
EventListener listener,
AckListener callback)
Removes a previously registered event listener from the specified event
|
void |
LayoutClient.removeTab(WindowIdentity identity,
AckListener listener) |
void |
LayoutClient.retoreWorkspace(org.json.JSONObject workspace,
AckListener listener) |
void |
LayoutClient.tabWindows(WindowIdentity target,
WindowIdentity identity,
AckListener listener)
Add a window, with identity, as a tab to the context the target window belongs to
|
void |
LayoutClient.undockWindow(String applicationUuid,
String windowName,
AckListener listener) |
Constructor and Description |
---|
LayoutClient(DesktopConnection desktopConnection,
AckListener listener) |
Modifier and Type | Method and Description |
---|---|
void |
EmbeddedWindow.embed(long parentHwndId,
WindowBounds embedBounds,
AckListener callback) |
Constructor and Description |
---|
ExternalWindowObserver(int port,
String parentAppUuid,
String name,
javafx.stage.Stage stage,
AckListener listener) |
ExternalWindowObserver(int port,
String parentAppUuid,
String name,
Window window,
AckListener listener)
Establishes a connection and registers
the window identified by hWnd with the Runtime.
|
Copyright © 2022. All rights reserved.