Inherits JFrame.

Public Member Functions
void	brush (int red, int green, int blue)
void	brush (int red, int green, int blue, int alpha)
void	clear ()
void	createImage (String internalName, int width, int height, int bitsPerPixel)
void	createPolyline (int length)
void	drawPolyline ()
	SVWindow (String name, int hash, int posX, int posY, int sizeX, int sizeY, int canvasSizeX, int canvasSizeY)
void	addMessageBox ()
void	setStrokeWidth (float width)
void	drawEllipse (int x, int y, int width, int height)
void	drawImage (String internalName, int x_pos, int y_pos)
void	drawLine (int x1, int y1, int x2, int y2)
void	drawRectangle (int x1, int y1, int x2, int y2)
void	drawText (int x, int y, String text)
void	pen (int red, int green, int blue)
void	pen (int red, int green, int blue, int alpha)
void	textAttributes (String font, int pixelSize, boolean bold, boolean italic, boolean underlined)
void	zoomRectangle (int x1, int y1, int x2, int y2)
void	update ()
void	addMenuBarItem (String parent, String name, int id, boolean checked)
void	addMenuBarItem (String parent, String name)
void	addMenuBarItem (String parent, String name, int id)
void	addMessage (String message)
void	showInputDialog (String msg, String def, int id, SVEventType evtype)
void	showInputDialog (String msg)
void	showYesNoDialog (String msg)
void	addPopupMenuItem (String parent, String name)
void	addPopupMenuItem (String parent, String name, int cmdEvent, String value, String desc)
void	destroy ()
void	openImage (String filename)
Public Attributes
int	hash
SVPopupMenu	svPuMenu = null
PCanvas	canvas
Static Public Attributes
static final double	SCALING_FACTOR = 2
static int	nrWindows = 0
Package Attributes
PLayer	layer
Color	currentPenColor
Color	currentBrushColor
Font	currentFont
BasicStroke	stroke = new BasicStroke(0.5f)

Detailed Description

The SVWindow is the top-level ui class. It should get instantiated whenever the user intends to create a new window. It contains helper functions to draw on the canvas, add new menu items, show modal dialogs etc.

Author:: wanke@google.com

Definition at line 54 of file SVWindow.java.

Constructor & Destructor Documentation

com.google.scrollview.ui.SVWindow.SVWindow	(	String	name,
		int	hash,
		int	posX,
		int	posY,
		int	sizeX,
		int	sizeY,
		int	canvasSizeX,
		int	canvasSizeY
	)		`[inline]`

Construct a new SVWindow and set it visible.

Parameters:

name	Title of the window.
hash	Unique internal representation. This has to be the same as defined by the client, as they use this to refer to the windows.
posX	X position of where to draw the window (upper left).
posY	Y position of where to draw the window (upper left).
sizeX	The width of the window.
sizeY	The height of the window.
canvasSizeX	The canvas width of the window.
canvasSizeY	The canvas height of the window.

