Jump to: navigation, search

Difference between revisions of "Scout/Tutorial/3.8/SVG Field"

< Scout‎ | Tutorial‎ | 3.8
(Introduction)
m (Load the SVG file from the client bundle resources)
 
(One intermediate revision by one other user not shown)
Line 11: Line 11:
  
 
{{warning|Mac OS X|There is a Bug on Mac OS X when using the Oracle JDK 7: [[https://bugs.eclipse.org/bugs/show_bug.cgi?id=378442 378442]]. If you need SVG support on Mac please use the Apple JDK 6 until the bug is solved.}}
 
{{warning|Mac OS X|There is a Bug on Mac OS X when using the Oracle JDK 7: [[https://bugs.eclipse.org/bugs/show_bug.cgi?id=378442 378442]]. If you need SVG support on Mac please use the Apple JDK 6 until the bug is solved.}}
 +
 
<!--
 
<!--
 
== Getting started ==  
 
== Getting started ==  
Line 163: Line 164:
 
As in the case for the static SVG field add an implementation for method ''execInitField''. Below is the code to load the previously created SVG into the SVG field from the client bundle:
 
As in the case for the static SVG field add an implementation for method ''execInitField''. Below is the code to load the previously created SVG into the SVG field from the client bundle:
  
{{warning|Import|There are several suggestions for imports  when you hover ''Activator''. Make sure you use the org.eclipse.scout.svgtest.client import for ''Activator''. (and java.io for InputStream)}}
+
{{warning|Import|There are several suggestions for imports  when you hover ''Activator''. Make sure you select the correct one: Use ''org.eclipse.scout.'''svgtest'''.client'' (and java.io for InputStream)}}
  
 
   @Override
 
   @Override

Latest revision as of 04:31, 21 September 2012


Scout
Wiki Home
Website
DownloadGit
Community
ForumsBlogTwitter
Bugzilla
Bugzilla


Introduction

With Scout Release 3.8 Scout offers support to handle Scalable Vector Graphics (SVG). For this, new a SVG field is introduced as an additional UI component. This field enhances Eclipse Scout with the ability to display interactive diagrams and graphics that work on desktop as well as on web environment.

This tutorial demonstrates

  • Displaying a static SVG field (view only)
  • Displaying an interactive SVG field using embedded hyperlinks.


Warning2.png
Mac OS X
There is a Bug on Mac OS X when using the Oracle JDK 7: [378442]. If you need SVG support on Mac please use the Apple JDK 6 until the bug is solved.


Create a Scout Application with SVG Fields

Create a new Scout application

As a first step create a new Scout application in the Scout perspective. For this, choose one of the following options

  • Use menu File, New, Project ..., Scout Project
  • In the Scout Explorer on the top levle node use context menu New Scout Project ...

In the New Scout Project dialog

  1. Enter org.eclipse.scout.svgtest into field Project Name
  2. Untick node org.eclipse.scout.svgtest.ui.rap
  3. Click Finish
Scout SDK: Create a new Scout project

More details can be found here.

Add SVG support to the application

For this, do the following

  1. Go to the projects top level node in the Scout Explorer
  2. Go to the Scout Property View and tick the check box Scalable Vector Graphics (SVG) as indicated by the red arrow.
Scout SDK: Add SVG Support to Scout application

Add the static SVG field to the DesktopForm

To add a SVG field to the DesktopForm do the following

  1. Go to the Scout Explorer
  2. Open the node Client and the folder Forms
  3. Expand the DesktopForm and click on node MainBox as indicated by the red arrow
  4. Use context menu New Form Field ... on node MainBox
  5. Select SvgField as shown below, click Next > and enter StaticSVG as class name for the field
Scout SDK: Add an SVG form field

Add an SVG Image

  1. In the Scout Explorer expand the MainBox and click on the newly created node StaticSvgField
  2. Go to the Scout Object Properties
  3. Enter 3 in filed Grid H to provide a decent height for the SVG field
  4. Click on the green cross next to operation ExecInitField to add the init method
  5. Add the following implementation for to method execInitField()
 @Override
 protected void execInitField() throws ProcessingException {
   String xml =
             "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>\n" +
                 "<svg width=\"400\" height=\"400\" viewBox=\"0 0 400 400\" \n" +
                 "     xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" \n" +
                 "     contentScriptType=\"text/ecmascript\" zoomAndPan=\"magnify\" \n" +
                 "     contentStyleType=\"text/css\" version=\"1.1\" xml:space=\"preserve\" \n" +
                 "     preserveAspectRatio=\"xMidYMid meet\"\n" +
                 ">\n" +
                 "  <a xlink:href=\"http://local/polygon\">\n" +
                 "    <polygon id=\"poly\" points=\"220,100 300,210 170,250 123,234\" \n" +
                 "             style=\"fill:#f5950d;stroke:red;stroke-width:3\" />\n" +
                 "  </a>\n" +
                 "  <a xlink:href=\"http://local/circle\">\n" +
                 "  <circle id=\"circle\" cx=\"200\" cy=\"100\" r=\"40\" \n" +
                 "          stroke=\"blue\" stroke-width=\"2\" fill=\"#00678c\" />\n" +
                 "  </a>\n" +
                 "</svg>";
   SVGDocument doc = SVGUtility.readSVGDocument(new ByteArrayInputStream(xml.getBytes()));
   setSvgDocument(doc);
 }

Handling SVG Hyperlink Clicks

A hyperlink event is fired when the user clicks on a SVG element containing an hyperlink. The URL may also contain GET parameters. A hyperlink event handler could then parse this URL and these parameters and open a new form for this entity. E.g. the hyperlink could be http://local/person_nr?1234. The event handler could open the PersonForm for the person with the ID 1234 when the hyperlink event is fired.

In our example document hyperlinks are declared for the polygon and the circle, using http://local/polygon and http://local/circle respectively.

 <a xlink:href="http://local/polygon">
 ...
 <a xlink:href="http://local/circle">
 ...

Whenever the user clicks on a hyperlink in the SVG field the corresponding execHyperlink event handler routine is called. Processing of user clicks on hyperlinks embedded in the SVG can be implemented by overriding method execHyperlink for the SVG field. For this, follow the steps below.

  1. In the Scout Explorer click on node StaticSvgField
  2. Open Advanced Operations in the SVG field's Scout Object Properties
  3. Click on the green cross next to operation ExecHyperlink to add the method
  4. The implementation below will show a message box when the user clicks on the circle
 @Override
 protected void execHyperlink(SvgFieldEvent e) throws ProcessingException {
   String url = e.getURL().toExternalForm();
   
   // checking for a match with 'http://local/circle'
   if (url.contains("circle")) {
     MessageBox.showOkMessage("Hyperlink Event", "You have clicked the circle", "URL: " + url);
   }
 }

Verify the result

To verify the resulting SVG field server and client can be started

  1. In the Scout Explorer go to the projects top level node
  2. Go to the Scout Object Properties to section Product Launchers
    1. Start the server (lower green arrow)
    2. Start the client (upper green arrow)
Scout SDK: Add an SVG form field

Adding the interactive SVG diagram field

Now we're looking at more realistic scenario where we load the SVG file "SampleGraphic.svg" from the client bundle.

First, we add a second SVG field to the DesktopForm

  1. Go to the Scout Explorer
  2. Open the node Client and the folder Forms
  3. Expand the DesktopForm and click on node MainBox as indicated by the red arrow
  4. Use context menu New Form Field ... on node MainBox
  5. Select SvgField as shown below, click Next > and enter Dynamic SVG as name for the new field

Create a SVG file in the client bundle

For this, you first have to switch to the Package Explorer

Scout-PackageExplorer.png

  1. Open the bundle org.eclipse.scout.svgtest.client
  2. Create folder (New->Other..) svg below folder resources and add a new empty file "SampleGraphic.svg"


Scout-PackageExplorer-SVGFile.PNG

Now, Open this file in the text editor and copy the following content into it

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<svg width="400" height="400" viewBox="0 0 400 400" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" contentScriptType="text/ecmascript" zoomAndPan="magnify" 
  contentStyleType="text/css" version="1.1" xml:space="preserve" preserveAspectRatio="xMidYMid meet">
  <a xlink:href="http://local/polygon">
   <polygon id="poly" points="220,100 300,210 170,250 123,234" style="fill:#cccccc;stroke:#000000;stroke-width:1"/>
  </a>
  <a xlink:href="http://local/circle">
   <circle id="circle" cx="100" cy="50" r="40" stroke="black" stroke-width="2" fill="grey" />
  </a>
</svg>

Load the SVG file from the client bundle resources

As in the case for the static SVG field add an implementation for method execInitField. Below is the code to load the previously created SVG into the SVG field from the client bundle:

Warning2.png
Import
There are several suggestions for imports when you hover Activator. Make sure you select the correct one: Use org.eclipse.scout.svgtest.client (and java.io for InputStream)


 @Override
 protected void execInitField() throws ProcessingException {
   try {
     URL url = Activator.getDefault().getBundle().getResource("/resources/svg/SampleGraphic.svg");
     InputStream is = url.openStream();
     SVGDocument svgDoc = SVGUtility.readSVGDocument(is);
     setSvgDocument(svgDoc);
   }
   catch (IOException e) {
     e.printStackTrace();
     throw new ProcessingException("Exception occured while reading svg file", e);
   }
 }

Modify the SVG dynamically

For the case of this dynamic SVG field we will directly modify the shown SVG document based on the clicks the user makes on the circle or the polygon.

  1. In the Scout Explorer expand the MainBox and click on the previous created node DynamicSvgField
  2. Go to the Scout Object Properties to Advanced Operations
  3. Click on the green cross next to operation Exec Hyperlink to add the method
Scout SDK: Add Hyperlink Event Handler

Add the implementation for to method execHyperlink() as shown below. In this implementation we first get a copy of the currently shown SVG document, and then update individual SVG elements depending on the shape that the user clicked. If the polygon was clicked, one of its corner will be shifted to the right. If the circle was clicked, it will be moved to the left.

 @Override
 protected void execHyperlink(SvgFieldEvent e) throws ProcessingException {
   if (e.getURL() == null) return;
     // create a copy...
     SVGDocument doc = (SVGDocument) getSvgDocument().cloneNode(true);
     String url = e.getURL().toExternalForm();
     if ("http://local/polygon".equals(url)) {
       // ... move a corner of the polygon to the right
       SVGPolygonElement poly = (SVGPolygonElement) doc.getElementById("poly");
       SVGPointList pointList = poly.getPoints();
       SVGPoint p = pointList.getItem(2);
       p.setX(p.getX() + 10);
     }
     else if ("http://local/circle".equals(url)) {
       // ... move circle to the left
       SVGCircleElement circle = (SVGCircleElement) doc.getElementById("circle");
       SVGLength cx = circle.getCx().getBaseVal();
       cx.setValue(cx.getValue() - 10);
     }
     else {
       throw new ProcessingException("Unsupported Link: " + url);
     }
     setSvgDocument(doc);
 }

The final example

SVG field interaction: Shifted Polygon and Circle several times to the right