FXVizCanvas

java.lang.Object
- org.eclipse.eavp.viz.service.javafx.canvas.FXVizCanvas

All Implemented Interfaces:

IVizCanvas

Direct Known Subclasses:

FXGeometryCanvas, FXMeshCanvas
```
public class FXVizCanvas
extends java.lang.Object
implements IVizCanvas
```
A generic JavaFX visualization canvas.

Author:

Tony McCrary (tmccrary@l33tlabs.com), Robert Smith

Constructor Summary

Constructors
Constructor and Description
`FXVizCanvas(Geometry geometry)` Creates a canvas for the supplied geometry.
`FXVizCanvas(IController geometry)` Creates a canvas for the supplied geometry.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRoot(Geometry part)` Adds a geometry to the canvas.
`org.eclipse.swt.widgets.Composite`	`draw(org.eclipse.swt.widgets.Composite parent)` This operation draws the canvas contents onto the given parent Composite.
`java.net.URI`	`getDataSource()` This operation returns the data source that is plotted/drawn by this IPlot.
`int`	`getNumberOfAxes()` This operation returns the number of axes of the plot.
`java.util.Map<java.lang.String,java.lang.String>`	`getProperties()` This operation returns properties of this IPlot that can be safely modified and/or tuned by the client.
`IRenderElementHolder`	`getRenderElementHolder(Geometry geometry)` Get the list of render elements used to display the given geometry in this canvas.
`java.lang.String`	`getSourceHost()` This operation retrieves the hostname for this IPlot's data source.
`BasicViewer`	`getViewer()` Returns the underlying GeometryViewer.
`boolean`	`isSourceRemote()` This operation signifies whether or not the IPlot's host is local or remote.
`void`	`redraw()` This operation directs the IPlot to redraw its contents.
`void`	`removeRoot(Geometry part)` Removes a geoemtry from the canvas.
`void`	`setProperties(java.util.Map<java.lang.String,java.lang.String> props)` This operation updates the properties of the plot based on client-side modifications.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FXVizCanvas
```
public FXVizCanvas(IController geometry)
```
    Creates a canvas for the supplied geometry.
    
    Parameters:
    
    geometry - EAVP Geometry instance to visualize in the canvas.
  - FXVizCanvas
```
public FXVizCanvas(Geometry geometry)
```
    Creates a canvas for the supplied geometry.
    
    Parameters:
    
    geometry - EAVP Geometry instance to visualize in the canvas.
- Method Detail
  - draw
```
public org.eclipse.swt.widgets.Composite draw(org.eclipse.swt.widgets.Composite parent)
                                       throws java.lang.Exception
```
    Description copied from interface: IVizCanvas
    
    This operation draws the canvas contents onto the given parent Composite. The exact details of how the plot is drawn and what is drawn inside the parent composite are left completely up to the implementation.
    
    Specified by:
    
    draw in interface IVizCanvas
    
    Throws:
    
    java.lang.Exception
    
    See Also:
    
    IVizCanvas.draw(Composite)
  - addRoot
```
public void addRoot(Geometry part)
```
    Adds a geometry to the canvas.
    
    Parameters:
    
    part - The part to be added
  - removeRoot
```
public void removeRoot(Geometry part)
```
    Removes a geoemtry from the canvas.
    
    Parameters:
    
    part - The part to be removed
  - getViewer
```
public BasicViewer getViewer()
```
    Returns the underlying GeometryViewer.
    
    Returns:
    
    a GeometryViewer instance that is used to visualize scenes
  - getDataSource
```
public java.net.URI getDataSource()
```
    Description copied from interface: IVizCanvas
    
    This operation returns the data source that is plotted/drawn by this IPlot.
    
    Specified by:
    
    getDataSource in interface IVizCanvas
    
    Returns:
    
    The data source
    
    See Also:
    
    IVizCanvas.getDataSource()
  - getNumberOfAxes
```
public int getNumberOfAxes()
```
    Description copied from interface: IVizCanvas
    
    This operation returns the number of axes of the plot.
    
    Specified by:
    
    getNumberOfAxes in interface IVizCanvas
    
    Returns:
    
    The number of axes or zero if the plot has not been drawn
    
    See Also:
    
    IVizCanvas.getNumberOfAxes()
  - getProperties
```
public java.util.Map<java.lang.String,java.lang.String> getProperties()
```
    Description copied from interface: IVizCanvas
    
    This operation returns properties of this IPlot that can be safely modified and/or tuned by the client. These properties should contains things such as, for example, the axis labels, the title, the subtitle, etc.
    
    Specified by:
    
    getProperties in interface IVizCanvas
    
    Returns:
    
    A map of the properties.
    
    See Also:
    
    IVizCanvas.getProperties()
  - getSourceHost
```
public java.lang.String getSourceHost()
```
    Description copied from interface: IVizCanvas
    
    This operation retrieves the hostname for this IPlot's data source.
    
    Specified by:
    
    getSourceHost in interface IVizCanvas
    
    Returns:
    
    the hostname
    
    See Also:
    
    IVizCanvas.getSourceHost()
  - isSourceRemote
```
public boolean isSourceRemote()
```
    Description copied from interface: IVizCanvas
    
    This operation signifies whether or not the IPlot's host is local or remote.
    
    Specified by:
    
    isSourceRemote in interface IVizCanvas
    
    Returns:
    
    True if the source is on a remote machine, false otherwise
    
    See Also:
    
    IVizCanvas.isSourceRemote()
  - redraw
```
public void redraw()
```
    Description copied from interface: IVizCanvas
    
    This operation directs the IPlot to redraw its contents. This can be invoked when, for example, the data represented by this IPlot changes, and a change in the IPlot's UI must change accordingly. The exact details of how this IPlot is redrawn after a valid draw is left completely to the implementation.
    
    Specified by:
    
    redraw in interface IVizCanvas
    
    See Also:
    
    IVizCanvas.redraw()
  - setProperties
```
public void setProperties(java.util.Map<java.lang.String,java.lang.String> props)
                   throws java.lang.Exception
```
    Description copied from interface: IVizCanvas
    
    This operation updates the properties of the plot based on client-side modifications. The IPlot should redraw itself as needed if the properties changed.
    
    Specified by:
    
    setProperties in interface IVizCanvas
    
    Parameters:
    
    props - The updated properties
    
    Throws:
    
    java.lang.Exception - This exception indicates that the IPlot could not update its properties or redraw itself.
    
    See Also:
    
    IVizCanvas#setProperties()
  - getRenderElementHolder
```
public IRenderElementHolder getRenderElementHolder(Geometry geometry)
```
    Description copied from interface: IVizCanvas
    
    Get the list of render elements used to display the given geometry in this canvas.
    
    Specified by:
    
    getRenderElementHolder in interface IVizCanvas
    
    Parameters:
    
    geometry - The geometry whose corresponding IRenderElements are sought.
    
    Returns:
    
    An array list of each of the top level IRenderElements in the hierarchy, corresponding to the geometry's nodes list from getNodes()

Class FXVizCanvas

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FXVizCanvas

FXVizCanvas

Method Detail

draw

addRoot

removeRoot

getViewer

getDataSource

getNumberOfAxes

getProperties

getSourceHost

isSourceRemote

redraw

setProperties

getRenderElementHolder