Definition at line 193 of file SVWindow.java.

                                                               {
    super(name);

    // Provide defaults for sizes.
    if (sizeX == 0) sizeX = canvasSizeX;
    if (sizeY == 0) sizeY = canvasSizeY;
    if (canvasSizeX == 0) canvasSizeX = sizeX;
    if (canvasSizeY == 0) canvasSizeY = sizeY;

    // Initialize variables
    nrWindows++;
    this.hash = hash;
    this.svEventHandler = new SVEventHandler(this);
    this.currentPenColor = Color.BLACK;
    this.currentBrushColor = Color.BLACK;
    this.currentFont = new Font("Times New Roman", Font.PLAIN, 12);

    // Determine the initial size and zoom factor of the window.
    // If the window is too big, rescale it and zoom out.
    int shrinkfactor = 1;

    if (sizeX > MAX_WINDOW_X) {
      shrinkfactor = (sizeX + MAX_WINDOW_X - 1) / MAX_WINDOW_X;
    }
    if (sizeY / shrinkfactor > MAX_WINDOW_Y) {
      shrinkfactor = (sizeY + MAX_WINDOW_Y - 1) / MAX_WINDOW_Y;
    }
    winSizeX = sizeX / shrinkfactor;
    winSizeY = sizeY / shrinkfactor;
    double initialScalingfactor = 1.0 / shrinkfactor;
    if (winSizeX > canvasSizeX || winSizeY > canvasSizeY) {
      initialScalingfactor = Math.min(1.0 * winSizeX / canvasSizeX,
                                      1.0 * winSizeY / canvasSizeY);
    }

    // Setup the actual window (its size, camera, title, etc.)
    if (canvas == null) {
      canvas = new PCanvas();
      getContentPane().add(canvas, BorderLayout.CENTER);
    }

    layer = canvas.getLayer();
    canvas.setBackground(Color.BLACK);

    // Disable anitaliasing to make the lines more visible.
    canvas.setDefaultRenderQuality(PPaintContext.LOW_QUALITY_RENDERING);

    setLayout(new BorderLayout());

    setDefaultCloseOperation(WindowConstants.DISPOSE_ON_CLOSE);

    validate();
    canvas.requestFocus();

    // Manipulation of Piccolo's scene graph should be done from Swings
    // event dispatch thread since Piccolo is not thread safe. This code calls
    // initialize() from that thread once the PFrame is initialized, so you are
    // safe to start working with Piccolo in the initialize() method.
    SwingUtilities.invokeLater(new Runnable() {
      public void run() {
        repaint();
      }
    });

    setSize(winSizeX, winSizeY);
    setLocation(posX, posY);
    setTitle(name);

    // Add a Scrollpane to be able to scroll within the canvas
    PScrollPane scrollPane = new PScrollPane(canvas);
    getContentPane().add(scrollPane);
    scrollPane.setWheelScrollingEnabled(false);
    PCamera lc = canvas.getCamera();
    lc.scaleViewAboutPoint(initialScalingfactor, 0, 0);

    // Disable the default event handlers and add our own.
    addWindowListener(svEventHandler);
    canvas.removeInputEventListener(canvas.getPanEventHandler());
    canvas.removeInputEventListener(canvas.getZoomEventHandler());
    canvas.addInputEventListener(svEventHandler);
    canvas.addKeyListener(svEventHandler);

    // Make the window visible.
    validate();
    setVisible(true);

  }

Member Function Documentation

void com.google.scrollview.ui.SVWindow.addMenuBarItem	(	String	parent,
		String	name,
		int	id,
		boolean	checked
	)		`[inline]`

Adds a checkbox entry to the menubar, c.f. SVMenubar.add(...)

Definition at line 493 of file SVWindow.java.

                                              {
    svMenuBar.add(parent, name, id, checked);
  }

void com.google.scrollview.ui.SVWindow.addMenuBarItem	(	String	parent,
		String	name
	)		`[inline]`

Adds a submenu to the menubar, c.f. SVMenubar.add(...)

Definition at line 499 of file SVWindow.java.

                                                         {
    addMenuBarItem(parent, name, -1);
  }

void com.google.scrollview.ui.SVWindow.addMenuBarItem	(	String	parent,
		String	name,
		int	id
	)		`[inline]`

Adds a new entry to the menubar, c.f. SVMenubar.add(...)

Definition at line 504 of file SVWindow.java.

                                                                 {
    if (svMenuBar == null) {
      svMenuBar = new SVMenuBar(this);

    }
    svMenuBar.add(parent, name, id);
  }

void com.google.scrollview.ui.SVWindow.addMessage ( String message ) [inline]

Add a message to the message box.

Definition at line 513 of file SVWindow.java.

                                         {
    if (ta != null) {
      ta.append(message + "\n");
    } else {
      System.out.println(message + "\n");
    }
  }

void com.google.scrollview.ui.SVWindow.addMessageBox ( ) [inline]

Convenience function to add a message box to the window which can be used to output debug information.

Definition at line 286 of file SVWindow.java.

                              {
    if (ta == null) {
      ta = new TextArea();
      ta.setEditable(false);
      getContentPane().add(ta, BorderLayout.SOUTH);
    }
    // We need to make the window bigger to accomodate the message box.
    winSizeY += DEF_MESSAGEBOX_HEIGHT;
    setSize(winSizeX, winSizeY);
  }

void com.google.scrollview.ui.SVWindow.addPopupMenuItem	(	String	parent,
		String	name
	)		`[inline]`

Adds a submenu to the popup menu, c.f. SVPopupMenu.add(...)

Definition at line 609 of file SVWindow.java.

                                                           {
    if (svPuMenu == null) {
      svPuMenu = new SVPopupMenu(this);
    }
    svPuMenu.add(parent, name, -1);
  }

void com.google.scrollview.ui.SVWindow.addPopupMenuItem	(	String	parent,
		String	name,
		int	cmdEvent,
		String	value,
		String	desc
	)		`[inline]`

Adds a new menu entry to the popup menu, c.f. SVPopupMenu.add(...)

Definition at line 617 of file SVWindow.java.

                                 {
    if (svPuMenu == null) {
      svPuMenu = new SVPopupMenu(this);
    }
    svPuMenu.add(parent, name, cmdEvent, value, desc);
  }

void com.google.scrollview.ui.SVWindow.brush	(	int	red,
		int	green,
		int	blue
	)		`[inline]`

Set the brush to an RGB color

Definition at line 120 of file SVWindow.java.

                                                  {
    brush(red, green, blue, 255);
  }

void com.google.scrollview.ui.SVWindow.brush	(	int	red,
		int	green,
		int	blue,
		int	alpha
	)		`[inline]`

Set the brush to an RGBA color

Definition at line 125 of file SVWindow.java.

                                                             {
    // If alpha is zero, use a null brush to save rendering time.
    if (alpha == 0) {
      currentBrushColor = null;
    } else {
      currentBrushColor = new Color(red, green, blue, alpha);
    }
  }

void com.google.scrollview.ui.SVWindow.clear ( ) [inline]

Erase all content from the window, but do not destroy it.

Definition at line 135 of file SVWindow.java.

                      {
    layer.removeAllChildren();
  }

void com.google.scrollview.ui.SVWindow.createImage	(	String	internalName,
		int	width,
		int	height,
		int	bitsPerPixel
	)		`[inline]`

Start setting up a new image. The server will now expect image data until the image is complete.

Parameters:

internalName	The unique name of the new image
width	Image width
height	Image height
bitsPerPixel	The bit depth (currently supported: 1 (binary) and 32 (ARGB))

Definition at line 149 of file SVWindow.java.

                        {
    SVImageHandler.createImage(internalName, width, height, bitsPerPixel);
  }

void com.google.scrollview.ui.SVWindow.createPolyline ( int length ) [inline]

Start setting up a new polyline. The server will now expect polyline data until the polyline is complete.

Parameters:

length number of coordinate pairs

Definition at line 160 of file SVWindow.java.

                                         {
    ScrollView.polylineXCoords = new float[length];
    ScrollView.polylineYCoords = new float[length];
    ScrollView.polylineSize = length;
    ScrollView.polylineScanned = 0;
  }

void com.google.scrollview.ui.SVWindow.destroy ( ) [inline]

Destroys a window.

Definition at line 626 of file SVWindow.java.

                        {
    ScrollView.addMessage(new SVEvent(SVEventType.SVET_DESTROY, this, 0,
        "SVET_DESTROY"));
    setVisible(false);
    // dispose();
  }

void com.google.scrollview.ui.SVWindow.drawEllipse	(	int	x,
		int	y,
		int	width,
		int	height
	)		`[inline]`

Draw an ellipse at (x,y) with given width and height, using the current stroke, the current brush color to fill it and the current pen color for the outline.

Definition at line 313 of file SVWindow.java.

                                                               {
    PPath pn = PPath.createEllipse(x, y, width, height);
    pn.setStrokePaint(currentPenColor);
    pn.setStroke(stroke);
    pn.setPaint(currentBrushColor);
    layer.addChild(pn);
  }

void com.google.scrollview.ui.SVWindow.drawImage	(	String	internalName,
		int	x_pos,
		int	y_pos
	)		`[inline]`

Draw the image with the given name at (x,y). Any image loaded stays in memory, so if you intend to redraw an image, you do not have to use createImage again.

Definition at line 326 of file SVWindow.java.

                                                                   {
    PImage img = SVImageHandler.getImage(internalName);
    img.setX(x_pos);
    img.setY(y_pos);
    layer.addChild(img);
  }

void com.google.scrollview.ui.SVWindow.drawLine	(	int	x1,
		int	y1,
		int	x2,
		int	y2
	)		`[inline]`

Draw a line from (x1,y1) to (x2,y2) using the current pen color and stroke.

Definition at line 336 of file SVWindow.java.

                                                       {
    PPath pn = PPath.createLine(x1, y1, x2, y2);
    pn.setStrokePaint(currentPenColor);
    pn.setPaint(null);  // Null paint may render faster than the default.
    pn.setStroke(stroke);
    pn.moveTo(x1, y1);
    pn.lineTo(x2, y2);
    layer.addChild(pn);
  }

void com.google.scrollview.ui.SVWindow.drawPolyline ( ) [inline]

Draw the now complete polyline.

