Google Git
Sign in
apache / xmlgraphics-website / 4ce07896280b37b790f3ebbf67003e9883cea534 / . / output / batik / using / scripting / java.html
blob: eb5808d0300737a1875e36915d98628f5b019279 [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta property="og:image" content="http://www.apache.org/images/asf_logo.gif" />
<!--
<link rel="stylesheet" type="text/css" media="screen" href="http://www.apache.org/css/style.css">
-->
<link rel="stylesheet" type="text/css" media="screen" href="https://www.apache.org/css/code.css">
<link href="/css/profile.css" rel="stylesheet" type="text/css" />
<link href="/css/xmlgraphics.css" rel="stylesheet" type="text/css" />
<link href="/css/print.css" rel="stylesheet" type="text/css" media="print" />
<script src="https://code.jquery.com/jquery.min.js"></script>
<script type="text/javascript" src="/js/jquery.stoc.js"></script>
<script>
$(document).ready(function(){
$('ul#navigation a').each(function() {
if (this.href === window.location.href)
{ $(this). attr('id', 'forefront');}
});
$('ul#navigation a#forefront').each(function() {
});
})
$(function(){
$("#items").stoc({ search: "#content", stocTitle: "<h3>Page Contents</h3>" });
});
</script>
<style>
.highlight {color: red;}
</style>
</head>
<body>
<div id="banner">&nbsp;
</div>
<div id="navigation">
<style type="text/css">
/* The following code is added by mdx_elementid.py
It was originally lifted from http://subversion.apache.org/style/site.css */
/*
* Hide class="elementid-permalink", except when an enclosing heading
* has the :hover property.
*/
.headerlink, .elementid-permalink {
visibility: hidden;
}
h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
<p><a href="/"><img alt="Apache XML Graphics Project Logo" src="/images/apache-xml-graphics.gif" title="Apache XML Graphics Project" /></a></p>
<h1 id="apache-batik">Apache Batik<a class="headerlink" href="#apache-batik" title="Permanent link">&para;</a></h1>
<ul>
<li><a href="/batik/">Overview</a></li>
<li><a href="/batik/license.html">License</a></li>
<li><a href="/batik/download.html">Download</a></li>
<li><a href="/batik/install.html">Notes</a></li>
<li><a href="/batik/status.html">Status</a></li>
<li><a href="/batik/demo-static.html">Demo</a></li>
<li><a href="/batik/faq.html">FAQs</a></li>
<li><a href="https://cwiki.apache.org/confluence/display/XMLGRAPHICSBATIK">Batik Wiki</a></li>
<li><a href="/batik/mailing-lists.html">Mailing lists</a></li>
<li><a href="/batik/contributors.html">Contributors</a></li>
<li><a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20BATIK%20AND%20resolution%20%3D%20Unresolved%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29%20ORDER%20BY%20priority%20DESC">Bug database</a></li>
<li><a href="/batik/uses.html">Projects using Batik</a></li>
<li>
<h2 id="batik-tools">Batik Tools<a class="headerlink" href="#batik-tools" title="Permanent link">&para;</a></h2>
<ul>
<li><a href="/batik/tools/">Overview</a></li>
<li><a href="/batik/tools/browser.html">Browser</a></li>
<li><a href="/batik/tools/rasterizer.html">Rasterizer</a></li>
<li><a href="/batik/tools/font-converter.html">Font converter</a></li>
<li><a href="/batik/tools/pretty-printer.html">Pretty printer</a></li>
</ul>
</li>
<li>
<h2 id="using-batik">Using Batik<a class="headerlink" href="#using-batik" title="Permanent link">&para;</a></h2>
<ul>
<li><a href="/batik/using/">Overview</a></li>
<li><a href="/batik/using/architecture.html">Architecture</a></li>
<li><a href="/batik/javadoc/">Javadoc APIs</a></li>
<li><a href="/batik/using/dom-api.html">DOM API</a></li>
<li><a href="/batik/using/parsers.html">Parsers</a></li>
<li>
<h3 id="scripting">Scripting<a class="headerlink" href="#scripting" title="Permanent link">&para;</a></h3>
</li>
<li><a href="/batik/using/scripting/ecmascript.html">Scripting with ECMAScript</a></li>
<li><a href="/batik/using/scripting/java.html">Scripting with Java</a></li>
<li><a href="/batik/using/scripting/security.html">Scripting with Security</a></li>
<li><a href="/batik/using/svg-generator.html">SVG generator</a></li>
<li><a href="/batik/using/swing.html">Swing components</a></li>
<li><a href="/batik/using/transcoder.html">Transcoder API</a></li>
<li><a href="/batik/using/extending.html">Extending Batik</a></li>
</ul>
</li>
<li>
<h2 id="development">Development<a class="headerlink" href="#development" title="Permanent link">&para;</a></h2>
<ul>
<li><a href="/batik/dev/">Overview</a></li>
<li><a href="/batik/dev/branches.html">Branches</a></li>
<li><a href="/batik/dev/svg12.html">SVG 1.2 support</a></li>
<li><a href="/batik/dev/test.html">Test infrastructure</a></li>
</ul>
</li>
</ul>
<h1 id="apache-xml-graphics">Apache&trade; XML Graphics<a class="headerlink" href="#apache-xml-graphics" title="Permanent link">&para;</a></h1>
<ul>
<li>
<h3 id="project-overview">Project Overview<a class="headerlink" href="#project-overview" title="Permanent link">&para;</a></h3>
<ul>
<li><a href="/team.html">Who We Are</a></li>
<li><a href="/legal.html">Legal Stuff</a></li>
<li><a href="/charter.html">Project Charter</a></li>
<li><a href="/mail.html">Mailing Lists</a></li>
<li><a href="/repo.html">Code Repositories</a></li>
<li><a href="https://www.apache.org/foundation/sponsorship.html">ASF Sponsorship Program</a></li>
<li><a href="https://www.apache.org/foundation/thanks.html">ASF Thanks</a></li>
<li><a href="https://www.apache.org/licenses/">Licenses</a></li>
<li><a href="/security.html">Apache XML Graphics Security</a></li>
<li><a href="https://www.apache.org/security/">ASF Security</a></li>
</ul>
</li>
</ul>
<h1 id="sub-projects">Sub Projects<a class="headerlink" href="#sub-projects" title="Permanent link">&para;</a></h1>
<ul>
<li><a href="/fop/">Apache FOP</a></li>
<li><a href="/commons/">Apache XML Graphics Commons</a></li>
</ul>
<h2 id="search-apache-xml-graphics">Search Apache XML Graphics<a class="headerlink" href="#search-apache-xml-graphics" title="Permanent link">&para;</a></h2>
<form name="search" id="search" action="https://www.google.com/search" method="get">
<input value="xmlgraphics.apache.org" name="sitesearch" type="hidden"/>
<input type="text" name="q" id="query" />
<input type="submit" id="submit" value="Search" />
</form>
<h3 id="apachecon-n-america">ApacheCon N. America<a class="headerlink" href="#apachecon-n-america" title="Permanent link">&para;</a></h3>
<p><a title="ApacheCon North America" href="https://www.apachecon.com"><img class="apachecon_logo" alt="ApacheCon North America" src="https://www.apachecon.com/images/landingpage/apachecon-logo.png" width="200" /></a><br /><br /></p>
<ul>
<li><strong><a href="https://www.apachecon.com/">ApacheCon NA</a></strong></li>
</ul>
<p>Hope to see you there!</p>
<h3 id="apachecon-europe">ApacheCon Europe<a class="headerlink" href="#apachecon-europe" title="Permanent link">&para;</a></h3>
<p><a title="ApacheCon Europe" href="https://www.apachecon.com"><img class="apachecon_logo" alt="ApacheCon Europe" src="https://www.apachecon.com/images/landingpage/apachecon-logo.png" width="200" /></a><br /><br /></p>
<ul>
<li><strong><a href="https://www.apachecon.com/">ApacheCon Europe</a></strong></li>
</ul>
<p>Hope to see you there!</p>
<p><a title="Apache Software Foundation" href="https://www.apache.org"><img id="asf_logo_url" alt="Apache Software Foundation " src="/images/asf_logo_url.png" width="200" /></a><br /><br /></p>
<p><a title="Support the Apache Software Foundation" href="https://donate.apache.org/"><img id="asf_support_url" alt="Support the Apache Software Foundation " src="https://blogs.apache.org/foundation/mediaresource/d67ca611-a57c-462d-ac23-95063f81d175" width="200" /></a></p>
<script>
$(document).ready(function () {
$('#navigation :header').click(function () {
var text = $(this).siblings('ul');
if (text.is(':hidden')) {
text.slideDown('200');
} else {
text.slideUp('200');
}
});
if ($('#navigation :header').siblings('ul')) {
$('#navigation :header').append(' &raquo;');
}
$('#navigation > ul > li ul').hide();
var str=location.href.toLowerCase();
$("#navigation li a").each(function() {
if (str.indexOf(this.href.toLowerCase()) > -1) {
$(this).parents().slideDown('200');
$("li.highlight").removeClass("highlight");
$(this).parent().addClass("highlight");
}
});
})
</script> </div>
<div id="bannertext" style="border-bottom: 2px dashed #666666; height: 100px;">
<a href="/batik/"><img src="/images/apache-batik-logo.png" alt="The Apache FOP Project" width="256" height="96" style="float:left; margin-right: 15px;" /></a>
<h2>The Apache&trade; Batik Project</h2>
</div>
<h1>Scripting With Java</h1>
<h1>Scripting With Java</h1>
<p>This page explains how to manipulate the DOM tree of an SVG document from a Java program.</p>
<h2 id="Swing">How to manipulate a document in a JSVGCanvas</h2>
<p>The follow code template demonstrates how to manipulate an SVG document displayed in a <a href="../../javadoc/org/apache/batik/swing/JSVGCanvas.html">JSVGCanvas</a> directly from a Java program.
You don’t have to worry about graphics updates; after each event listener invocation the canvas is updated if needed.</p>
<div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">java.awt.event.WindowAdapter</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">java.awt.event.WindowEvent</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">javax.swing.JFrame</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">org.apache.batik.swing.JSVGCanvas</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">org.apache.batik.swing.svg.SVGLoadEventDispatcherAdapter</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">org.apache.batik.swing.svg.SVGLoadEventDispatcherEvent</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">org.apache.batik.script.Window</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">org.w3c.dom.Document</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">org.w3c.dom.Element</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">org.w3c.dom.events.Event</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">org.w3c.dom.events.EventListener</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">org.w3c.dom.events.EventTarget</span><span class="o">;</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">SVGApplication</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="o">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="o">)</span> <span class="o">{</span>
<span class="k">new</span> <span class="n">SVGApplication</span><span class="o">();</span>
<span class="o">}</span>
<span class="n">JFrame</span> <span class="n">frame</span><span class="o">;</span>
<span class="n">JSVGCanvas</span> <span class="n">canvas</span><span class="o">;</span>
<span class="n">Document</span> <span class="n">document</span><span class="o">;</span>
<span class="n">Window</span> <span class="n">window</span><span class="o">;</span>
<span class="kd">public</span> <span class="nf">SVGApplication</span><span class="o">()</span> <span class="o">{</span>
<span class="n">frame</span> <span class="o">=</span> <span class="k">new</span> <span class="n">JFrame</span><span class="o">();</span>
<span class="n">canvas</span> <span class="o">=</span> <span class="k">new</span> <span class="n">JSVGCanvas</span><span class="o">();</span>
<span class="c1">// Forces the canvas to always be dynamic even if the current</span>
<span class="c1">// document does not contain scripting or animation.</span>
<span class="n">canvas</span><span class="o">.</span><span class="na">setDocumentState</span><span class="o">(</span><span class="n">JSVGCanvas</span><span class="o">.</span><span class="na">ALWAYS_DYNAMIC</span><span class="o">);</span>
<span class="n">canvas</span><span class="o">.</span><span class="na">addSVGLoadEventDispatcherListener</span>
<span class="o">(</span><span class="k">new</span> <span class="n">SVGLoadEventDispatcherAdapter</span><span class="o">()</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">svgLoadEventDispatchStarted</span>
<span class="o">(</span><span class="n">SVGLoadEventDispatcherEvent</span> <span class="n">e</span><span class="o">)</span> <span class="o">{</span>
<span class="c1">// At this time the document is available...</span>
<span class="n">document</span> <span class="o">=</span> <span class="n">canvas</span><span class="o">.</span><span class="na">getSVGDocument</span><span class="o">();</span>
<span class="c1">// ...and the window object too.</span>
<span class="n">window</span> <span class="o">=</span> <span class="n">canvas</span><span class="o">.</span><span class="na">getUpdateManager</span><span class="o">().</span>
<span class="n">getScriptingEnvironment</span><span class="o">().</span><span class="na">createWindow</span><span class="o">();</span>
<span class="c1">// Registers the listeners on the document</span>
<span class="c1">// just before the SVGLoad event is</span>
<span class="c1">// dispatched.</span>
<span class="n">registerListeners</span><span class="o">();</span>
<span class="c1">// It is time to pack the frame.</span>
<span class="n">frame</span><span class="o">.</span><span class="na">pack</span><span class="o">();</span>
<span class="o">}</span>
<span class="o">});</span>
<span class="n">frame</span><span class="o">.</span><span class="na">addWindowListener</span><span class="o">(</span><span class="k">new</span> <span class="n">WindowAdapter</span><span class="o">()</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">windowOpened</span><span class="o">(</span><span class="n">WindowEvent</span> <span class="n">e</span><span class="o">)</span> <span class="o">{</span>
<span class="c1">// The canvas is ready to load the base document</span>
<span class="c1">// now, from the AWT thread.</span>
<span class="n">canvas</span><span class="o">.</span><span class="na">setURI</span><span class="o">(</span><span class="s">&quot;doc.svg&quot;</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">});</span>
<span class="n">frame</span><span class="o">.</span><span class="na">getContentPane</span><span class="o">().</span><span class="na">add</span><span class="o">(</span><span class="n">canvas</span><span class="o">);</span>
<span class="n">frame</span><span class="o">.</span><span class="na">setSize</span><span class="o">(</span><span class="mi">800</span><span class="o">,</span> <span class="mi">600</span><span class="o">);</span>
<span class="n">frame</span><span class="o">.</span><span class="na">show</span><span class="o">();</span>
<span class="o">}</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">registerListeners</span><span class="o">()</span> <span class="o">{</span>
<span class="c1">// Gets an element from the loaded document.</span>
<span class="n">Element</span> <span class="n">elt</span> <span class="o">=</span> <span class="n">document</span><span class="o">.</span><span class="na">getElementById</span><span class="o">(</span><span class="s">&quot;elt-id&quot;</span><span class="o">);</span>
<span class="n">EventTarget</span> <span class="n">t</span> <span class="o">=</span> <span class="o">(</span><span class="n">EventTarget</span><span class="o">)</span><span class="n">elt</span><span class="o">;</span>
<span class="c1">// Adds a &#39;onload&#39; listener</span>
<span class="n">t</span><span class="o">.</span><span class="na">addEventListener</span><span class="o">(</span><span class="s">&quot;SVGLoad&quot;</span><span class="o">,</span> <span class="k">new</span> <span class="n">OnLoadAction</span><span class="o">(),</span> <span class="kc">false</span><span class="o">);</span>
<span class="c1">// Adds a &#39;onclick&#39; listener</span>
<span class="n">t</span><span class="o">.</span><span class="na">addEventListener</span><span class="o">(</span><span class="s">&quot;click&quot;</span><span class="o">,</span> <span class="k">new</span> <span class="n">OnClickAction</span><span class="o">(),</span> <span class="kc">false</span><span class="o">);</span>
<span class="o">}</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">OnLoadAction</span> <span class="kd">implements</span> <span class="n">EventListener</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">handleEvent</span><span class="o">(</span><span class="n">Event</span> <span class="n">evt</span><span class="o">)</span> <span class="o">{</span>
<span class="c1">// Perform some actions here...</span>
<span class="c1">// ...for example start an animation loop:</span>
<span class="n">window</span><span class="o">.</span><span class="na">setInterval</span><span class="o">(</span><span class="k">new</span> <span class="n">Animation</span><span class="o">(),</span> <span class="mi">50</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">OnClickAction</span> <span class="kd">implements</span> <span class="n">EventListener</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">handleEvent</span><span class="o">(</span><span class="n">Event</span> <span class="n">evt</span><span class="o">)</span> <span class="o">{</span>
<span class="c1">// Perform some actions here...</span>
<span class="c1">// ...for example schedule an action for later:</span>
<span class="n">window</span><span class="o">.</span><span class="na">setTimeout</span><span class="o">(</span><span class="k">new</span> <span class="n">DelayedTask</span><span class="o">(),</span> <span class="mi">500</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Animation</span> <span class="kd">implements</span> <span class="n">Runnable</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">run</span><span class="o">()</span> <span class="o">{</span>
<span class="c1">// Insert animation code here...</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">DelayedTask</span> <span class="kd">implements</span> <span class="n">Runnable</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">run</span><span class="o">()</span> <span class="o">{</span>
<span class="c1">// Perform some actions here...</span>
<span class="c1">// ...for example displays an alert dialog:</span>
<span class="n">window</span><span class="o">.</span><span class="na">alert</span><span class="o">(</span><span class="s">&quot;Delayed Action invoked!&quot;</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">}</span>
<span class="o">}</span>
</pre></div>
<h2 id="Threads">Writing thread-safe code</h2>
<p>The DOM listeners registered on the SVG document are called from the canvas update thread. To avoid race conditions, do not manipulate the DOM tree from another thread.</p>
<p>The way to switch from an external thread to the canvas update thread is to use the following code:</p>
<div class="highlight"><pre><span></span><span class="c1">// Returns immediately</span>
<span class="n">canvas</span><span class="o">.</span><span class="na">getUpdateManager</span><span class="o">().</span><span class="na">getUpdateRunnableQueue</span><span class="o">().</span>
<span class="n">invokeLater</span><span class="o">(</span><span class="k">new</span> <span class="n">Runnable</span><span class="o">()</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">run</span><span class="o">()</span> <span class="o">{</span>
<span class="c1">// Insert some actions on the DOM here</span>
<span class="o">}</span>
<span class="o">});</span>
<span class="nl">or:</span>
<span class="c1">// Waits until the Runnable is invoked</span>
<span class="n">canvas</span><span class="o">.</span><span class="na">getUpdateManager</span><span class="o">().</span><span class="na">getUpdateRunnableQueue</span><span class="o">().</span>
<span class="n">invokeAndWait</span><span class="o">(</span><span class="k">new</span> <span class="n">Runnable</span><span class="o">()</span> <span class="o">{</span>
<span class="kd">public</span> <span class="kt">void</span> <span class="nf">run</span><span class="o">()</span> <span class="o">{</span>
<span class="c1">// Insert some actions on the DOM here</span>
<span class="o">}</span>
<span class="o">});</span>
</pre></div>
<p>Like with event listeners, when a <a href="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Runnable.html">Runnable</a> is invoked from the update thread, the graphics are updated.
It is very dangerous to call <code>invokeAndWait</code> from the Swing event thread. This is the only thread that can be used to interact with Swing components. In some cases DOM calls may need to query the canvas for information (such as actual Swing component size, etc). If this happens you will get a thread deadlock. You should only make invokeAndWait calls from “third party” threads.</p>
<h1 id="SVGDOM">Using the SVG DOM</h1>
<p>Batik provides a fairly complete implementation of the SVG DOM. The SVG DOM provides all the functionality most applications require. In particular, the DOM implements DOM Events, including mutation and UI Events. As an example, DOM events allow you to get notified when the cursor moves over elements of interest:</p>
<div class="highlight"><pre><span></span><span class="c1">// Element of Interest.</span>
<span class="n">Element</span> <span class="n">theElem</span> <span class="o">=</span> <span class="o">...;</span>
<span class="o">((</span><span class="n">EventTarget</span><span class="o">)</span> <span class="n">theElem</span><span class="o">).</span><span class="na">addEventListener</span><span class="o">(</span><span class="s">&quot;mouseover&quot;</span><span class="o">,</span> <span class="n">mouseOverListener</span><span class="o">,</span> <span class="kc">true</span><span class="o">);</span>
</pre></div>
<p>where <code>mouseOverListener</code> implements the <a href="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/events/EventListener.html">org.w3c.dom.events.EventListener</a> interface. This interface consists of the method:</p>
<div class="highlight"><pre><span></span><span class="kt">void</span> <span class="nf">handleEvent</span><span class="o">(</span><span class="n">Event</span> <span class="n">evt</span><span class="o">);</span>
</pre></div>
<p>This is called whenever the event occurs with the element it is registered on. It is worth reviewing the DOM Events specification as there are many useful features to this interface that are not immediately obvious.</p>
<p>It is also worth looking at the DOM interfaces defined by the SVG specification as they provide a large number of useful methods, in particular those of <a href="../../javadoc/org/w3c/dom/svg/SVGLocatable.html">SVGLocatable</a>:</p>
<div class="highlight"><pre><span></span><span class="c1">// Returns Bounding box of SVG Element.</span>
<span class="kd">public</span> <span class="n">SVGRect</span> <span class="nf">getBBox</span><span class="o">();</span>
<span class="c1">// Returns the transformation matrix to the screen.</span>
<span class="kd">public</span> <span class="n">SVGMatrix</span> <span class="nf">getScreenCTM</span><span class="o">();</span>
<span class="c1">// Returns the transformation matrix to the given element.</span>
<span class="kd">public</span> <span class="n">SVGMatrix</span> <span class="nf">getTransformToElement</span><span class="o">(</span><span class="n">SVGElement</span> <span class="n">element</span><span class="o">)</span>
<span class="kd">throws</span> <span class="n">SVGException</span><span class="o">;</span>
</pre></div>
<p>In particular, <code>getScreenCTM</code> is very useful for taking the <code>clientX</code> and <code>clientY</code> attributes of the DOM <a href="http://java.sun.com/j2se/1.5.0/docs/api/org/w3c/dom/events/UIEvent.html">UIEvent</a> and mapping them to the coordinate system of an element in the SVG document:</p>
<div class="highlight"><pre><span></span><span class="n">SVGMatrix</span> <span class="n">mat</span> <span class="o">=</span> <span class="n">elem</span><span class="o">.</span><span class="na">getScreenCTM</span><span class="o">();</span>
<span class="n">SVGMatrix</span> <span class="n">imat</span> <span class="o">=</span> <span class="n">mat</span><span class="o">.</span><span class="na">inverse</span><span class="o">();</span>
<span class="n">SVGPoint</span> <span class="n">cPt</span> <span class="o">=</span> <span class="n">document</span><span class="o">.</span><span class="na">getRootElement</span><span class="o">().</span><span class="na">createSVGPoint</span><span class="o">();</span>
<span class="n">cPt</span><span class="o">.</span><span class="na">setX</span><span class="o">(</span><span class="n">uiEvt</span><span class="o">.</span><span class="na">getClientX</span><span class="o">());</span>
<span class="n">cPt</span><span class="o">.</span><span class="na">setY</span><span class="o">(</span><span class="n">uiEvt</span><span class="o">.</span><span class="na">getClientY</span><span class="o">());</span>
<span class="n">cPt</span> <span class="o">=</span> <span class="n">cPt</span><span class="o">.</span><span class="na">matrixTransform</span><span class="o">(</span><span class="n">imat</span><span class="o">);</span>
</pre></div>
<h1 id="javaInDocument">Referencing Java code from a document</h1>
<p>Batik implements the Java bindings for SVG, and thus allows Java code to be referenced from <code>script</code> elements. This feature is available to any application of Batik that uses the bridge module (for example the Swing component and the transcoders).</p>
<p>In order to use this extension, the <code>type</code> attribute of a <code>script</code> element must be set to <code>application/java-archive</code>. In addition, the <code>xlink:href</code> attribute must be the URI of a jar file that contains the code to run.</p>
<p>The manifest of this jar file must contains an entry of the form:</p>
<div class="highlight"><pre><span></span>SVG-Handler-Class: classname
</pre></div>
<p>where <em>classname</em> must be the name of a class that implements the <a href="../../javadoc/org/w3c/dom/svg/EventListenerInitializer.html">org.w3c.dom.svg.EventListenerInitializer</a> interface. Just before the document <code>SVGLoad</code> event is fired, an instance of this class is created, and this instance has its <code>initializeEventListeners</code> method invoked. Note that there is no way to specify Java handlers in event attributes on SVG elements, so having the <code>initializeEventListeners</code> call <code>addEventListener</code> on a node is the only way to attach a Java listener from within the document.</p>
<p>The class specified by <code>SVG-Handler-Class</code> can be contained directly in the jar file, but it is also possible for it to be contained in a jar file added to the classpath using the <code>Class-Path</code> entry of the manifest.</p>
<div class="clear"></div>
<div id="footer">
<div class="copyright">
<div style="float:left; padding: 7px;">
<a title="Apache Software Foundation" href="http://www.apache.org"><img id="asf-feather-logo" alt="Apache Software Foundation" src="/images/asf_logo_url.png" width="200" /></a>
</div>
<p>
Copyright &copy; 2016 The Apache Software Foundation, Licensed under
the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
<br />
Apache, Apache XML Graphics, Apache FOP, Apache Batik, the Apache feather logo, and the
Apache XML Graphics logos are trademarks of <a href="http://www.apache.org">The Apache
Software Foundation</a>. All other marks mentioned may be trademarks or registered
trademarks of their respective owners.
<br />
</p>
</div>
</div>
</body>
</html>