public interface SGMXBean
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.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.
|
void pause()
resume()
.
If the Scene-graph is already "PAUSED" then this method has no effect.void resume()
void step() throws IllegalStateException
pause()
method)
prior to calling this function otherwise the IllegalStateException
is thrown.IllegalStateException
- when Scene-graph is not "PAUSED"String getWindows() throws IllegalStateException
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.IllegalStateException
- when Scene-graph is not "PAUSED"String getSGTree(int windowId) throws IllegalStateException
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.windowId
- unique window identifier obtained by getWindows()
IllegalStateException
- when Scene-graph is not "PAUSED"String getCSSInfo(int nodeId) throws IllegalStateException
pause()
method should be called prior to calling this method.
Otherwise the IllegalStateException
is thrown.nodeId
- node identifier obtained by getSGTree(int)
IllegalStateException
- when Scene-graph is not "PAUSED"String getBounds(int nodeId) throws IllegalStateException
nodeId
- node identifier obtained by getSGTree(int)
IllegalStateException
- when Scene-graph is not "PAUSED"void addHighlightedNode(int nodeId) throws IllegalStateException
getSGTree(int)
method.nodeId
- the id of the node to be highlightedIllegalStateException
- when Scene-graph is not "PAUSED"void removeHighlightedNode(int nodeId) throws IllegalStateException
getSGTree(int)
method.nodeId
- the id of the node to be removedIllegalStateException
- when Scene-graph is not "PAUSED"void addHighlightedRegion(int windowId, double x, double y, double w, double h) throws IllegalStateException
getWindows()
method.windowId
- unique window identifier obtained by getWindows()
x
- x coordinate of the regiony
- y coordinate of the regionw
- width of the regionh
- height of the regionIllegalStateException
- when Scene-graph is not "PAUSED"void removeHighlightedRegion(int windowId, double x, double y, double w, double h) throws IllegalStateException
getWindows()
method.windowId
- unique window identifier obtained by getWindows()
x
- x coordinate of the regiony
- y coordinate of the regionw
- width of the regionh
- height of the regionIllegalStateException
- when Scene-graph is not "PAUSED"String makeScreenShot(int nodeId) throws IllegalStateException
pause()
method should be called prior to calling this method.
Otherwise the IllegalStateException
is thrown.nodeId
- node identifier obtained by getSGTree(int)
IllegalStateException
- when Scene-graph is not "PAUSED"String makeScreenShot(int windowId, double x, double y, double w, double h) throws IllegalStateException
pause()
method should be called prior to calling this method.
Otherwise the IllegalStateException
is thrown.windowId
- unique window identifier obtained by getWindows()
x
- x coordinate of the regiony
- y coordinate of the regionw
- width of the regionh
- height of the regionIllegalStateException
- when Scene-graph is not "PAUSED"Copyright © 2020. All rights reserved.