Definition at line 170 of file SVWindow.java.

                             {
    PPath pn = PPath.createPolyline(ScrollView.polylineXCoords,
                                    ScrollView.polylineYCoords);
    ScrollView.polylineSize = 0;
    pn.setStrokePaint(currentPenColor);
    pn.setPaint(null);  // Don't fill the polygon - this is just a polyline.
    pn.setStroke(stroke);
    layer.addChild(pn);
  }

void com.google.scrollview.ui.SVWindow.drawRectangle	(	int	x1,
		int	y1,
		int	x2,
		int	y2
	)		`[inline]`

Draw a rectangle given the two points (x1,y1) and (x2,y2) using the current stroke, pen color for the border and the brush to fill the interior.

Definition at line 351 of file SVWindow.java.

                                                            {

    if (x1 > x2) {
      int t = x1;
      x1 = x2;
      x2 = t;
    }
    if (y1 > y2) {
      int t = y1;
      y1 = y2;
      y2 = t;
    }

    PPath pn = PPath.createRectangle(x1, y1, x2 - x1, y2 - y1);
    pn.setStrokePaint(currentPenColor);
    pn.setStroke(stroke);
    pn.setPaint(currentBrushColor);
    layer.addChild(pn);
  }

void com.google.scrollview.ui.SVWindow.drawText	(	int	x,
		int	y,
		String	text
	)		`[inline]`

Draw some text at (x,y) using the current pen color and text attributes. If the current font does NOT support at least one character, it tries to find a font which is capable of displaying it and use that to render the text. Note: If the font says it can render a glyph, but in reality it turns out to be crap, there is nothing we can do about it.

Definition at line 378 of file SVWindow.java.

                                                  {
    int unreadableCharAt = -1;
    char[] chars = text.toCharArray();
    PText pt = new PText(text);
    pt.setTextPaint(currentPenColor);
    pt.setFont(currentFont);

    // Check to see if every character can be displayed by the current font.
    for (int i = 0; i < chars.length; i++) {
      if (!currentFont.canDisplay(chars[i])) {
        // Set to the first not displayable character.
        unreadableCharAt = i;
        break;
      }
    }

    // Have to find some working font and use it for this text entry.
    if (unreadableCharAt != -1) {
      Font[] allfonts =
          GraphicsEnvironment.getLocalGraphicsEnvironment().getAllFonts();
      for (int j = 0; j < allfonts.length; j++) {
        if (allfonts[j].canDisplay(chars[unreadableCharAt])) {
          Font tempFont =
              new Font(allfonts[j].getFontName(), currentFont.getStyle(),
                  currentFont.getSize());
          pt.setFont(tempFont);
          break;
        }
      }
    }

    pt.setX(x);
    pt.setY(y);
    layer.addChild(pt);
  }

void com.google.scrollview.ui.SVWindow.openImage ( String filename ) [inline]

Open an image from a given file location and store it in memory. Pro: Faster than createImage. Con: Works only on the local file system.

Parameters:

filename The path to the image.

Definition at line 639 of file SVWindow.java.

                                         {
    SVImageHandler.openImage(filename);
  }

void com.google.scrollview.ui.SVWindow.pen	(	int	red,
		int	green,
		int	blue
	)		`[inline]`

Set the pen color to an RGB value

Definition at line 415 of file SVWindow.java.

                                                {
    pen(red, green, blue, 255);
  }

void com.google.scrollview.ui.SVWindow.pen	(	int	red,
		int	green,
		int	blue,
		int	alpha
	)		`[inline]`

Set the pen color to an RGBA value

Definition at line 420 of file SVWindow.java.

                                                           {
    currentPenColor = new Color(red, green, blue, alpha);
  }

void com.google.scrollview.ui.SVWindow.setStrokeWidth ( float width ) [inline]

Allows you to specify the thickness with which to draw lines, recantgles and ellipses.

Parameters:

width The new thickness.

Definition at line 302 of file SVWindow.java.

                                          {
    // If this worked we wouldn't need the antialiased rendering off.
    // stroke = new PFixedWidthStroke(width);
    stroke = new BasicStroke(width);
  }

void com.google.scrollview.ui.SVWindow.showInputDialog	(	String	msg,
		String	def,
		int	id,
		SVEventType	evtype
	)		`[inline]`

Show a modal input dialog. The answer by the dialog is then send to the client, together with the associated menu id, as SVET_POPUP

Parameters:

msg	The text that is displayed in the dialog.
def	The default value of the dialog.
id	The associated commandId
evtype	The event this is associated with (usually SVET_MENU or SVET_POPUP)

