com.oracle.javafx.jmx

Class SGMXBeanImpl

java.lang.Object

com.oracle.javafx.jmx.SGMXBeanImpl

All Implemented Interfaces:

SGMXBean, MXNodeAlgorithm

public class SGMXBeanImpl
extends Object
implements SGMXBean, MXNodeAlgorithm

Default implementation of SGMXBean interface.

Constructor Summary

Constructors

Constructor and Description
SGMXBeanImpl()

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.
Object	processContainerNode(Parent parent, MXNodeAlgorithmContext ctx) Method for processing container nodes (Parent, Group, etc.).
Object	processLeafNode(Node node, MXNodeAlgorithmContext ctx) Method for processing leaf nodes.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SGMXBeanImpl

public SGMXBeanImpl()

Method Detail

pause

public void pause()

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

Specified by:

pause in interface SGMXBean

resume

public 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.

Specified by:

resume in interface SGMXBean

step

public 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 SGMXBean.pause() method) prior to calling this function otherwise the IllegalStateException is thrown.

Specified by:

step in interface SGMXBean

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

getWindows

public 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 SGMXBean.getSGTree(int) method. The SGMXBean.pause() method should be called prior to calling this method. Otherwise the IllegalStateException is thrown. The result is in the format of JSON string.

Specified by:

getWindows in interface SGMXBean

Returns:

the list of all JavaFX windows in JSON format

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

getSGTree

public 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 SGMXBean.getCSSInfo(int). The SGMXBean.pause() method should be called prior to calling this method. Otherwise the IllegalStateException is thrown. The result is in the format of JSON string.

Specified by:

getSGTree in interface SGMXBean

Parameters:

windowId - unique window identifier obtained by SGMXBean.getWindows()

Returns:

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

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

addHighlightedNode

public 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 SGMXBean.getSGTree(int) method.

Specified by:

addHighlightedNode in interface SGMXBean

Parameters:

nodeId - the id of the node to be highlighted

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

removeHighlightedNode

public 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 SGMXBean.getSGTree(int) method.

Specified by:

removeHighlightedNode in interface SGMXBean

Parameters:

nodeId - the id of the node to be removed

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

addHighlightedRegion

public 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 SGMXBean.getWindows() method.

Specified by:

addHighlightedRegion in interface SGMXBean

Parameters:

windowId - unique window identifier obtained by SGMXBean.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

public 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 SGMXBean.getWindows() method.

Specified by:

removeHighlightedRegion in interface SGMXBean

Parameters:

windowId - unique window identifier obtained by SGMXBean.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

public 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 SGMXBean.pause() method should be called prior to calling this method. Otherwise the IllegalStateException is thrown.

Specified by:

makeScreenShot in interface SGMXBean

Parameters:

nodeId - node identifier obtained by SGMXBean.getSGTree(int)

Returns:

the absolute path to the PNG file with the image

Throws:

IllegalStateException - when Scene-graph is not "PAUSED"

makeScreenShot

public 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 SGMXBean.pause() method should be called prior to calling this method. Otherwise the IllegalStateException is thrown.

Specified by:

makeScreenShot in interface SGMXBean

Parameters:

windowId - unique window identifier obtained by SGMXBean.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"

getCSSInfo

public String getCSSInfo(int nodeId)
                  throws IllegalStateException

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

Specified by:

getCSSInfo in interface SGMXBean

Parameters:

nodeId - node identifier obtained by SGMXBean.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

public String getBounds(int nodeId)
                 throws IllegalStateException

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

Specified by:

getBounds in interface SGMXBean

Parameters:

nodeId - node identifier obtained by SGMXBean.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"

processLeafNode

public Object processLeafNode(Node node,
                              MXNodeAlgorithmContext ctx)

Method for processing leaf nodes.

Specified by:

processLeafNode in interface MXNodeAlgorithm

Parameters:

node - node to be processed

ctx - current context

Returns:

algorithm specific result for the node

processContainerNode

public Object processContainerNode(Parent parent,
                                   MXNodeAlgorithmContext ctx)

Method for processing container nodes (Parent, Group, etc.).

Specified by:

processContainerNode in interface MXNodeAlgorithm

Parameters:

parent - container node to be processed

ctx - current context

Returns:

algorithm specific result for the container node