View (The GraphStream 1.3 API)

All Known Implementing Classes:

DefaultView, ViewPanel
```
public interface View
```
A view on a graphic graph.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addKeyListener(KeyListener l)` Add key ui listener.
`void`	`addMouseListener(MouseListener l)` Add mouse ui listener.
`void`	`addMouseMotionListener(MouseMotionListener l)` Add mouse motion ui listener.
`Collection<GraphicElement>`	`allNodesOrSpritesIn(double x1, double y1, double x2, double y2)` Search for all the nodes and sprites contained inside the rectangle (x1,y1)-(x2,y2).
`void`	`beginSelectionAt(double x1, double y1)` Called by the mouse manager to specify where a node and sprite selection started.
`void`	`close(GraphicGraph graph)` Close definitively this view.
`void`	`display(GraphicGraph graph, boolean graphChanged)` Redisplay or update the view contents.
`void`	`endSelectionAt(double x2, double y2)` Called by the mouse manager to specify where a node and spite selection stopped.
`GraphicElement`	`findNodeOrSpriteAt(double x, double y)` Search for the first node or sprite (in that order) that contains the point at coordinates (x, y).
`void`	`freezeElement(GraphicElement element, boolean frozen)` Freeze an element so that the optional layout cannot move it.
`Camera`	`getCamera()` Get a camera object to provide control commands on the view.
`String`	`getId()` Get the unique view id.
`void`	`moveElementAtPx(GraphicElement element, double x, double y)` Force an element to move at the given location in pixels.
`void`	`removeKeyListener(KeyListener l)` Remove key ui listener.
`void`	`removeMouseListener(MouseListener l)` Remove mouse ui listener.
`void`	`removeMouseMotionListener(MouseMotionListener l)` Remove mouse motion ui listener.
`void`	`requestFocus()` Request ui focus.
`void`	`selectionGrowsAt(double x, double y)` The selection already started grows toward position (x, y).
`void`	`setMouseManager(MouseManager manager)` Change the manager for mouse events on this view.
`void`	`setShortcutManager(ShortcutManager manager)` Change the manager for key and shortcuts events on this view.

- Method Detail
  - getId
```
String getId()
```
    Get the unique view id.
    
    Returns:
    a view id
  - getCamera
```
Camera getCamera()
```
    Get a camera object to provide control commands on the view.
    
    Returns:
    a Camera instance
  - findNodeOrSpriteAt
```
GraphicElement findNodeOrSpriteAt(double x,
                                double y)
```
    Search for the first node or sprite (in that order) that contains the point at coordinates (x, y).
    
    Parameters:
    x - The point abscissa.
    y - The point ordinate.
    
    Returns:
    The first node or sprite at the given coordinates or null if nothing found.
  - allNodesOrSpritesIn
```
Collection<GraphicElement> allNodesOrSpritesIn(double x1,
                                             double y1,
                                             double x2,
                                             double y2)
```
    Search for all the nodes and sprites contained inside the rectangle (x1,y1)-(x2,y2).
    
    Parameters:
    x1 - The rectangle lowest point abscissa.
    y1 - The rectangle lowest point ordinate.
    x2 - The rectangle highest point abscissa.
    y2 - The rectangle highest point ordinate.
    
    Returns:
    The set of sprites and nodes in the given rectangle.
  - display
```
void display(GraphicGraph graph,
           boolean graphChanged)
```
    Redisplay or update the view contents. Called by the Viewer.
    
    Parameters:
    graph - The graphic graph to represent.
    graphChanged - True if the graph changed since the last call to this method.
  - close
```
void close(GraphicGraph graph)
```
    Close definitively this view. Called by the Viewer.
    
    Parameters:
    graph - The graphic graph.
  - beginSelectionAt
```
void beginSelectionAt(double x1,
                    double y1)
```
    Called by the mouse manager to specify where a node and sprite selection started.
    
    Parameters:
    x1 - The selection start abscissa.
    y1 - The selection start ordinate.
  - selectionGrowsAt
```
void selectionGrowsAt(double x,
                    double y)
```
    The selection already started grows toward position (x, y).
    
    Parameters:
    x - The new end selection abscissa.
    y - The new end selection ordinate.
  - endSelectionAt
```
void endSelectionAt(double x2,
                  double y2)
```
    Called by the mouse manager to specify where a node and spite selection stopped.
    
    Parameters:
    x2 - The selection stop abscissa.
    y2 - The selection stop ordinate.
  - freezeElement
```
void freezeElement(GraphicElement element,
                 boolean frozen)
```
    Freeze an element so that the optional layout cannot move it.
    
    Parameters:
    element - The element.
    frozen - If true the element cannot be moved automatically.
  - moveElementAtPx
```
void moveElementAtPx(GraphicElement element,
                   double x,
                   double y)
```
    Force an element to move at the given location in pixels.
    
    Parameters:
    element - The element.
    x - The requested position abscissa in pixels.
    y - The requested position ordinate in pixels.
  - setMouseManager
```
void setMouseManager(MouseManager manager)
```
    Change the manager for mouse events on this view. If the value for the new manager is null, a default manager is installed. The MouseManager.init(org.graphstream.ui.graphicGraph.GraphicGraph, View) method must not yet have been called.
    
    Parameters:
    manager - The new manager, or null to set the default manager.
    See Also:
    MouseManager
  - setShortcutManager
```
void setShortcutManager(ShortcutManager manager)
```
    Change the manager for key and shortcuts events on this view. If the value for the new manager is null, a default manager is installed. The ShortcutManager.init(org.graphstream.ui.graphicGraph.GraphicGraph, View) method must not yet have been called.
    
    Parameters:
    manager - The new manager, or null to set the default manager
    See Also:
    ShortcutManager
  - requestFocus
```
void requestFocus()
```
    Request ui focus.
  - addKeyListener
```
void addKeyListener(KeyListener l)
```
    Add key ui listener.
    
    Parameters:
    l - the listener
  - removeKeyListener
```
void removeKeyListener(KeyListener l)
```
    Remove key ui listener.
    
    Parameters:
    l - the listener
  - addMouseListener
```
void addMouseListener(MouseListener l)
```
    Add mouse ui listener.
    
    Parameters:
    l - the listener
  - removeMouseListener
```
void removeMouseListener(MouseListener l)
```
    Remove mouse ui listener.
    
    Parameters:
    l - the listener
  - addMouseMotionListener
```
void addMouseMotionListener(MouseMotionListener l)
```
    Add mouse motion ui listener.
    
    Parameters:
    l - the listener
  - removeMouseMotionListener
```
void removeMouseMotionListener(MouseMotionListener l)
```
    Remove mouse motion ui listener.
    
    Parameters:
    l - the listener

Interface View

Method Summary

Method Detail

getId

getCamera

findNodeOrSpriteAt

allNodesOrSpritesIn

display

close

beginSelectionAt

selectionGrowsAt

endSelectionAt

freezeElement

moveElementAtPx

setMouseManager

setShortcutManager

requestFocus

addKeyListener

removeKeyListener

addMouseListener

removeMouseListener

addMouseMotionListener

removeMouseMotionListener