Definition at line 561 of file SVWindow.java.

                                                  {
    svEventHandler.timer.stop();
    String tmp =
        (String) JOptionPane.showInputDialog(this, msg, "",
            JOptionPane.QUESTION_MESSAGE, null, null, def);

    if (tmp != null) {
      tmp = convertIntegerStringToUnicodeString(tmp);
      SVEvent res = new SVEvent(evtype, this, id, tmp);
      ScrollView.addMessage(res);
    }
    svEventHandler.timer.restart();
  }

void com.google.scrollview.ui.SVWindow.showInputDialog ( String msg ) [inline]

Shows a modal input dialog to the user. The return value is automatically sent to the client as SVET_INPUT event (with command id -1).

Parameters:

msg	The text of the dialog.

Definition at line 583 of file SVWindow.java.

                                          {
    showInputDialog(msg, null, -1, SVEventType.SVET_INPUT);
  }

void com.google.scrollview.ui.SVWindow.showYesNoDialog ( String msg ) [inline]

Shows a dialog presenting "Yes" and "No" as answers and returns either a "y" or "n" to the client.

Parameters:

msg	The text that is displayed in the dialog.

Definition at line 593 of file SVWindow.java.

                                          {
    // res returns 0 on yes, 1 on no. Seems to be a bit counterintuitive
    int res =
        JOptionPane.showOptionDialog(this, msg, "", JOptionPane.YES_NO_OPTION,
            JOptionPane.QUESTION_MESSAGE, null, null, null);
    SVEvent e = null;

    if (res == 0) {
      e = new SVEvent(SVEventType.SVET_INPUT, this, 0, 0, 0, 0, "y");
    } else if (res == 1) {
      e = new SVEvent(SVEventType.SVET_INPUT, this, 0, 0, 0, 0, "n");
    }
    ScrollView.addMessage(e);
  }

void com.google.scrollview.ui.SVWindow.textAttributes	(	String	font,
		int	pixelSize,
		boolean	bold,
		boolean	italic,
		boolean	underlined
	)		`[inline]`

Define how to display text. Note: underlined is not currently not supported

Definition at line 427 of file SVWindow.java.

                                          {

    // For legacy reasons convert "Times" to "Times New Roman"
    if (font.equals("Times")) {
      font = "Times New Roman";
    }

    int style = Font.PLAIN;
    if (bold) {
      style += Font.BOLD;
    }
    if (italic) {
      style += Font.ITALIC;
    }
    currentFont = new Font(font, style, pixelSize);
  }

void com.google.scrollview.ui.SVWindow.update ( ) [inline]

Flush buffers and update display.

Only actually reacts if there are no more messages in the stack, to prevent the canvas from flickering.

Definition at line 475 of file SVWindow.java.

                       {
    // TODO(rays) fix bugs in piccolo or use something else.
    // The repaint function generates many
    // exceptions for no good reason. We catch and ignore as many as we
    // can here, but most of them are generated by the system repaints
    // caused by resizing/exposing parts of the window etc, and they
    // generate unwanted stack traces that have to be piped to /dev/null
    // (on linux).
    try {
      repaint();
    } catch (NullPointerException e) {
      // Do nothing so the output isn't full of stack traces.
    } catch (IllegalPathStateException e) {
      // Do nothing so the output isn't full of stack traces.
    }
  }

void com.google.scrollview.ui.SVWindow.zoomRectangle	(	int	x1,
		int	y1,
		int	x2,
		int	y2
	)		`[inline]`

Zoom the window to the rectangle given the two points (x1,y1) and (x2,y2), which must be greater than (x1,y1).

Definition at line 449 of file SVWindow.java.

                                                            {
    if (x2 > x1 && y2 > y1) {
      winSizeX = getWidth();
      winSizeY = getHeight();
      int width = x2 - x1;
      int height = y2 - y1;
      // Since piccolo doesn't do this well either, pad with a margin
      // all the way around.
      int wmargin = width / 2;
      int hmargin = height / 2;
      double scalefactor = Math.min(winSizeX / (2.0 * wmargin + width),
                                    winSizeY / (2.0 * hmargin + height));
      PCamera lc = canvas.getCamera();
      lc.scaleView(scalefactor / lc.getViewScale());
      lc.animateViewToPanToBounds(new Rectangle(x1 - hmargin, y1 - hmargin,
                                                2 * wmargin + width,
                                                2 * hmargin + height), 0);
    }
  }