com.mindoo.remote.api.xsp
Interface IRemoteXPagesTools

public interface IRemoteXPagesTools

Collection of helper methods that deal with XPages UI access

Method Summary

boolean	execute(IRemoteWorkbenchPart xspPart, java.lang.String javaScript) Method to execute a piece of JavaScript in an XPages Xulrunner browser (client-side JavaScript)
java.lang.String	getDomAsXML(IRemoteWorkbenchPart xspPart) Gets the current source code of the XPages app's DOM tree
java.lang.String	getUrl(IRemoteWorkbenchPart xspPart) Gets the current Url of the XPages part
boolean	isXspViewPart(IRemoteWorkbenchPart part) Method to check whether a part is a XulRunner browser that displays an XPages app

Method Detail

isXspViewPart

boolean isXspViewPart(IRemoteWorkbenchPart part)
                      throws RemoteEclipseAPIException

Method to check whether a part is a XulRunner browser that displays an XPages app

Parameters:

part - part

Returns:

true if XPages part

Throws:

RemoteEclipseAPIException

execute

boolean execute(IRemoteWorkbenchPart xspPart,
                java.lang.String javaScript)
                throws RemoteEclipseAPIException

Method to execute a piece of JavaScript in an XPages Xulrunner browser (client-side JavaScript)

Parameters:

xspPart - XPages viewpart

javaScript - JavaScript code

Returns:

true for success

Throws:

RemoteEclipseAPIException

getUrl

java.lang.String getUrl(IRemoteWorkbenchPart xspPart)
                        throws RemoteEclipseAPIException

Gets the current Url of the XPages part

Parameters:

xspPart - XPages viewpart

Returns:

url

Throws:

RemoteEclipseAPIException

getDomAsXML

java.lang.String getDomAsXML(IRemoteWorkbenchPart xspPart)
                             throws RemoteEclipseAPIException

Gets the current source code of the XPages app's DOM tree

Parameters:

xspPart - XPages viewpart

Returns:

DOM source code as XML

Throws:

RemoteEclipseAPIException