maxGraph/java/docs/com/mxgraph/util/png/mxPngImageEncoder.html

375 lines
14 KiB
HTML
Raw Normal View History

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">
2014-04-01 11:30:48 +00:00
<!-- NewPage -->
<html lang="en">
<head>
2018-07-06 13:52:46 +00:00
<!-- Generated by javadoc (1.8.0_171) on Fri Jul 06 13:50:11 UTC 2018 -->
<title>mxPngImageEncoder (mxGraph 3.9.8 API Specification)</title>
<meta name="date" content="2018-07-06">
2014-04-01 11:30:48 +00:00
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
2016-06-02 09:57:18 +00:00
<script type="text/javascript" src="../../../../script.js"></script>
2014-04-01 11:30:48 +00:00
</head>
<body>
<script type="text/javascript"><!--
2016-06-02 09:57:18 +00:00
try {
if (location.href.indexOf('is-external=true') == -1) {
2018-07-06 13:52:46 +00:00
parent.document.title="mxPngImageEncoder (mxGraph 3.9.8 API Specification)";
2016-06-02 09:57:18 +00:00
}
}
catch(err) {
2012-05-21 20:32:26 +00:00
}
2014-04-01 11:30:48 +00:00
//-->
2016-06-02 09:57:18 +00:00
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
2014-04-01 11:30:48 +00:00
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
2012-05-21 20:32:26 +00:00
<!-- ========= START OF TOP NAVBAR ======= -->
2016-06-02 09:57:18 +00:00
<div class="topNav"><a name="navbar.top">
2014-04-01 11:30:48 +00:00
<!-- -->
2016-06-02 09:57:18 +00:00
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
2014-04-01 11:30:48 +00:00
<!-- -->
</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/mxPngImageEncoder.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>
2018-07-06 13:52:46 +00:00
<div class="aboutLanguage"><p><b>mxGraph 3.9.8</b></p></div>
2014-04-01 11:30:48 +00:00
</div>
<div class="subNav">
<ul class="navList">
2016-06-02 09:57:18 +00:00
<li><a href="../../../../com/mxgraph/util/png/mxPngEncodeParam.RGB.html" title="class in com.mxgraph.util.png"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/mxgraph/util/png/mxPngSuggestedPaletteEntry.html" title="class in com.mxgraph.util.png"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
2014-04-01 11:30:48 +00:00
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/mxgraph/util/png/mxPngImageEncoder.html" target="_top">Frames</a></li>
2016-06-02 09:57:18 +00:00
<li><a href="mxPngImageEncoder.html" target="_top">No&nbsp;Frames</a></li>
2014-04-01 11:30:48 +00:00
</ul>
<ul class="navList" id="allclasses_navbar_top">
2016-06-02 09:57:18 +00:00
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
2014-04-01 11:30:48 +00:00
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
2012-05-21 20:32:26 +00:00
if(window==top) {
2014-04-01 11:30:48 +00:00
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
2012-05-21 20:32:26 +00:00
}
//-->
2014-04-01 11:30:48 +00:00
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
2016-06-02 09:57:18 +00:00
<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>
2014-04-01 11:30:48 +00:00
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
2016-06-02 09:57:18 +00:00
<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>
2014-04-01 11:30:48 +00:00
</ul>
</div>
2016-06-02 09:57:18 +00:00
<a name="skip.navbar.top">
2014-04-01 11:30:48 +00:00
<!-- -->
</a></div>
2012-05-21 20:32:26 +00:00
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
2014-04-01 11:30:48 +00:00
<div class="header">
<div class="subTitle">com.mxgraph.util.png</div>
<h2 title="Class mxPngImageEncoder" class="title">Class mxPngImageEncoder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
2017-11-24 16:16:54 +00:00
<li>java.lang.Object</li>
2014-04-01 11:30:48 +00:00
<li>
<ul class="inheritance">
<li>com.mxgraph.util.png.mxPngImageEncoder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
2016-06-02 09:57:18 +00:00
<pre>public class <span class="typeNameLabel">mxPngImageEncoder</span>
2017-11-24 16:16:54 +00:00
extends java.lang.Object</pre>
2014-04-01 11:30:48 +00:00
<div class="block">An ImageEncoder for the PNG file format.</div>
2016-06-02 09:57:18 +00:00
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>EA4</dd>
</dl>
2014-04-01 11:30:48 +00:00
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
2012-05-21 20:32:26 +00:00
<!-- =========== FIELD SUMMARY =========== -->
2014-04-01 11:30:48 +00:00
<ul class="blockList">
2016-06-02 09:57:18 +00:00
<li class="blockList"><a name="field.summary">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<h3>Field Summary</h3>
2016-06-02 09:57:18 +00:00
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
2014-04-01 11:30:48 +00:00
<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">
2017-11-24 16:16:54 +00:00
<td class="colFirst"><code>protected java.io.OutputStream</code></td>
2016-06-02 09:57:18 +00:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/mxgraph/util/png/mxPngImageEncoder.html#output">output</a></span></code>
2014-04-01 11:30:48 +00:00
<div class="block">The OutputStream associcted with this ImageEncoder.</div>
</td>
</tr>
</table>
</li>
</ul>
2012-05-21 20:32:26 +00:00
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
2014-04-01 11:30:48 +00:00
<ul class="blockList">
2016-06-02 09:57:18 +00:00
<li class="blockList"><a name="constructor.summary">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<h3>Constructor Summary</h3>
2016-06-02 09:57:18 +00:00
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
2014-04-01 11:30:48 +00:00
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
2017-11-24 16:16:54 +00:00
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/mxgraph/util/png/mxPngImageEncoder.html#mxPngImageEncoder-java.io.OutputStream-com.mxgraph.util.png.mxPngEncodeParam-">mxPngImageEncoder</a></span>(java.io.OutputStream&nbsp;output,
2014-04-01 11:30:48 +00:00
<a href="../../../../com/mxgraph/util/png/mxPngEncodeParam.html" title="class in com.mxgraph.util.png">mxPngEncodeParam</a>&nbsp;param)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
2012-05-21 20:32:26 +00:00
<!-- ========== METHOD SUMMARY =========== -->
2014-04-01 11:30:48 +00:00
<ul class="blockList">
2016-06-02 09:57:18 +00:00
<li class="blockList"><a name="method.summary">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<h3>Method Summary</h3>
2016-06-02 09:57:18 +00:00
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
2014-04-01 11:30:48 +00:00
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
2016-06-02 09:57:18 +00:00
<tr id="i0" class="altColor">
2014-04-01 11:30:48 +00:00
<td class="colFirst"><code>void</code></td>
2017-11-24 16:16:54 +00:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/mxgraph/util/png/mxPngImageEncoder.html#encode-java.awt.image.RenderedImage-">encode</a></span>(java.awt.image.RenderedImage&nbsp;im)</code>
2014-04-01 11:30:48 +00:00
<div class="block">This method encodes a <code>RenderedImage</code> into PNG.</div>
</td>
</tr>
2016-06-02 09:57:18 +00:00
<tr id="i1" class="rowColor">
2017-11-24 16:16:54 +00:00
<td class="colFirst"><code>java.io.OutputStream</code></td>
2016-06-02 09:57:18 +00:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/mxgraph/util/png/mxPngImageEncoder.html#getOutputStream--">getOutputStream</a></span>()</code>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the OutputStream associated with this ImageEncoder.</div>
</td>
</tr>
2016-06-02 09:57:18 +00:00
<tr id="i2" class="altColor">
2014-04-01 11:30:48 +00:00
<td class="colFirst"><code><a href="../../../../com/mxgraph/util/png/mxPngEncodeParam.html" title="class in com.mxgraph.util.png">mxPngEncodeParam</a></code></td>
2016-06-02 09:57:18 +00:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/mxgraph/util/png/mxPngImageEncoder.html#getParam--">getParam</a></span>()</code>&nbsp;</td>
2014-04-01 11:30:48 +00:00
</tr>
2016-06-02 09:57:18 +00:00
<tr id="i3" class="rowColor">
2014-04-01 11:30:48 +00:00
<td class="colFirst"><code>void</code></td>
2016-06-02 09:57:18 +00:00
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/mxgraph/util/png/mxPngImageEncoder.html#setParam-com.mxgraph.util.png.mxPngEncodeParam-">setParam</a></span>(<a href="../../../../com/mxgraph/util/png/mxPngEncodeParam.html" title="class in com.mxgraph.util.png">mxPngEncodeParam</a>&nbsp;param)</code>&nbsp;</td>
2014-04-01 11:30:48 +00:00
</tr>
</table>
<ul class="blockList">
2016-06-02 09:57:18 +00:00
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
2017-11-24 16:16:54 +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>
2014-04-01 11:30:48 +00:00
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
2012-05-21 20:32:26 +00:00
<!-- ============ FIELD DETAIL =========== -->
2014-04-01 11:30:48 +00:00
<ul class="blockList">
2016-06-02 09:57:18 +00:00
<li class="blockList"><a name="field.detail">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="output">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>output</h4>
2017-11-24 16:16:54 +00:00
<pre>protected&nbsp;java.io.OutputStream output</pre>
2014-04-01 11:30:48 +00:00
<div class="block">The OutputStream associcted with this ImageEncoder.</div>
</li>
</ul>
</li>
</ul>
2012-05-21 20:32:26 +00:00
<!-- ========= CONSTRUCTOR DETAIL ======== -->
2014-04-01 11:30:48 +00:00
<ul class="blockList">
2016-06-02 09:57:18 +00:00
<li class="blockList"><a name="constructor.detail">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<h3>Constructor Detail</h3>
2016-06-02 09:57:18 +00:00
<a name="mxPngImageEncoder-java.io.OutputStream-com.mxgraph.util.png.mxPngEncodeParam-">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>mxPngImageEncoder</h4>
2017-11-24 16:16:54 +00:00
<pre>public&nbsp;mxPngImageEncoder(java.io.OutputStream&nbsp;output,
2016-06-02 09:57:18 +00:00
<a href="../../../../com/mxgraph/util/png/mxPngEncodeParam.html" title="class in com.mxgraph.util.png">mxPngEncodeParam</a>&nbsp;param)</pre>
2014-04-01 11:30:48 +00:00
</li>
</ul>
</li>
</ul>
2012-05-21 20:32:26 +00:00
<!-- ============ METHOD DETAIL ========== -->
2014-04-01 11:30:48 +00:00
<ul class="blockList">
2016-06-02 09:57:18 +00:00
<li class="blockList"><a name="method.detail">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<h3>Method Detail</h3>
2016-06-02 09:57:18 +00:00
<a name="getParam--">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getParam</h4>
<pre>public&nbsp;<a href="../../../../com/mxgraph/util/png/mxPngEncodeParam.html" title="class in com.mxgraph.util.png">mxPngEncodeParam</a>&nbsp;getParam()</pre>
</li>
</ul>
2016-06-02 09:57:18 +00:00
<a name="setParam-com.mxgraph.util.png.mxPngEncodeParam-">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setParam</h4>
<pre>public&nbsp;void&nbsp;setParam(<a href="../../../../com/mxgraph/util/png/mxPngEncodeParam.html" title="class in com.mxgraph.util.png">mxPngEncodeParam</a>&nbsp;param)</pre>
</li>
</ul>
2016-06-02 09:57:18 +00:00
<a name="getOutputStream--">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getOutputStream</h4>
2017-11-24 16:16:54 +00:00
<pre>public&nbsp;java.io.OutputStream&nbsp;getOutputStream()</pre>
2014-04-01 11:30:48 +00:00
<div class="block">Returns the OutputStream associated with this ImageEncoder.</div>
</li>
</ul>
2016-06-02 09:57:18 +00:00
<a name="encode-java.awt.image.RenderedImage-">
2014-04-01 11:30:48 +00:00
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>encode</h4>
2017-11-24 16:16:54 +00:00
<pre>public&nbsp;void&nbsp;encode(java.awt.image.RenderedImage&nbsp;im)
throws java.io.IOException</pre>
2014-04-01 11:30:48 +00:00
<div class="block">This method encodes a <code>RenderedImage</code> into PNG.
2012-05-21 20:32:26 +00:00
The stream into which the PNG is dumped is not closed at
the end of the operation, this should be done if needed
2014-04-01 11:30:48 +00:00
by the caller of this method.</div>
2016-06-02 09:57:18 +00:00
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
2017-11-24 16:16:54 +00:00
<dd><code>java.io.IOException</code></dd>
2016-06-02 09:57:18 +00:00
</dl>
2014-04-01 11:30:48 +00:00
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
2012-05-21 20:32:26 +00:00
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
2016-06-02 09:57:18 +00:00
<div class="bottomNav"><a name="navbar.bottom">
2014-04-01 11:30:48 +00:00
<!-- -->
2016-06-02 09:57:18 +00:00
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
2014-04-01 11:30:48 +00:00
<!-- -->
</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/mxPngImageEncoder.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>
2018-07-06 13:52:46 +00:00
<div class="aboutLanguage"><p><b>mxGraph 3.9.8</b></p></div>
2014-04-01 11:30:48 +00:00
</div>
<div class="subNav">
<ul class="navList">
2016-06-02 09:57:18 +00:00
<li><a href="../../../../com/mxgraph/util/png/mxPngEncodeParam.RGB.html" title="class in com.mxgraph.util.png"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/mxgraph/util/png/mxPngSuggestedPaletteEntry.html" title="class in com.mxgraph.util.png"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
2014-04-01 11:30:48 +00:00
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/mxgraph/util/png/mxPngImageEncoder.html" target="_top">Frames</a></li>
2016-06-02 09:57:18 +00:00
<li><a href="mxPngImageEncoder.html" target="_top">No&nbsp;Frames</a></li>
2014-04-01 11:30:48 +00:00
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
2016-06-02 09:57:18 +00:00
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
2014-04-01 11:30:48 +00:00
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
2012-05-21 20:32:26 +00:00
if(window==top) {
2014-04-01 11:30:48 +00:00
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
2012-05-21 20:32:26 +00:00
}
//-->
2014-04-01 11:30:48 +00:00
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
2016-06-02 09:57:18 +00:00
<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>
2014-04-01 11:30:48 +00:00
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
2016-06-02 09:57:18 +00:00
<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>
2014-04-01 11:30:48 +00:00
</ul>
</div>
2016-06-02 09:57:18 +00:00
<a name="skip.navbar.bottom">
2014-04-01 11:30:48 +00:00
<!-- -->
</a></div>
2012-05-21 20:32:26 +00:00
<!-- ======== END OF BOTTOM NAVBAR ======= -->
2017-06-27 11:43:19 +00:00
<p class="legalCopy"><small><font size=1>Copyright (c) 2010-2017 <a href="http://www.jgraph.com/"
target="_blank">Gaudenz Alder, JGraph Ltd</a>. All rights reserved.</font></small></p>
2014-04-01 11:30:48 +00:00
</body>
</html>