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

610 lines
27 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.3) on Mon Jul 15 10:38:04 UTC 2019 -->
<title>mxPngEncodeParam.Gray (mxGraph 4.0.2 API Specification)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="dc.created" content="2019-07-15">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../jquery/jquery-3.3.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-migrate-3.0.1.js"></script>
<script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="mxPngEncodeParam.Gray (mxGraph 4.0.2 API Specification)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":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";
var pathtoroot = "../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a id="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/mxPngEncodeParam.Gray.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>
<div class="aboutLanguage"><p><b>mxGraph 4.0.2</b></p></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>
<!-- ======== START OF CLASS DATA ======== -->
<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.mxgraph.util.png</a></div>
<h2 title="Class mxPngEncodeParam.Gray" class="title">Class mxPngEncodeParam.Gray</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="mxPngEncodeParam.html" title="class in com.mxgraph.util.png">com.mxgraph.util.png.mxPngEncodeParam</a></li>
<li>
<ul class="inheritance">
<li>com.mxgraph.util.png.mxPngEncodeParam.Gray</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="mxPngEncodeParam.html" title="class in com.mxgraph.util.png">mxPngEncodeParam</a></dd>
</dl>
<hr>
<pre>public static class <span class="typeNameLabel">mxPngEncodeParam.Gray</span>
extends <a href="mxPngEncodeParam.html" title="class in com.mxgraph.util.png">mxPngEncodeParam</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="nested.classes.inherited.from.class.com.mxgraph.util.png.mxPngEncodeParam">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;com.mxgraph.util.png.<a href="mxPngEncodeParam.html" title="class in com.mxgraph.util.png">mxPngEncodeParam</a></h3>
<code><a href="mxPngEncodeParam.Gray.html" title="class in com.mxgraph.util.png">mxPngEncodeParam.Gray</a>, <a href="mxPngEncodeParam.Palette.html" title="class in com.mxgraph.util.png">mxPngEncodeParam.Palette</a>, <a href="mxPngEncodeParam.RGB.html" title="class in com.mxgraph.util.png">mxPngEncodeParam.RGB</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- =========== FIELD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a id="fields.inherited.from.class.com.mxgraph.util.png.mxPngEncodeParam">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;com.mxgraph.util.png.<a href="mxPngEncodeParam.html" title="class in com.mxgraph.util.png">mxPngEncodeParam</a></h3>
<code><a href="mxPngEncodeParam.html#bitDepth">bitDepth</a>, <a href="mxPngEncodeParam.html#bitDepthSet">bitDepthSet</a>, <a href="mxPngEncodeParam.html#INTENT_ABSOLUTE">INTENT_ABSOLUTE</a>, <a href="mxPngEncodeParam.html#INTENT_PERCEPTUAL">INTENT_PERCEPTUAL</a>, <a href="mxPngEncodeParam.html#INTENT_RELATIVE">INTENT_RELATIVE</a>, <a href="mxPngEncodeParam.html#INTENT_SATURATION">INTENT_SATURATION</a>, <a href="mxPngEncodeParam.html#PNG_FILTER_AVERAGE">PNG_FILTER_AVERAGE</a>, <a href="mxPngEncodeParam.html#PNG_FILTER_NONE">PNG_FILTER_NONE</a>, <a href="mxPngEncodeParam.html#PNG_FILTER_PAETH">PNG_FILTER_PAETH</a>, <a href="mxPngEncodeParam.html#PNG_FILTER_SUB">PNG_FILTER_SUB</a>, <a href="mxPngEncodeParam.html#PNG_FILTER_UP">PNG_FILTER_UP</a></code></li>
</ul>
</li>
</ul>
</section>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">Gray</a></span>()</code></th>
<td class="colLast">
<div class="block">Constructs an instance of <code>PNGEncodeParam.Gray</code>.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
<!-- ========== METHOD SUMMARY =========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<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>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBackgroundGray()">getBackgroundGray</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the suggested gray level of the background.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBitShift()">getBitShift</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the desired bit shift for a grayscale image.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransparentGray()">getTransparentGray</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the gray value to be used to denote transparency.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBackgroundSet()">isBackgroundSet</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if a 'bKGD' chunk will be output.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBitDepthSet()">isBitDepthSet</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if the bit depth has been set.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isBitShiftSet()">isBitShiftSet</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns true if the bit shift has been set.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBackgroundGray(int)">setBackgroundGray</a></span>&#8203;(int&nbsp;gray)</code></th>
<td class="colLast">
<div class="block">Sets the suggested gray level of the background.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBitDepth(int)">setBitDepth</a></span>&#8203;(int&nbsp;bitDepth)</code></th>
<td class="colLast">
<div class="block">Sets the desired bit depth for a grayscale image.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setBitShift(int)">setBitShift</a></span>&#8203;(int&nbsp;bitShift)</code></th>
<td class="colLast">
<div class="block">Sets the desired bit shift for a grayscale image.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTransparentGray(int)">setTransparentGray</a></span>&#8203;(int&nbsp;transparentGray)</code></th>
<td class="colLast">
<div class="block">Sets the gray value to be used to denote transparency.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unsetBackground()">unsetBackground</a></span>()</code></th>
<td class="colLast">
<div class="block">Suppresses the 'bKGD' chunk from being output.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#unsetBitShift()">unsetBitShift</a></span>()</code></th>
<td class="colLast">
<div class="block">Suppresses the setting of the bit shift of a grayscale image.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.com.mxgraph.util.png.mxPngEncodeParam">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.mxgraph.util.png.<a href="mxPngEncodeParam.html" title="class in com.mxgraph.util.png">mxPngEncodeParam</a></h3>
<code><a href="mxPngEncodeParam.html#addPrivateChunk(java.lang.String,byte%5B%5D)">addPrivateChunk</a>, <a href="mxPngEncodeParam.html#filterRow(byte%5B%5D,byte%5B%5D,byte%5B%5D%5B%5D,int,int)">filterRow</a>, <a href="mxPngEncodeParam.html#getBitDepth()">getBitDepth</a>, <a href="mxPngEncodeParam.html#getChromaticity()">getChromaticity</a>, <a href="mxPngEncodeParam.html#getCompressedText()">getCompressedText</a>, <a href="mxPngEncodeParam.html#getDefaultEncodeParam(java.awt.image.RenderedImage)">getDefaultEncodeParam</a>, <a href="mxPngEncodeParam.html#getGamma()">getGamma</a>, <a href="mxPngEncodeParam.html#getICCProfileData()">getICCProfileData</a>, <a href="mxPngEncodeParam.html#getInterlacing()">getInterlacing</a>, <a href="mxPngEncodeParam.html#getModificationTime()">getModificationTime</a>, <a href="mxPngEncodeParam.html#getNumPrivateChunks()">getNumPrivateChunks</a>, <a href="mxPngEncodeParam.html#getPaletteHistogram()">getPaletteHistogram</a>, <a href="mxPngEncodeParam.html#getPhysicalDimension()">getPhysicalDimension</a>, <a href="mxPngEncodeParam.html#getPrivateChunkData(int)">getPrivateChunkData</a>, <a href="mxPngEncodeParam.html#getPrivateChunkType(int)">getPrivateChunkType</a>, <a href="mxPngEncodeParam.html#getSignificantBits()">getSignificantBits</a>, <a href="mxPngEncodeParam.html#getSRGBIntent()">getSRGBIntent</a>, <a href="mxPngEncodeParam.html#getText()">getText</a>, <a href="mxPngEncodeParam.html#isChromaticitySet()">isChromaticitySet</a>, <a href="mxPngEncodeParam.html#isCompressedTextSet()">isCompressedTextSet</a>, <a href="mxPngEncodeParam.html#isGammaSet()">isGammaSet</a>, <a href="mxPngEncodeParam.html#isICCProfileDataSet()">isICCProfileDataSet</a>, <a href="mxPngEncodeParam.html#isModificationTimeSet()">isModificationTimeSet</a>, <a href="mxPngEncodeParam.html#isPaletteHistogramSet()">isPaletteHistogramSet</a>, <a href="mxPngEncodeParam.html#isPhysicalDimensionSet()">isPhysicalDimensionSet</a>, <a href="mxPngEncodeParam.html#isSignificantBitsSet()">isSignificantBitsSet</a>, <a href="mxPngEncodeParam.html#isSRGBIntentSet()">isSRGBIntentSet</a>, <a href="mxPngEncodeParam.html#isSuggestedPaletteSet()">isSuggestedPaletteSet</a>, <a href="mxPngEncodeParam.html#isTextSet()">isTextSet</a>, <a href="mxPngEncodeParam.html#isTransparencySet()">isTransparencySet</a>, <a href="mxPngEncodeParam.html#paethPredictor(int,int,int)">paethPredictor</a>, <a href="mxPngEncodeParam.html#removeAllPrivateChunks()">removeAllPrivateChunks</a>, <a href="mxPngEncodeParam.html#removeUnsafeToCopyPrivateChunks()">removeUnsafeToCopyPrivateChunks</a>, <a href="mxPngEncodeParam.html#setChromaticity(float%5B%5D)">setChromaticity</a>, <a href="mxPngEncodeParam.html#setChromaticity(float,float,float,float,float,float,float,float)">setChromaticity</a>, <a href="mxPngEncodeParam.html#setCompressedText(java.lang.String%5B%5D)">setCompressedText</a>, <a href="mxPngEncodeParam.html#setGamma(float)">setGamma</a>, <a href="mxPngEncodeParam.html#setICCProfileData(byte%5B%5D)">setICCProfileData</a>, <a href="mxPngEncodeParam.html#setInterlacing(boolean)">setInterlacing</a>, <a href="mxPngEncodeParam.html#setModificationTime(java.util.Date)">setModificationTime</a>, <a href="mxPngEncodeParam.html#setPaletteHistogram(int%5B%5D)">setPaletteHistogram</a>, <a href="mxPngEncodeParam.html#setPhysicalDimension(int%5B%5D)">setPhysicalDimension</a>, <a href="mxPngEncodeParam.html#setPhysicalDimension(int,int,int)">setPhysicalDimension</a>, <a href="mxPngEncodeParam.html#setSignificantBits(int%5B%5D)">setSignificantBits</a>, <a href="mxPngEncodeParam.html#setSRGBIntent(int)">setSRGBIntent</a>, <a href="mxPngEncodeParam.html#setSuggestedPalette(com.mxgraph.util.png.mxPngSuggestedPaletteEntry%5B%5D)">setSuggestedPalette</a>, <a href="mxPngEncodeParam.html#setText(java.lang.String%5B%5D)">setText</a>, <a href="mxPngEncodeParam.html#unsetBitDepth()">unsetBitDepth</a>, <a href="mxPngEncodeParam.html#unsetChromaticity()">unsetChromaticity</a>, <a href="mxPngEncodeParam.html#unsetCompressedText()">unsetCompressedText</a>, <a href="mxPngEncodeParam.html#unsetGamma()">unsetGamma</a>, <a href="mxPngEncodeParam.html#unsetICCProfileData()">unsetICCProfileData</a>, <a href="mxPngEncodeParam.html#unsetModificationTime()">unsetModificationTime</a>, <a href="mxPngEncodeParam.html#unsetPaletteHistogram()">unsetPaletteHistogram</a>, <a href="mxPngEncodeParam.html#unsetPhysicalDimension()">unsetPhysicalDimension</a>, <a href="mxPngEncodeParam.html#unsetSignificantBits()">unsetSignificantBits</a>, <a href="mxPngEncodeParam.html#unsetSRGBIntent()">unsetSRGBIntent</a>, <a href="mxPngEncodeParam.html#unsetSuggestedPalette()">unsetSuggestedPalette</a>, <a href="mxPngEncodeParam.html#unsetText()">unsetText</a>, <a href="mxPngEncodeParam.html#unsetTransparency()">unsetTransparency</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a id="&lt;init&gt;()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Gray</h4>
<pre>public&nbsp;Gray()</pre>
<div class="block">Constructs an instance of <code>PNGEncodeParam.Gray</code>.</div>
</li>
</ul>
</li>
</ul>
</section>
<!-- ============ METHOD DETAIL ========== -->
<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a id="unsetBackground()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unsetBackground</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;unsetBackground()</pre>
<div class="block">Suppresses the 'bKGD' chunk from being output.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="mxPngEncodeParam.html#unsetBackground()">unsetBackground</a></code>&nbsp;in class&nbsp;<code><a href="mxPngEncodeParam.html" title="class in com.mxgraph.util.png">mxPngEncodeParam</a></code></dd>
</dl>
</li>
</ul>
<a id="isBackgroundSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBackgroundSet</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isBackgroundSet()</pre>
<div class="block">Returns true if a 'bKGD' chunk will be output.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="mxPngEncodeParam.html#isBackgroundSet()">isBackgroundSet</a></code>&nbsp;in class&nbsp;<code><a href="mxPngEncodeParam.html" title="class in com.mxgraph.util.png">mxPngEncodeParam</a></code></dd>
</dl>
</li>
</ul>
<a id="setBitDepth(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBitDepth</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setBitDepth&#8203;(int&nbsp;bitDepth)</pre>
<div class="block">Sets the desired bit depth for a grayscale image. The bit
depth must be one of 1, 2, 4, 8, or 16.
<p> When encoding a source image of a greater bit depth,
pixel values will be clamped to the smaller range after
shifting by the value given by <code>getBitShift()</code>.
When encoding a source image of a smaller bit depth, pixel
values will be shifted and left-filled with zeroes.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="mxPngEncodeParam.html#setBitDepth(int)">setBitDepth</a></code>&nbsp;in class&nbsp;<code><a href="mxPngEncodeParam.html" title="class in com.mxgraph.util.png">mxPngEncodeParam</a></code></dd>
</dl>
</li>
</ul>
<a id="setBackgroundGray(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBackgroundGray</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setBackgroundGray&#8203;(int&nbsp;gray)</pre>
<div class="block">Sets the suggested gray level of the background.
<p> The 'bKGD' chunk will encode this information.</div>
</li>
</ul>
<a id="getBackgroundGray()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBackgroundGray</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getBackgroundGray()</pre>
<div class="block">Returns the suggested gray level of the background.
<p> If the background gray level has not previously been
set, or has been unset, an
<code>IllegalStateException</code> will be thrown.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the background gray level
is not set.</dd>
</dl>
</li>
</ul>
<a id="setTransparentGray(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTransparentGray</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setTransparentGray&#8203;(int&nbsp;transparentGray)</pre>
<div class="block">Sets the gray value to be used to denote transparency.
<p> Setting this attribute will cause the alpha channel
of the input image to be ignored.
<p> The 'tRNS' chunk will encode this information.</div>
</li>
</ul>
<a id="getTransparentGray()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransparentGray</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getTransparentGray()</pre>
<div class="block">Returns the gray value to be used to denote transparency.
<p> If the transparent gray value has not previously been
set, or has been unset, an
<code>IllegalStateException</code> will be thrown.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the transparent gray value
is not set.</dd>
</dl>
</li>
</ul>
<a id="setBitShift(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBitShift</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setBitShift&#8203;(int&nbsp;bitShift)</pre>
<div class="block">Sets the desired bit shift for a grayscale image.
Pixels in the source image will be shifted right by
the given amount prior to being clamped to the maximum
value given by the encoded image's bit depth.</div>
</li>
</ul>
<a id="getBitShift()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getBitShift</h4>
<pre class="methodSignature">public&nbsp;int&nbsp;getBitShift()</pre>
<div class="block">Returns the desired bit shift for a grayscale image.
<p> If the bit shift has not previously been set, or has been
unset, an <code>IllegalStateException</code> will be thrown.</div>
<dl>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if the bit shift is not set.</dd>
</dl>
</li>
</ul>
<a id="unsetBitShift()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>unsetBitShift</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;unsetBitShift()</pre>
<div class="block">Suppresses the setting of the bit shift of a grayscale image.
Pixels in the source image will not be shifted prior to encoding.</div>
</li>
</ul>
<a id="isBitShiftSet()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBitShiftSet</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isBitShiftSet()</pre>
<div class="block">Returns true if the bit shift has been set.</div>
</li>
</ul>
<a id="isBitDepthSet()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isBitDepthSet</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;isBitDepthSet()</pre>
<div class="block">Returns true if the bit depth has been set.</div>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>
<!-- ========= END OF CLASS DATA ========= -->
<footer role="contentinfo">
<nav role="navigation">
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a id="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/mxPngEncodeParam.Gray.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>
<div class="aboutLanguage"><p><b>mxGraph 4.0.2</b></p></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&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>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</nav>
<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>
</footer>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink