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/PropertyValue.html

PropertyValue.html 14KB
Raw Blame History

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198 
  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>PropertyValue.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="jde-java-font-lock-package">expr</span>.<span class="type">PropertyException</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">FONode</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">datastructs</span>.<span class="type">ROStringArray</span>;

  79. 

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

  81.  * PropertyValue.java

  82.  * $Id$

  83.  *

  84.  * Created: Tue Nov 20 22:18:11 2001

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

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

  87.  * LICENSE file included with these sources.

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

  89.  * @version $Revision$ $Name$

  90.  */</span>

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

  92.  * Base interface for all property value types.

  93.  */</span>

  94. 

  95. <span class="jde-java-font-lock-modifier">public</span> <span class="keyword">interface</span> <span class="function-name" id="PropertyValueInterface">PropertyValue</span> {

  96. 

  97.     <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>

  98.                         <span class="jde-java-font-lock-constant" id="NO_TYPE">NO_TYPE</span> = <span class="jde-java-font-lock-number">0</span>

  99.                          ,<span class="jde-java-font-lock-constant" id="ANGLE">ANGLE</span> = <span class="jde-java-font-lock-number">1</span>

  100.                           ,<span class="jde-java-font-lock-constant" id="AUTO">AUTO</span> = <span class="jde-java-font-lock-number">2</span>

  101.                           ,<span class="jde-java-font-lock-constant" id="BOOL">BOOL</span> = <span class="jde-java-font-lock-number">3</span>

  102.                     ,<span class="jde-java-font-lock-constant" id="COLOR_TYPE">COLOR_TYPE</span> = <span class="jde-java-font-lock-number">4</span>

  103.                        ,<span class="jde-java-font-lock-constant" id="COUNTRY">COUNTRY</span> = <span class="jde-java-font-lock-number">5</span>

  104.                           ,<span class="jde-java-font-lock-constant" id="ENUM">ENUM</span> = <span class="jde-java-font-lock-number">6</span>

  105.                    ,<span class="jde-java-font-lock-constant" id="FONT_FAMILY">FONT_FAMILY</span> = <span class="jde-java-font-lock-number">7</span>

  106.                      ,<span class="jde-java-font-lock-constant" id="FREQUENCY">FREQUENCY</span> = <span class="jde-java-font-lock-number">8</span>

  107.         ,<span class="jde-java-font-lock-constant" id="FROM_NEAREST_SPECIFIED">FROM_NEAREST_SPECIFIED</span> = <span class="jde-java-font-lock-number">9</span>

  108.                    ,<span class="jde-java-font-lock-constant" id="FROM_PARENT">FROM_PARENT</span> = <span class="jde-java-font-lock-number">10</span>

  109.                        ,<span class="jde-java-font-lock-constant" id="INHERIT">INHERIT</span> = <span class="jde-java-font-lock-number">11</span>

  110.                ,<span class="jde-java-font-lock-constant" id="INHERITED_VALUE">INHERITED_VALUE</span> = <span class="jde-java-font-lock-number">12</span>

  111.                        ,<span class="jde-java-font-lock-constant" id="INTEGER">INTEGER</span> = <span class="jde-java-font-lock-number">13</span>

  112.                       ,<span class="jde-java-font-lock-constant" id="LANGUAGE">LANGUAGE</span> = <span class="jde-java-font-lock-number">14</span>

  113.                        ,<span class="jde-java-font-lock-constant" id="LITERAL">LITERAL</span> = <span class="jde-java-font-lock-number">15</span>

  114.                 ,<span class="jde-java-font-lock-constant" id="MAPPED_NUMERIC">MAPPED_NUMERIC</span> = <span class="jde-java-font-lock-number">16</span>

  115.                      ,<span class="jde-java-font-lock-constant" id="MIME_TYPE">MIME_TYPE</span> = <span class="jde-java-font-lock-number">17</span>

  116.                         ,<span class="jde-java-font-lock-constant" id="NCNAME">NCNAME</span> = <span class="jde-java-font-lock-number">18</span>

  117.                           ,<span class="jde-java-font-lock-constant" id="NONE">NONE</span> = <span class="jde-java-font-lock-number">19</span>

  118.                        ,<span class="jde-java-font-lock-constant" id="NUMERIC">NUMERIC</span> = <span class="jde-java-font-lock-number">20</span>

  119.                         ,<span class="jde-java-font-lock-constant" id="SCRIPT">SCRIPT</span> = <span class="jde-java-font-lock-number">21</span>

  120.                  ,<span class="jde-java-font-lock-constant" id="SHADOW_EFFECT">SHADOW_EFFECT</span> = <span class="jde-java-font-lock-number">22</span>

  121.                          ,<span class="jde-java-font-lock-constant" id="SLASH">SLASH</span> = <span class="jde-java-font-lock-number">23</span>

  122.               ,<span class="jde-java-font-lock-constant" id="TEXT_DECORATIONS">TEXT_DECORATIONS</span> = <span class="jde-java-font-lock-number">24</span>

  123.                 ,<span class="jde-java-font-lock-constant" id="TEXT_DECORATOR">TEXT_DECORATOR</span> = <span class="jde-java-font-lock-number">25</span>

  124.                           ,<span class="jde-java-font-lock-constant" id="TIME">TIME</span> = <span class="jde-java-font-lock-number">26</span>

  125.                       ,<span class="jde-java-font-lock-constant" id="URI_TYPE">URI_TYPE</span> = <span class="jde-java-font-lock-number">27</span>

  126.                           ,<span class="jde-java-font-lock-constant" id="LIST">LIST</span> = <span class="jde-java-font-lock-number">28</span>

  127. 

  128.             ,<span class="jde-java-font-lock-constant" id="LAST_PROPERTY_TYPE">LAST_PROPERTY_TYPE</span> = <span class="jde-java-font-lock-constant">LIST</span>;

  129. 

  130.     <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">ROStringArray</span> <span class="variable-name" id="propertyTypes">propertyTypes</span> =

  131.         <span class="keyword">new</span> <span class="type">ROStringArray</span>(<span class="keyword">new</span> <span class="type">String</span>[] {

  132.         &quot;<span class="string">NO_TYPE</span>&quot;

  133.         ,&quot;<span class="string">ANGLE</span>&quot;

  134.         ,&quot;<span class="string">AUTO</span>&quot;

  135.         ,&quot;<span class="string">BOOL</span>&quot;

  136.         ,&quot;<span class="string">COLOR_TYPE</span>&quot;

  137.         ,&quot;<span class="string">COUNTRY</span>&quot;

  138.         ,&quot;<span class="string">ENUM</span>&quot;

  139.         ,&quot;<span class="string">FONT_FAMILY</span>&quot;

  140.         ,&quot;<span class="string">FREQUENCY</span>&quot;

  141.         ,&quot;<span class="string">FROM_NEAREST_SPECIFIED</span>&quot;

  142.         ,&quot;<span class="string">FROM_PARENT</span>&quot;

  143.         ,&quot;<span class="string">INHERIT</span>&quot;

  144.         ,&quot;<span class="string">INHERITED_VALUE</span>&quot;

  145.         ,&quot;<span class="string">INTEGER</span>&quot;

  146.         ,&quot;<span class="string">LANGUAGE</span>&quot;

  147.         ,&quot;<span class="string">LITERAL</span>&quot;

  148.         ,&quot;<span class="string">MAPPED_NUMERIC</span>&quot;

  149.         ,&quot;<span class="string">MIME_TYPE</span>&quot;

  150.         ,&quot;<span class="string">NCNAME</span>&quot;

  151.         ,&quot;<span class="string">NONE</span>&quot;

  152.         ,&quot;<span class="string">NUMERIC</span>&quot;

  153.         ,&quot;<span class="string">SCRIPT</span>&quot;

  154.         ,&quot;<span class="string">SHADOW_EFFECT</span>&quot;

  155.         ,&quot;<span class="string">SLASH</span>&quot;

  156.         ,&quot;<span class="string">TEXT_DECORATIONS</span>&quot;

  157.         ,&quot;<span class="string">TEXT_DECORATOR</span>&quot;

  158.         ,&quot;<span class="string">TIME</span>&quot;

  159.         ,&quot;<span class="string">URI_LIST</span>&quot;

  160.         ,&quot;<span class="string">LIST</span>&quot;

  161.     });

  162. 

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

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

  165.      */</span>

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

  167.     <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" id="index">index</span>) <span class="keyword">throws</span> <span class="type">PropertyException</span>;

  168. 

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

  170.      * Get the &lt;tt&gt;int&lt;/tt&gt; type of property value.

  171.      * </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;.

  172.      */</span>

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

  174. 

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

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

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

  178.      * &lt;i&gt;</span><span class="jde-java-font-lock-italic">PropertyValue</span><span class="comment">&lt;/i&gt; is defined.  A specific property argument is

  179.      * then required.

  180.      * </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

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

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

  183.      * validity against this property.

  184.      */</span>

  185.     <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>)

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

  187. 

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

  189.      * </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

  190.      * validity against this property.

  191.      */</span>

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

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

  194. 

  195. }

  196. </pre>

  197.   </body>

  198. </html>