pbwest 2002/12/26 23:34:03
Added: src/documentation/content/design/alt.design/properties
BorderCommonWidth.html
Log:
Code documentation
Revision Changes Path
1.1
xml-fop/src/documentation/content/design/alt.design/properties/BorderCommonWidth.html
Index: BorderCommonWidth.html
===================================================================
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<!-- Created by htmlize-0.67 in css mode. -->
<html>
<head>
<title>BorderCommonWidth.java</title>
<style type="text/css">
<!--
body {
color: #000000;
background-color: #faf0e6;
} /* default */
.variable-name {
color: #8b008b;
background-color: #faf0e6;
} /* font-lock-variable-name-face */
.jde-java-font-lock-package {
color: #0000cd;
background-color: #faf0e6;
} /* jde-java-font-lock-package-face */
.jde-java-font-lock-constant {
color: #5f9ea0;
background-color: #faf0e6;
} /* jde-java-font-lock-constant-face */
.keyword {
color: #8b0000;
background-color: #faf0e6;
} /* font-lock-keyword-face */
.jde-java-font-lock-doc-tag {
color: #008b00;
background-color: #faf0e6;
} /* jde-java-font-lock-doc-tag-face */
.string {
color: #008b00;
background-color: #faf0e6;
} /* font-lock-string-face */
.jde-java-font-lock-number {
color: #bc8f8f;
background-color: #faf0e6;
} /* jde-java-font-lock-number-face */
.type {
color: #4682b4;
background-color: #faf0e6;
} /* font-lock-type-face */
.jde-java-font-lock-modifier {
color: #da70d6;
background-color: #faf0e6;
} /* jde-java-font-lock-modifier-face */
.comment {
color: #00008b;
background-color: #faf0e6;
} /* font-lock-comment-face */
.function-name {
color: #8b2323;
background-color: #faf0e6;
} /* font-lock-function-name-face */
a {
color: inherit;
background-color: inherit;
font: inherit;
text-decoration: inherit;
}
a:hover {
text-decoration: underline;
}
-->
</style>
</head>
<body>
<pre>
<span class="keyword">package</span> <span
class="jde-java-font-lock-package">org</span>.<span
class="jde-java-font-lock-package">apache</span>.<span
class="jde-java-font-lock-package">fop</span>.<span
class="jde-java-font-lock-package">fo</span>.<span
class="jde-java-font-lock-package">properties</span>;
<span class="keyword">import</span> <span
class="jde-java-font-lock-package">org</span>.<span
class="jde-java-font-lock-package">apache</span>.<span
class="jde-java-font-lock-package">fop</span>.<span
class="jde-java-font-lock-package">fo</span>.<span
class="jde-java-font-lock-package">properties</span>.<span
class="type">Property</span>;
<span class="keyword">import</span> <span
class="jde-java-font-lock-package">org</span>.<span
class="jde-java-font-lock-package">apache</span>.<span
class="jde-java-font-lock-package">fop</span>.<span
class="jde-java-font-lock-package">datatypes</span>.<span class="type">Length</span>;
<span class="keyword">import</span> <span
class="jde-java-font-lock-package">org</span>.<span
class="jde-java-font-lock-package">apache</span>.<span
class="jde-java-font-lock-package">fop</span>.<span
class="jde-java-font-lock-package">datatypes</span>.<span class="type">Numeric</span>;
<span class="keyword">import</span> <span
class="jde-java-font-lock-package">org</span>.<span
class="jde-java-font-lock-package">apache</span>.<span
class="jde-java-font-lock-package">fop</span>.<span
class="jde-java-font-lock-package">fo</span>.<span class="type">FONode</span>;
<span class="keyword">import</span> <span
class="jde-java-font-lock-package">org</span>.<span
class="jde-java-font-lock-package">apache</span>.<span
class="jde-java-font-lock-package">fop</span>.<span
class="jde-java-font-lock-package">fo</span>.<span
class="jde-java-font-lock-package">expr</span>.<span
class="type">PropertyException</span>;
<span class="comment">/**
* Pseudo-property class for common border width values occurring in a
* number of classes.
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span
class="keyword">class</span> <span class="function-name"
id="BorderCommonWidthClass">BorderCommonWidth</span> <span
class="keyword">extends</span> <span class="type">Property</span> {
<span class="jde-java-font-lock-modifier">public</span> <span
class="jde-java-font-lock-modifier">static</span> <span
class="jde-java-font-lock-modifier">final</span> <span class="type">int</span> <span
class="variable-name" id="THIN">THIN</span> = <span
class="jde-java-font-lock-number">1</span>;
<span class="jde-java-font-lock-modifier">public</span> <span
class="jde-java-font-lock-modifier">static</span> <span
class="jde-java-font-lock-modifier">final</span> <span class="type">int</span> <span
class="variable-name" id="MEDIUM">MEDIUM</span> = <span
class="jde-java-font-lock-number">2</span>;
<span class="jde-java-font-lock-modifier">public</span> <span
class="jde-java-font-lock-modifier">static</span> <span
class="jde-java-font-lock-modifier">final</span> <span class="type">int</span> <span
class="variable-name" id="THICK">THICK</span> = <span
class="jde-java-font-lock-number">3</span>;
<span class="jde-java-font-lock-modifier">private</span> <span
class="jde-java-font-lock-modifier">static</span> <span
class="jde-java-font-lock-modifier">final</span> <span class="type">String</span>[]
<span class="variable-name" id="rwEnums">rwEnums</span> = {
<span class="jde-java-font-lock-constant" id="null">null</span>
,"<span class="string">thin</span>"
,"<span class="string">medium</span>"
,"<span class="string">thick</span>"
};
<span class="jde-java-font-lock-modifier">private</span> <span
class="jde-java-font-lock-modifier">static</span> <span
class="jde-java-font-lock-modifier">final</span> <span class="type">double</span>[]
<span class="variable-name" id="mappedPoints">mappedPoints</span> = {
<span class="jde-java-font-lock-number">0d</span>
,<span class="jde-java-font-lock-number">0.5d</span>
,<span class="jde-java-font-lock-number">1d</span>
,<span class="jde-java-font-lock-number">2d</span>
};
<span class="comment">// N.B. If these values change, all initial values
expressed in these
</span> <span class="comment">// terms must be manually changed.
</span>
<span class="comment">/**
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span
class="comment"> <tt>int</tt> property index
* </span><span class="jde-java-font-lock-doc-tag">@param</span><span
class="comment"> <tt>int</tt> mappedEnum enumeration value
* </span><span class="jde-java-font-lock-doc-tag">@return</span><span
class="comment"> <tt>Numeric[]</tt> containing the values corresponding
* to the MappedNumeric enumeration constants for border width
*/</span>
<span class="jde-java-font-lock-modifier">public</span> <span
class="type">Numeric</span> <span class="function-name"
id="getMappedLength">getMappedLength</span>(<span class="type">FONode</span> <span
class="variable-name" id="node">node</span>, <span class="type">int</span> <span
class="variable-name">property</span>, <span class="type">int</span> <span
class="variable-name">enum</span>)
<span class="keyword">throws</span> <span class="type">PropertyException</span>
{
<span class="keyword">return</span>
Length.makeLength(property, mappedPoints[enum], Length.<span
class="jde-java-font-lock-constant" id="PT">PT</span>);
}
<span class="jde-java-font-lock-modifier">public</span> <span
class="type">int</span> <span class="function-name"
id="getEnumIndex">getEnumIndex</span>(<span class="type">String</span> <span
class="variable-name" id="enum">enum</span>) <span class="keyword">throws</span> <span
class="type">PropertyException</span> {
<span class="keyword">return</span> enumValueToIndex(enum, rwEnums);
}
<span class="jde-java-font-lock-modifier">public</span> <span
class="type">String</span> <span class="function-name"
id="getEnumText">getEnumText</span>(<span class="type">int</span> <span
class="variable-name" id="index">index</span>) {
<span class="keyword">return</span> rwEnums[index];
}
}
</pre>
</body>
</html>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]