com.oracle.javafx.jmx

Interface SGMXBean

All Known Implementing Classes:

SGMXBeanImpl

public interface SGMXBean

The SGMXBean represents a standard JMX interface to the JavaFX application. The interface is supposed to be used by tools (debugger) and provides functionality to obtain Scene-graph related information and information about nodes.

Method Summary

Modifier and Type	Method and Description
void	addHighlightedNode(int nodeId) Adds the node with the nodeId to the list of nodes that are to be highlighted in the scene.
void	addHighlightedRegion(int windowId, double x, double y, double w, double h) Adds the specified region to the list of regions to be highlighted in the scene.
String	getBounds(int nodeId) Retrieves the bounds information about the particular node.
String	getCSSInfo(int nodeId) Retrieves the CSS information about the particular node.
String	getSGTree(int windowId) Returns the Scene-graph hierarchy in a simple tree-like model for given window.
String	getWindows() Returns the list of JavaFX windows.
String	makeScreenShot(int nodeId) Makes a screen-shot of the selected node in the scene's coordinates and stores it into a temporary file in the PNG format.
String	makeScreenShot(int windowId, double x, double y, double w, double h) Makes a screen-shot of the specified region in the scene's coordinates and stores it into a temporary file in the PNG format.
void	pause() Pauses the Scene-graph which means it pause all animations, media players, etc.
void	removeHighlightedNode(int nodeId) Removes the nodeId node from the list of nodes that are to be highlighted in the scene.
void	removeHighlightedRegion(int windowId, double x, double y, double w, double h) Removes the specified region from the list of regions to be highlighted in the scene.
void	resume() Resumes the previously paused Scene-graph into the normal operation.
void	step() Produces single JavaFX pulse and pauses the Scene-graph again.

Method Detail

pause

void pause()

Pauses the Scene-graph which means it pause all animations, media players, etc. To resume the Scene-graph to normal operation call resume(). If the Scene-graph is already "PAUSED" then this method has no effect.

resume

void resume()

Resumes the previously paused Scene-graph into the normal operation. If the Scene-graph is running normally (not "PAUSED") then this method has no effect.

step

void step()
   throws IllegalStateException

Produces single JavaFX pulse and pauses the Scene-graph again. It is similar to STEP feature in debuggers. The Scene-graph should be already "PAUSED" (by calling pause() method) prior to calling this function otherwise the IllegalStateException is thrown.

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

getWindows

String getWindows()
           throws IllegalStateException

Returns the list of JavaFX windows. Each window is identified by unique number identifier. The identifier is used as an input to getSGTree(int) method. The pause() method should be called prior to calling this method. Otherwise the IllegalStateException is thrown. The result is in the format of JSON string.

Returns:

the list of all JavaFX windows in JSON format

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

getSGTree

String getSGTree(int windowId)
          throws IllegalStateException

Returns the Scene-graph hierarchy in a simple tree-like model for given window. Every node is identified by unique number identifier. The identifier is used to query node's properties with methods like getCSSInfo(int). The pause() method should be called prior to calling this method. Otherwise the IllegalStateException is thrown. The result is in the format of JSON string.

Parameters:

windowId - unique window identifier obtained by getWindows()

Returns:

the simple tree-like model of the Scene-graph in JSON format

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

getCSSInfo

String getCSSInfo(int nodeId)
           throws IllegalStateException

Retrieves the CSS information about the particular node. The pause() method should be called prior to calling this method. Otherwise the IllegalStateException is thrown.

Parameters:

nodeId - node identifier obtained by getSGTree(int)

Returns:

list of key-value pairs holding CSS information, result is in JSON format

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

getBounds

String getBounds(int nodeId)
          throws IllegalStateException

Retrieves the bounds information about the particular node. Bounds are in scene's coordinate system.

Parameters:

nodeId - node identifier obtained by getSGTree(int)

Returns:

bounds information (x, y, width and height) for given node in scene's coordinate system, result is in JSON format

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

addHighlightedNode

void addHighlightedNode(int nodeId)
                 throws IllegalStateException

Adds the node with the nodeId to the list of nodes that are to be highlighted in the scene. The nodeId is to be retrieved using the getSGTree(int) method.

Parameters:

nodeId - the id of the node to be highlighted

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

removeHighlightedNode

void removeHighlightedNode(int nodeId)
                    throws IllegalStateException

Removes the nodeId node from the list of nodes that are to be highlighted in the scene. The nodeId is to be retrieved using the getSGTree(int) method.

Parameters:

nodeId - the id of the node to be removed

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

addHighlightedRegion

void addHighlightedRegion(int windowId,
                          double x,
                          double y,
                          double w,
                          double h)
                   throws IllegalStateException

Adds the specified region to the list of regions to be highlighted in the scene. The windowId is to be retrieved using the getWindows() method.

Parameters:

windowId - unique window identifier obtained by getWindows()

x - x coordinate of the region

y - y coordinate of the region

w - width of the region

h - height of the region

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

removeHighlightedRegion

void removeHighlightedRegion(int windowId,
                             double x,
                             double y,
                             double w,
                             double h)
                      throws IllegalStateException

Removes the specified region from the list of regions to be highlighted in the scene. The windowId is to be retrieved using the getWindows() method.

Parameters:

windowId - unique window identifier obtained by getWindows()

x - x coordinate of the region

y - y coordinate of the region

w - width of the region

h - height of the region

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

makeScreenShot

String makeScreenShot(int nodeId)
               throws IllegalStateException

Makes a screen-shot of the selected node in the scene's coordinates and stores it into a temporary file in the PNG format. Absolute path to this file is returned. The pause() method should be called prior to calling this method. Otherwise the IllegalStateException is thrown.

Parameters:

nodeId - node identifier obtained by getSGTree(int)

Returns:

the absolute path to the PNG file with the image

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

makeScreenShot

String makeScreenShot(int windowId,
                      double x,
                      double y,
                      double w,
                      double h)
               throws IllegalStateException

Makes a screen-shot of the specified region in the scene's coordinates and stores it into a temporary file in the PNG format. Absolute path to this file is returned. The pause() method should be called prior to calling this method. Otherwise the IllegalStateException is thrown.

Parameters:

windowId - unique window identifier obtained by getWindows()

x - x coordinate of the region

y - y coordinate of the region

w - width of the region

h - height of the region

Returns:

the absolute path to the PNG file with the image

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"