mirrors
/
fop
mirror of https://github.com/apache/fop.git
Watch 1
Star 0
Fork 0
Code Issues 0 Releases 48 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1848 Commits
70 Branches
Tree: 807819bf42
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '807819bf42'
${ noResults }
fop/src/documentation/content/design/alt.design/properties/AbstractPropertyValue.html

AbstractPropertyValue.html 16KB
Raw Blame History

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">

  2. <!-- Created by htmlize-0.67 in css mode. -->

  3. <html>

  4.   <head>

  5.     <title>AbstractPropertyValue.java</title>

  6.     <style type="text/css">

  7.     <!--

  8.       body {

  9.         color: #000000;

  10.         background-color: #faf0e6;

  11.       } /* default */

  12.       .jde-java-font-lock-package {

  13.         color: #0000cd;

  14.         background-color: #faf0e6;

  15.       } /* jde-java-font-lock-package-face */

  16.       .jde-java-font-lock-constant {

  17.         color: #5f9ea0;

  18.         background-color: #faf0e6;

  19.       } /* jde-java-font-lock-constant-face */

  20.       .keyword {

  21.         color: #8b0000;

  22.         background-color: #faf0e6;

  23.       } /* font-lock-keyword-face */

  24.       .jde-java-font-lock-doc-tag {

  25.         color: #008b00;

  26.         background-color: #faf0e6;

  27.       } /* jde-java-font-lock-doc-tag-face */

  28.       .jde-java-font-lock-number {

  29.         color: #bc8f8f;

  30.         background-color: #faf0e6;

  31.       } /* jde-java-font-lock-number-face */

  32.       .jde-java-font-lock-italic {

  33.         background-color: #faf0e6;

  34.         font-style: italic;

  35.       } /* jde-java-font-lock-italic-face */

  36.       .string {

  37.         color: #008b00;

  38.         background-color: #faf0e6;

  39.       } /* font-lock-string-face */

  40.       .variable-name {

  41.         color: #8b008b;

  42.         background-color: #faf0e6;

  43.       } /* font-lock-variable-name-face */

  44.       .jde-java-font-lock-modifier {

  45.         color: #da70d6;

  46.         background-color: #faf0e6;

  47.       } /* jde-java-font-lock-modifier-face */

  48.       .type {

  49.         color: #4682b4;

  50.         background-color: #faf0e6;

  51.       } /* font-lock-type-face */

  52.       .comment {

  53.         color: #00008b;

  54.         background-color: #faf0e6;

  55.       } /* font-lock-comment-face */

  56.       .function-name {

  57.         color: #8b2323;

  58.         background-color: #faf0e6;

  59.       } /* font-lock-function-name-face */

  60.       a {

  61.         color: inherit;

  62.         background-color: inherit;

  63.         font: inherit;

  64.         text-decoration: inherit;

  65.       }

  66.       a:hover {

  67.         text-decoration: underline;

  68.       }

  69.     -->

  70.     </style>

  71.   </head>

  72.   <body>

  73.     <pre>

  74. <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">datatypes</span>;

  75. 

  76. <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">PropertyConsts</span>;

  77. <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">PropNames</span>;

  78. <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="jde-java-font-lock-number">*</span>;

  79. <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>;

  80. <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>;

  81. <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">PropertyValue</span>;

  82. 

  83. <span class="comment">/*

  84.  * AbstractPropertyValue.java

  85.  * $Id$

  86.  *

  87.  * Copyright (C) 2001 The Apache Software Foundation. All rights reserved.

  88.  * For details on use and redistribution please refer to the

  89.  * LICENSE file included with these sources.

  90.  * @author &lt;a href=&quot;mailto:pbwest@powerup.com.au&quot;&gt;Peter B. West&lt;/a&gt;

  91.  * @version $Revision$ $Name$

  92.  */</span>

  93. <span class="comment">/**

  94.  * Base abstract class for all property value types.

  95.  */</span>

  96. 

  97. <span class="jde-java-font-lock-modifier">public</span> <span class="jde-java-font-lock-modifier">abstract</span> <span class="keyword">class</span> <span class="function-name" id="AbstractPropertyValueClass">AbstractPropertyValue</span>

  98.     <span class="keyword">implements</span> <span class="type">PropertyValue</span>, <span class="type">Cloneable</span>

  99. {

  100.     

  101.     <span class="comment">/**

  102.      * An integer index to the type of property of which this is a value.

  103.      */</span>

  104.     <span class="jde-java-font-lock-modifier">protected</span> <span class="type">int</span> <span class="variable-name" id="property">property</span>;

  105.     

  106.     <span class="comment">/**

  107.      * An integer property type.

  108.      */</span>

  109.     <span class="jde-java-font-lock-modifier">public</span> <span class="jde-java-font-lock-modifier">final</span> <span class="type">int</span> <span class="variable-name" id="type">type</span>;

  110. 

  111.     <span class="comment">/**

  112.      * The PropertyConsts singleton.

  113.      */</span>

  114.     <span class="jde-java-font-lock-modifier">public</span> <span class="jde-java-font-lock-modifier">final</span> <span class="type">PropertyConsts</span> <span class="variable-name" id="propertyConsts">propertyConsts</span>;

  115.     

  116.     <span class="comment">/**

  117.      * </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="index">index</span><span class="comment"> index of the property in the property arrays.

  118.      * </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">type</span><span class="comment"> of this value

  119.      */</span>

  120.     <span class="jde-java-font-lock-modifier">public</span> <span class="function-name" id="AbstractPropertyValue">AbstractPropertyValue</span>(<span class="type">int</span> <span class="variable-name">index</span>, <span class="type">int</span> <span class="variable-name">type</span>)

  121.         <span class="keyword">throws</span> <span class="type">PropertyException</span>

  122.      {

  123.         <span class="keyword">if</span> (index &lt; <span class="jde-java-font-lock-number">1</span> || index &gt; PropNames.<span class="jde-java-font-lock-constant" id="LAST_PROPERTY_INDEX">LAST_PROPERTY_INDEX</span>)

  124.             <span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">PropertyException</span>(&quot;<span class="string">Invalid property index: </span>&quot; + index);

  125.         <span class="keyword">if</span> (type &lt; <span class="jde-java-font-lock-number">0</span> || type &gt; PropertyValue.<span class="jde-java-font-lock-constant" id="LAST_PROPERTY_TYPE">LAST_PROPERTY_TYPE</span>)

  126.             <span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">PropertyException</span>(&quot;<span class="string">Invalid property type: </span>&quot; + type);

  127.         property = index;

  128.         <span class="keyword">this</span>.type = type;

  129.         propertyConsts = PropertyConsts.getPropertyConsts();

  130.     }

  131. 

  132.     <span class="comment">/**

  133.      * </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="propertyName">propertyName</span><span class="comment"> a &lt;tt&gt;String&lt;/tt&gt; containing the property name.

  134.      */</span>

  135.     <span class="jde-java-font-lock-modifier">public</span> <span class="function-name">AbstractPropertyValue</span>(<span class="type">String</span> <span class="variable-name">propertyName</span>, <span class="type">int</span> <span class="variable-name">type</span>)

  136.         <span class="keyword">throws</span> <span class="type">PropertyException</span>

  137.     {

  138.         propertyConsts = PropertyConsts.getPropertyConsts();

  139.         property = PropNames.getPropertyIndex(propertyName);

  140.         <span class="keyword">if</span> (property &lt; <span class="jde-java-font-lock-number">1</span> || property &gt; PropNames.<span class="jde-java-font-lock-constant">LAST_PROPERTY_INDEX</span>)

  141.             <span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">PropertyException</span>(&quot;<span class="string">Invalid property index: </span>&quot; + property);

  142.         <span class="keyword">if</span> (type &lt; <span class="jde-java-font-lock-number">0</span> || type &gt; PropertyValue.<span class="jde-java-font-lock-constant">LAST_PROPERTY_TYPE</span>)

  143.             <span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">PropertyException</span>(&quot;<span class="string">Invalid property type: </span>&quot; + type);

  144.         <span class="keyword">this</span>.type = type;

  145.     }

  146. 

  147.     <span class="comment">/**

  148.      * </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> &lt;tt&gt;int&lt;/tt&gt; property index.

  149.      */</span>

  150.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">int</span> <span class="function-name" id="getProperty">getProperty</span>() {

  151.         <span class="keyword">return</span> property;

  152.     }

  153. 

  154.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">void</span> <span class="function-name" id="setProperty">setProperty</span>(<span class="type">int</span> <span class="variable-name">index</span>) <span class="keyword">throws</span> <span class="type">PropertyException</span> {

  155.         <span class="keyword">if</span> (index &lt; <span class="jde-java-font-lock-number">0</span> || index &gt; PropNames.<span class="jde-java-font-lock-constant">LAST_PROPERTY_INDEX</span>)

  156.             <span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">PropertyException</span>(&quot;<span class="string">Invalid property index: </span>&quot; + index);

  157.         property = index;

  158.     }

  159. 

  160.     <span class="comment">/**

  161.      * </span><span class="jde-java-font-lock-doc-tag">@return</span><span class="comment"> type field of the &lt;tt&gt;PropertyValue&lt;/tt&gt;.

  162.      */</span>

  163.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">int</span> <span class="function-name" id="getType">getType</span>() {

  164.         <span class="keyword">return</span> type;

  165.     }

  166. 

  167.     <span class="comment">/**

  168.      * In some circumstances, the property against which a type is to be

  169.      * validated may not be the same as the property against which this

  170.      * &lt;i&gt;</span><span class="jde-java-font-lock-italic">AbstractPropertyValue</span><span class="comment">&lt;/i&gt; is defined.

  171.      * A specific property argument is then required.

  172.      * </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name" id="testProperty">testProperty</span><span class="comment"> &lt;tt&gt;int&lt;/tt&gt; property index of the property

  173.      * for which the type is to be validated.

  174.      * </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">type</span><span class="comment"> &lt;tt&gt;int&lt;/tt&gt; bitmap of data types to check for

  175.      * validity against this property.

  176.      */</span>

  177.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">void</span> <span class="function-name" id="validate">validate</span>(<span class="type">int</span> <span class="variable-name">testProperty</span>, <span class="type">int</span> <span class="variable-name">type</span>)

  178.         <span class="keyword">throws</span> <span class="type">PropertyException</span>

  179.     {

  180.         <span class="comment">// N.B. PROPERTY_SPECIFIC inheritance may require more specialized

  181. </span>        <span class="comment">// checks.  Only line-height comes into this category.

  182. </span>

  183.         <span class="comment">// N.B. The first commented-out condition means that I cannot validate

  184. </span>        <span class="comment">// unless the property is NOT inherited.

  185. </span>        <span class="comment">// I can't remember why I put this

  186. </span>        <span class="comment">// condition in here.  Removing it.  pbw 2002/02/18

  187. </span>        <span class="comment">//if (propertyConsts.inherited.get(testProperty) == Property.NO

  188. </span>        <span class="comment">//&amp;&amp; (propertyConsts.getDataTypes(testProperty) &amp; type) == 0) {

  189. </span>

  190.             <span class="keyword">if</span> ((propertyConsts.getDataTypes(testProperty) &amp; type) == <span class="jde-java-font-lock-number">0</span>) {

  191.             <span class="type">String</span> <span class="variable-name" id="pname">pname</span> = PropNames.getPropertyName(testProperty);

  192.             <span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">PropertyException</span>

  193.                     (&quot;<span class="string">Datatype(s) </span>&quot; +

  194.                      Property.listDataTypes(type) +

  195.                      &quot;<span class="string"> not defined on </span>&quot; + pname);

  196.         }

  197.     }

  198. 

  199.     <span class="comment">/**

  200.      * </span><span class="jde-java-font-lock-doc-tag">@param</span><span class="comment"> </span><span class="variable-name">type</span><span class="comment"> &lt;tt&gt;int&lt;/tt&gt; bitmap of data types to check for

  201.      * validity against this property.

  202.      */</span>

  203.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">void</span> <span class="function-name">validate</span>(<span class="type">int</span> <span class="variable-name">type</span>) <span class="keyword">throws</span> <span class="type">PropertyException</span> {

  204.         <span class="comment">// N.B. PROPERTY_SPECIFIC inheritance may require more specialized

  205. </span>        <span class="comment">// checks.  Only line-height comes into this category.

  206. </span>        validate(property, type);

  207.     }

  208. 

  209.     <span class="jde-java-font-lock-modifier">public</span> <span class="jde-java-font-lock-modifier">static</span> <span class="type">String</span> <span class="function-name" id="typeString">typeString</span>(<span class="type">int</span> <span class="variable-name">type</span>) {

  210.         <span class="keyword">if</span> (type &lt; <span class="jde-java-font-lock-number">0</span> || type &gt;PropertyValue.<span class="jde-java-font-lock-constant">LAST_PROPERTY_TYPE</span>)

  211.             <span class="keyword">return</span> &quot;<span class="string">Property type out of range</span>&quot;;

  212.         <span class="keyword">return</span> PropertyValue.propertyTypes.get(type);

  213.     }

  214. 

  215.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">String</span> <span class="function-name" id="toString">toString</span>() {

  216.         <span class="keyword">try</span> {

  217.             <span class="keyword">return</span> &quot;<span class="string">Property: </span>&quot; + PropNames.getPropertyName(property)

  218.                     + &quot;<span class="string"> Index: </span>&quot; + property + &quot;<span class="string"> Type: </span>&quot; +

  219.                     typeString(type);

  220.         } <span class="keyword">catch</span> (<span class="type">PropertyException</span> <span class="variable-name" id="e">e</span>) {

  221.             <span class="keyword">throw</span> <span class="keyword">new</span> <span class="type">RuntimeException</span>(e.getMessage());

  222.         }

  223.     }

  224. 

  225.     <span class="jde-java-font-lock-modifier">public</span> <span class="type">Object</span> <span class="function-name" id="clone">clone</span>() <span class="keyword">throws</span> <span class="type">CloneNotSupportedException</span> {

  226.         <span class="keyword">return</span> <span class="keyword">super</span>.clone();

  227.     }

  228. }

  229. </pre>

  230.   </body>

  231. </html>