zcy
/
maxGraph
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
maxGraph/java/docs/com/mxgraph/util/mxImageBundle.html

370 lines
12 KiB
HTML
Raw Normal View History

Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<!-- NewPage -->
<html lang="en">
<head>
3.1.1.1 release
2014-11-10 09:02:21 +00:00
<!-- Generated by javadoc (version 1.7.0_51) on Mon Nov 10 04:00:04 EST 2014 -->
<title>mxImageBundle (mxGraph 3.1.1.1 API Specification)</title>
<meta name="date" content="2014-11-10">
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
if (location.href.indexOf('is-external=true') == -1) {
3.1.1.1 release
2014-11-10 09:02:21 +00:00
parent.document.title="mxImageBundle (mxGraph 3.1.1.1 API Specification)";
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
}
2.5.1.0 release
2014-04-01 11:30:48 +00:00
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!-- ========= START OF TOP NAVBAR ======= -->
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/mxImageBundle.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
3.1.1.1 release
2014-11-10 09:02:21 +00:00
<div class="aboutLanguage"><em><p><b>mxGraph 3.1.1.1</b></p></em></div>
2.5.1.0 release
2014-04-01 11:30:48 +00:00
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/mxgraph/util/mxImage.html" title="class in com.mxgraph.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/mxgraph/util/mxLightweightLabel.html" title="class in com.mxgraph.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/mxgraph/util/mxImageBundle.html" target="_top">Frames</a></li>
<li><a href="mxImageBundle.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
if(window==top) {
2.5.1.0 release
2014-04-01 11:30:48 +00:00
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
}
//-->
2.5.1.0 release
2014-04-01 11:30:48 +00:00
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<div class="header">
<div class="subTitle">com.mxgraph.util</div>
<h2 title="Class mxImageBundle" class="title">Class mxImageBundle</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
3.1.1.1 release
2014-11-10 09:02:21 +00:00
<li>java.lang.Object</li>
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<li>
<ul class="inheritance">
<li>com.mxgraph.util.mxImageBundle</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">mxImageBundle</span>
3.1.1.1 release
2014-11-10 09:02:21 +00:00
extends java.lang.Object</pre>
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<div class="block">Maps from keys to base64 encoded images or file locations. All values must
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
be URLs or use the format data:image/format followed by a comma and the base64
encoded image data, eg. "data:image/gif,XYZ", where XYZ is the base64 encoded
image data.
To add a new image bundle to an existing graph, the following code is used:
<code>
mxImageBundle bundle = new mxImageBundle();
bundle.PutImage("myImage", "data:image/gif,R0lGODlhEAAQAMIGAAAAAICAAICAgP" +
"//AOzp2O3r2////////yH+FUNyZWF0ZWQgd2l0aCBUaGUgR0lNUAAh+QQBCgAHACwAAAAA" +
"EAAQAAADTXi63AowynnAMDfjPUDlnAAJhmeBFxAEloliKltWmiYCQvfVr6lBPB1ggxN1hi" +
"laSSASFQpIV5HJBDyHpqK2ejVRm2AAgZCdmCGO9CIBADs=");
graph.addImageBundle(bundle);
</code>
The image can then be referenced in any cell style using image=myImage.
If you are using mxOutline, you should use the same image bundles in the
graph that renders the outline.
To convert a given BufferedImage to a base64 encoded String, the following
code can be used:
<code>
ByteArrayOutputStream bos = new ByteArrayOutputStream();
ImageIO.write(image, "png", bos);
System.out.println("base64=" + mxBase64.encodeToString(
bos.toByteArray(), false));
</code>
The value is decoded in mxUtils.loadImage. The keys for images are resolved
and the short format above is converted to a data URI in
2.5.1.0 release
2014-04-01 11:30:48 +00:00
mxGraph.postProcessCellStyle.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!-- =========== FIELD SUMMARY =========== -->
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
3.1.1.1 release
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>protected java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td>
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/util/mxImageBundle.html#images">images</a></strong></code>
<div class="block">Maps from keys to images.</div>
</td>
</tr>
</table>
</li>
</ul>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../com/mxgraph/util/mxImageBundle.html#mxImageBundle()">mxImageBundle</a></strong>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!-- ========== METHOD SUMMARY =========== -->
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
3.1.1.1 release
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../com/mxgraph/util/mxImageBundle.html#getImage(java.lang.String)">getImage</a></strong>(java.lang.String&nbsp;key)</code>
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<div class="block">Returns the value for the given key.</div>
</td>
</tr>
<tr class="rowColor">
3.1.1.1 release
2014-11-10 09:02:21 +00:00
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.String&gt;</code></td>
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/util/mxImageBundle.html#getImages()">getImages</a></strong>()</code>
<div class="block">Returns the images.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
3.1.1.1 release
2014-11-10 09:02:21 +00:00
<td class="colLast"><code><strong><a href="../../../com/mxgraph/util/mxImageBundle.html#putImage(java.lang.String, java.lang.String)">putImage</a></strong>(java.lang.String&nbsp;key,
java.lang.String&nbsp;value)</code>
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<div class="block">Adds the specified entry to the map.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
3.1.1.1 release
2014-11-10 09:02:21 +00:00
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
2.5.1.0 release
2014-04-01 11:30:48 +00:00
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!-- ============ FIELD DETAIL =========== -->
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="images">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>images</h4>
3.1.1.1 release
2014-11-10 09:02:21 +00:00
<pre>protected&nbsp;java.util.Map&lt;java.lang.String,java.lang.String&gt; images</pre>
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<div class="block">Maps from keys to images.</div>
</li>
</ul>
</li>
</ul>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!-- ========= CONSTRUCTOR DETAIL ======== -->
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="mxImageBundle()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>mxImageBundle</h4>
<pre>public&nbsp;mxImageBundle()</pre>
</li>
</ul>
</li>
</ul>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!-- ============ METHOD DETAIL ========== -->
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getImages()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getImages</h4>
3.1.1.1 release
2014-11-10 09:02:21 +00:00
<pre>public&nbsp;java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;getImages()</pre>
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<div class="block">Returns the images.</div>
</li>
</ul>
<a name="putImage(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>putImage</h4>
3.1.1.1 release
2014-11-10 09:02:21 +00:00
<pre>public&nbsp;void&nbsp;putImage(java.lang.String&nbsp;key,
java.lang.String&nbsp;value)</pre>
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<div class="block">Adds the specified entry to the map.</div>
</li>
</ul>
<a name="getImage(java.lang.String)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getImage</h4>
3.1.1.1 release
2014-11-10 09:02:21 +00:00
<pre>public&nbsp;java.lang.String&nbsp;getImage(java.lang.String&nbsp;key)</pre>
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<div class="block">Returns the value for the given key.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/mxImageBundle.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
3.1.1.1 release
2014-11-10 09:02:21 +00:00
<div class="aboutLanguage"><em><p><b>mxGraph 3.1.1.1</b></p></em></div>
2.5.1.0 release
2014-04-01 11:30:48 +00:00
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/mxgraph/util/mxImage.html" title="class in com.mxgraph.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/mxgraph/util/mxLightweightLabel.html" title="class in com.mxgraph.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/mxgraph/util/mxImageBundle.html" target="_top">Frames</a></li>
<li><a href="mxImageBundle.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
if(window==top) {
2.5.1.0 release
2014-04-01 11:30:48 +00:00
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
}
//-->
2.5.1.0 release
2014-04-01 11:30:48 +00:00
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
Initial version, 1.10.0.5 release
2012-05-21 20:32:26 +00:00
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2.5.1.0 release
2014-04-01 11:30:48 +00:00
<p class="legalCopy"><small><font size=1>Copyright (c) 2010 <a href="http://www.mxgraph.com/"
target="_blank">Gaudenz Alder, David Benson</a>. All rights reserved.</font></small></p>
</body>
</html>