git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@195917 13f79535-47bb-0310-9956-ffa450edef68pull/30/head
@@ -4,12 +4,6 @@ | |||
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | |||
<title>PropertyConsts Description</title> | |||
<link type="text/css" href="../../../page.css" rel="stylesheet"> | |||
<script type="text/javascript"> | |||
<!-- | |||
topdoc=window.top.document; | |||
topwin=window.top; | |||
// --> | |||
</script> | |||
</head> | |||
<body marginheight="0" marginwidth="0" topmargin="0" leftmargin="0" | |||
text="#000000" bgcolor="#FFFFFF"> | |||
@@ -28,17 +22,17 @@ | |||
<h3>Introduction</h3> | |||
<p> | |||
<a href="javascript:topwin.displayCode( | |||
<a href="javascript:window.top.displayCode( | |||
'PropertyConsts.html#PropertyConstsClass' | |||
)">This class</a>, and the singleton object which is <a | |||
href="javascript:topwin.displayCode( | |||
href="javascript:window.top.displayCode( | |||
'PropertyConsts.html#pconsts' )">generated by the static | |||
initializer</a>, is essentially a repository of | |||
<property> class instances and the static data from | |||
those classes of <span | |||
class="codefrag">org.apache.fop.fo.property</span>. | |||
The heart of this class is the method <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'PropertyConsts.html#setupProperty' )"><span class="codefrag" | |||
>setupProperty</span ></a>. Whenever access to the data or | |||
methods of a property class is required, this method in the | |||
@@ -64,15 +58,15 @@ | |||
<p> | |||
The class name is generated and stored in the <a | |||
href="javascript:topwin.displayCode( | |||
href="javascript:window.top.displayCode( | |||
'PropertyConsts.html#classNames' )"><span class="codefrag" | |||
>classNames</span ></a> array; a class instance is generated | |||
from the name and stored in the <a | |||
href="javascript:topwin.displayCode( | |||
href="javascript:window.top.displayCode( | |||
'PropertyConsts.html#classes' )"><span class="codefrag" | |||
>classes</span ></a> array; and an instance of the class is | |||
generated from the class object and stored in the <a | |||
href="javascript:topwin.displayCode( | |||
href="javascript:window.top.displayCode( | |||
'PropertyConsts.html#properties' )"><span class="codefrag" | |||
>properties</span ></a> array. | |||
</p> |
@@ -4,12 +4,6 @@ | |||
<META http-equiv= "Content-Type" content= "text/html; charset=ISO-8859-1" > | |||
<title>Property classes overview</title> | |||
<link type="text/css" href="../../../page.css" rel="stylesheet"> | |||
<script type="text/javascript"> | |||
<!-- | |||
topdoc=window.top.document; | |||
topwin=window.top; | |||
// --> | |||
</script> | |||
</head> | |||
<body marginheight= "0" marginwidth= "0" topmargin= "0" leftmargin= "0" text= "#000000" bgcolor= "#FFFFFF" > | |||
<div class= "content" > | |||
@@ -44,21 +38,21 @@ | |||
"N10019" ></a> <h4>org.apache.fop.fo</h4> | |||
<dl> | |||
<dt> | |||
<a href = "javascript:topwin.displayCode( | |||
<a href = "javascript:window.top.displayCode( | |||
'PropNames.html#PropNamesClass' | |||
)" ><em>PropNames</em></a> | |||
</dt> | |||
<dd> | |||
This class maintains an array of <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'PropNames.html#propertyNames' )" >property names</a>, | |||
synchronized to a complete set of property name <a href = | |||
"javascript:topwin.displayCode( 'PropNames.html#NO_PROPERTY' | |||
"javascript:window.top.displayCode( 'PropNames.html#NO_PROPERTY' | |||
)" >constants</a> for indexing property-based arrays. It | |||
includes methods to <a href = | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'PropNames.html#getPropertyName' )" >convert an index to a | |||
name</a> and to <a href = "javascript:topwin.displayCode( | |||
name</a> and to <a href = "javascript:window.top.displayCode( | |||
'PropNames.html#getPropertyIndex' )" >convert a property | |||
name to an index</a>. | |||
</dd> | |||
@@ -68,13 +62,13 @@ | |||
<dd> | |||
A singleton instance of <span class= "codefrag" | |||
>PropertyConsts</span> is created by the static initializer | |||
of the <a href = "javascript:topwin.displayCode( | |||
of the <a href = "javascript:window.top.displayCode( | |||
'PropertyConsts.html#pconsts' )" >pconsts</a> field. | |||
Working from the property indices defined in PropNames, the | |||
methods in this class collect and supply the values of | |||
fields defined in property objects into arrays.<br> The | |||
heart of this class in the method <a href = | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'PropertyConsts.html#setupProperty' )" >setupProperty</a>, | |||
which constructs the property name from the index, | |||
instantiates a singleton of the appropriate class, and | |||
@@ -82,7 +76,7 @@ | |||
the arrays of field values. | |||
</dd> | |||
<dt> | |||
<a href = "javascript:topwin.displayCode( | |||
<a href = "javascript:window.top.displayCode( | |||
'PropertySets.html#PropertySetsClass' )" ><em>PropertySets</em></a> | |||
</dt> | |||
<dd> | |||
@@ -90,16 +84,16 @@ | |||
>ROBitSet</span>s representing many of the sets of | |||
properties defined in <em>Section 7</em> of the | |||
specification. Note that the <a | |||
href="javascript:topwin.displayCode( | |||
href="javascript:window.top.displayCode( | |||
'PropertySets.html#borderProps' )"><em>Border</em></a>, <a | |||
href="javascript:topwin.displayCode( | |||
href="javascript:window.top.displayCode( | |||
'PropertySets.html#paddingProps' )"><em>Padding</em></a> and | |||
<a href="javascript:topwin.displayCode( | |||
<a href="javascript:window.top.displayCode( | |||
'PropertySets.html#backgroundProps' | |||
)"><em>Background</em></a> sets are defined separately. | |||
</dd> | |||
<dt> | |||
<a href = "javascript:topwin.displayCode( | |||
<a href = "javascript:window.top.displayCode( | |||
'../FOPropertySets.html#FOPropertySetsClass' )" | |||
><em>FOPropertySets</em></a> | |||
</dt> | |||
@@ -111,15 +105,15 @@ | |||
during processing of the subtrees. | |||
</dd> | |||
<dt> | |||
<a href = "javascript:topwin.displayCode( | |||
<a href = "javascript:window.top.displayCode( | |||
'ShorthandPropSets.html#ShorthandPropSetsClass' )" | |||
><em>ShorthandPropSets</em></a> | |||
</dt> | |||
<dd> | |||
This class contains arrays of <a href = | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'ShorthandPropSets.html#shorthands' )" >shorthand property | |||
indices</a> and <a href = "javascript:topwin.displayCode( | |||
indices</a> and <a href = "javascript:window.top.displayCode( | |||
'ShorthandPropSets.html#compounds' )" >compound property | |||
indices</a>, and <span class= "codefrag" >ROBitSet</span>s | |||
representing the expansion sets of these shorthands and | |||
@@ -127,7 +121,7 @@ | |||
properties are also included. | |||
</dd> | |||
<dt> | |||
<a href = "javascript:topwin.displayCode( | |||
<a href = "javascript:window.top.displayCode( | |||
'FOAttributes.html#FOAttributesClass' )" | |||
><em>FOAttributes</em></a> | |||
</dt> | |||
@@ -135,12 +129,12 @@ | |||
This class manages the attribute set that is associated with | |||
a SAX <span class= "codefrag" >startElement</span> event. | |||
<em>fo:</em> namespace attributes are entered into a <a href | |||
= "javascript:topwin.displayCode( | |||
= "javascript:window.top.displayCode( | |||
'FOAttributes.html#foAttrMap' )"><span class= "codefrag" | |||
>HashMap</span></a>, indexed by the <em>fo:</em> property | |||
index. As other namespaces are encountered, the values are | |||
entered into namespace-specific <a href = | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'FOAttributes.html#nSpaceAttrMaps' )"><span class= | |||
"codefrag" >HashMap</span>s</a>, indexed by the <em>local | |||
name</em> of the attribute. | |||
@@ -150,7 +144,7 @@ | |||
<h4>org.apache.fop.fo.properties</h4> | |||
<dl> | |||
<dt> | |||
<a href="javascript:topwin.displayCode( | |||
<a href="javascript:window.top.displayCode( | |||
'Property.html#PropertyClass' )" ><em>Property</em></a> | |||
</dt> | |||
<dd> | |||
@@ -206,18 +200,18 @@ | |||
<h4>org.apache.fop.fo.expr</h4> | |||
<dl> | |||
<dt> | |||
<a href = "javascript:topwin.displayCode( | |||
<a href = "javascript:window.top.displayCode( | |||
'PropertyTokenizer.html#PropertyTokenizerClass' )" | |||
><em>PropertyTokenizer</em></a> | |||
</dt> | |||
<dd> | |||
The tokenizer for the property expression parser. Defines a | |||
set of <a href = "javascript:topwin.displayCode( | |||
set of <a href = "javascript:window.top.displayCode( | |||
'PropertyTokenizer.html#EOF' )" >token constants</a> and | |||
returns these with associated token values. | |||
</dd> | |||
<dt> | |||
<a href = "javascript:topwin.displayCode( | |||
<a href = "javascript:window.top.displayCode( | |||
'PropertyParser.html#PropertyParserClass' )" | |||
><em>PropertyParser</em></a> | |||
</dt> | |||
@@ -254,7 +248,7 @@ | |||
<h4>org.apache.fop.datatypes</h4> | |||
<dl> | |||
<dt> | |||
<a href = "javascript:topwin.displayCode( | |||
<a href = "javascript:window.top.displayCode( | |||
'PropertyValue.html#PropertyValueInterface' )" | |||
><em>PropertyValue</em></a> | |||
</dt> | |||
@@ -263,13 +257,13 @@ | |||
>PropertyValue</span> classes must implement. In addition | |||
to a few methods, <span class= "codefrag" | |||
>PropertyValue</span> defines the set of <a href = | |||
"javascript:topwin.displayCode( 'PropertyValue.html#NO_TYPE' | |||
"javascript:window.top.displayCode( 'PropertyValue.html#NO_TYPE' | |||
)" >constants</a> which the <span class= "codefrag" | |||
>getType()</span> method may return; i.e. the valid set of | |||
<span class= "codefrag" >PropertyValue</span> types. | |||
</dd> | |||
<dt> | |||
<a href = "javascript:topwin.displayCode( | |||
<a href = "javascript:window.top.displayCode( | |||
'AbstractPropertyValue.html#AbstractPropertyValueClass' )" | |||
><em>AbstractPropertyValue</em></a> | |||
</dt> | |||
@@ -280,7 +274,7 @@ | |||
>AbstractPropertyValue</span>. | |||
</dd> | |||
<dt> | |||
<a href = "javascript:topwin.displayCode( | |||
<a href = "javascript:window.top.displayCode( | |||
'PropertyValueList.html#PropertyValueListClass' )" | |||
><em>PropertyValueList</em></a> | |||
</dt> |
@@ -4,12 +4,6 @@ | |||
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | |||
<title>Enumerated Data Values</title> | |||
<link type="text/css" href="../../../page.css" rel="stylesheet"> | |||
<script type="text/javascript"> | |||
<!-- | |||
topdoc=window.top.document; | |||
topwin=window.top; | |||
// --> | |||
</script> | |||
</head> | |||
<body marginheight="0" marginwidth="0" topmargin="0" leftmargin="0" text="#000000" bgcolor="#FFFFFF"> | |||
<div class="content"> | |||
@@ -61,24 +55,24 @@ | |||
<h4>Array representation</h4> | |||
<p> | |||
<a href= "javascript:topwin.displayCode( | |||
<a href= "javascript:window.top.displayCode( | |||
'Direction.html#DirectionClass' )" ><span | |||
class="codefrag">org.apache.fop.fo.properties.Direction</span></a> | |||
is an example of a class which supports an enumerated value | |||
with a small set of tokens. The <a href= | |||
"javascript:topwin.displayCode( 'Direction.html#dataTypes' )" | |||
"javascript:window.top.displayCode( 'Direction.html#dataTypes' )" | |||
><span class="codefrag">dataTypes</span></a> field contains | |||
the <a href= "javascript:topwin.displayCode( | |||
the <a href= "javascript:window.top.displayCode( | |||
'Property.html#NOTYPE' )" ><span class="codefrag">ENUM</span> | |||
data type constant, defined in <span | |||
class="codefrag">Property</span></a>. The enumeration integer | |||
constants are defined as <span class="codefrag">public static | |||
final int</span> values, <a href= | |||
"javascript:topwin.displayCode( 'Direction.html#LTR') "><span | |||
"javascript:window.top.displayCode( 'Direction.html#LTR') "><span | |||
class="codefrag' )" >LTR</span> and <span | |||
class="codefrag">RTL</span></a>. Associating enumeration | |||
tokens with these integer constants occurs in the array <a | |||
href= "javascript:topwin.displayCode( 'Direction.html#rwEnums' | |||
href= "javascript:window.top.displayCode( 'Direction.html#rwEnums' | |||
)" ><span class="codefrag">String[] rwEnums</span></a>, which | |||
is initialized with the token strings. By convention, zero is | |||
never used to represent a valid enumeration constant, anywhere | |||
@@ -89,11 +83,11 @@ | |||
<p> | |||
The publicly accessible mapping from enumeration token to | |||
enumeration constant is achieved through the method <a href= | |||
"javascript:topwin.displayCode( 'Direction.html#getEnumIndex' | |||
"javascript:window.top.displayCode( 'Direction.html#getEnumIndex' | |||
)" ><span class="codefrag">int | |||
getEnumIndex(String)</span></a>. The corresponding mapping | |||
from enumeration constant to enumeration token is achieved | |||
through the method <a href= "javascript:topwin.displayCode( | |||
through the method <a href= "javascript:window.top.displayCode( | |||
'Direction.html#getEnumText' )" ><span class="codefrag">String | |||
getEnumText(int)</span></a>. | |||
</p> | |||
@@ -101,30 +95,30 @@ | |||
<h4>HashMap representation</h4> | |||
<p> | |||
<a href= "javascript:topwin.displayCode( | |||
<a href= "javascript:window.top.displayCode( | |||
'RenderingIntent.html#RenderingIntentClass' )" ><span | |||
class="codefrag" | |||
>org.apache.fop.fo.properties.RenderingIntent</span ></a> is | |||
an example of a class which supports an enumerated value with | |||
a larger set of tokens. The <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'RenderingIntent.html#dataTypes' )" ><span | |||
class="codefrag">dataTypes</span></a> field contains the <a | |||
href= "javascript:topwin.displayCode( 'Property.html#NOTYPE' | |||
href= "javascript:window.top.displayCode( 'Property.html#NOTYPE' | |||
)" ><span class="codefrag">ENUM</span> data type constant, | |||
defined in <span class="codefrag">Property</span></a>. | |||
Enumeration integer constants are defined as <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'RenderingIntent.html#PERCEPTUAL' )" ><span | |||
class="codefrag">public static final int</span></a> values. | |||
Zero is never used to represent a valid enumeration constant. | |||
The enumeration tokens are stored in the array <a href= | |||
"javascript:topwin.displayCode( 'RenderingIntent.html#rwEnums' | |||
"javascript:window.top.displayCode( 'RenderingIntent.html#rwEnums' | |||
)" ><span class="codefrag">String[] rwEnums</span></a>, which | |||
is initialized with the token strings. Association of | |||
enumeration tokens with the integer constants occurs in the | |||
<span class="codefrag">HashMap</span> <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'RenderingIntent.html#rwEnumHash"><span class="codefrag' )" > | |||
rwEnumHash</span></a>, which is initialized from the token | |||
array in a <span class="codefrag">static {}</span> | |||
@@ -135,12 +129,12 @@ | |||
<p> | |||
The publicly accessible mapping from enumeration token to | |||
enumeration constant is achieved through the method <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'RenderingIntent.html#getEnumIndex' )" ><span | |||
class="codefrag">int getEnumIndex(String)</span></a>. The | |||
corresponding mapping from enumeration constant to enumeration | |||
token is achieved through the method <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'RenderingIntent.html#getEnumText' )" ><span | |||
class="codefrag">String getEnumText(int)</span></a>. | |||
</p> | |||
@@ -153,29 +147,29 @@ | |||
that value and its associated access methods may be factored | |||
out to a new class, which each of the properties then extends. | |||
An example of such a common super-class is <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'BorderCommonStyle.html#BorderCommonStyleClass' )" ><span | |||
class="codefrag">BorderCommonStyle</span></a>. Like a | |||
property with a normal HashMap representation of an enumerated | |||
value, BorderCommonStyle defines <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'BorderCommonStyle.html#HIDDEN' )" ><span | |||
class="codefrag">public static final int</span></a> | |||
enumeration integer constants. Similarly, the enumeration | |||
tokens are stored in the array <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'BorderCommonStyle.html#rwEnums' )" ><span | |||
class="codefrag">String[] rwEnums</span></a>, and the | |||
association of enumeration tokens with the integer constants | |||
occurs in the <span class="codefrag">HashMap</span> <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'BorderCommonStyle.html#rwEnumHash' )" ><span | |||
class="codefrag"> rwEnumHash</span></a>, initialized in a | |||
<span class="codefrag">static {}</span> initializer. The | |||
mapping methods <a href= "javascript:topwin.displayCode( | |||
mapping methods <a href= "javascript:window.top.displayCode( | |||
'BorderCommonStyle.html#getEnumIndex' )" ><span | |||
class="codefrag">int getEnumIndex(String)</span></a> and <a | |||
href= "javascript:topwin.displayCode( | |||
href= "javascript:window.top.displayCode( | |||
'BorderCommonStyle.html#getEnumText' )" ><span | |||
class="codefrag">String getEnumText(int)</span></a> are also | |||
present. | |||
@@ -185,7 +179,7 @@ | |||
constants described in the discussion of <a | |||
href="simple-properties.html">simple properties</a>. These | |||
values are defined in the individual sub-classes of this | |||
class, e.g. <a href= "javascript:topwin.displayCode( | |||
class, e.g. <a href= "javascript:window.top.displayCode( | |||
'BorderLeftStyle.html#BorderLeftStyleClass' )" ><span | |||
class="codefrag">BorderLeftStyle</span></a>. None of the | |||
above fields or methods occur, and <span | |||
@@ -205,7 +199,7 @@ | |||
indicated <span class="codefrag">Numeric</span> value. | |||
</p> | |||
<p> | |||
An example is the <a href= "javascript:topwin.displayCode( | |||
An example is the <a href= "javascript:window.top.displayCode( | |||
'BorderCommonWidth.html#BorderCommonWidthClass' )" ><span | |||
class="codefrag">BorderCommonWidth</span></a> property. This, | |||
like the example of <a href="#common-enum-values"><span | |||
@@ -213,47 +207,47 @@ | |||
represents common enumerated values which have been factored | |||
out to form a super-class for particular properties. <span | |||
class="codefrag">BorderCommonWidth</span>, therefore, also | |||
defines <a href= "javascript:topwin.displayCode( | |||
defines <a href= "javascript:window.top.displayCode( | |||
'BorderCommonWidth.html#THIN' )" ><span | |||
class="codefrag">enumeration constant values</span></a> and an | |||
array of tokens. In this case, there is no <span | |||
class="codefrag">HashMap</span>, because of the limited number | |||
of tokens, but the mapping methods <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'BorderCommonWidth.html#getEnumIndex' )" ><span | |||
class="codefrag">int getEnumIndex(String)</span></a> and <a | |||
href= "javascript:topwin.displayCode( | |||
href= "javascript:window.top.displayCode( | |||
'BorderCommonWidth.html#getEnumText' )" ><span | |||
class="codefrag">String getEnumText(int)</span></a> are | |||
present. | |||
</p> | |||
<p> | |||
The added element in this property is the array <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'BorderCommonWidth.html#mappedPoints' )" ><span | |||
class="codefrag">double[] mappedPoints</span></a>. The | |||
entries in this array must by maintained in syncronization | |||
with the <a href= "javascript:topwin.displayCode( | |||
with the <a href= "javascript:window.top.displayCode( | |||
'BorderCommonWidth.html#rwEnums' )" ><span | |||
class="codefrag">String[] rwEnums</span></a> array of tokens | |||
and the set of <a href= "javascript:topwin.displayCode( | |||
and the set of <a href= "javascript:window.top.displayCode( | |||
'BorderCommonWidth.html#THIN' )" >enumeration constants</a>. | |||
The mapping from token to Numeric value is achieved by the <a | |||
href= "javascript:topwin.displayCode( | |||
href= "javascript:window.top.displayCode( | |||
'BorderCommonWidth.html#getMappedLength' )" ><span | |||
class="codefrag">Numeric getMappedLength(FONode, int, | |||
int)</span></a> method. | |||
</p> | |||
<p> | |||
<a href= "javascript:topwin.displayCode( | |||
<a href= "javascript:window.top.displayCode( | |||
'BorderLeftWidth.html#BorderLeftWidthClass' )" ><span | |||
class="codefrag">BorderLeftWidth</span></a> extends <a href= | |||
"javascript:topwin.displayCode( 'BorderCommonWidth.html' )" | |||
"javascript:window.top.displayCode( 'BorderCommonWidth.html' )" | |||
><span class="codefrag">BorderCommonWidth</span></a>. It | |||
includes the basic static data, like <a | |||
href="simple-properties.html">simple properties</a>, and, in | |||
this case, the <a href= "javascript:topwin.displayCode( | |||
this case, the <a href= "javascript:window.top.displayCode( | |||
'BorderLeftWidth.html#getInitialValue' )" ><span | |||
class="codefrag">PropertyValue getInitialValue(int)</span></a> | |||
method to derive the initial value. | |||
@@ -263,17 +257,17 @@ | |||
<p> | |||
As usual with property values, the usual method of deriving a | |||
mapped numeric value is by calling the <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'../PropertyConsts.html#getMappedNumeric' )" ><span | |||
class="codefrag">Numeric getMappedNumeric(FONode, int, | |||
int)</span></a> method in <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'../PropertyConsts.html#pconsts' )" ><span | |||
class="codefrag">pconsts</span></a>. All properties which | |||
support a mapped numeric value must have a <span | |||
class="codefrag">Numeric getMappedNumeric(FONode, int)</span> | |||
method, which will be called through its singleton instance, | |||
stored in the <a href= "javascript:topwin.displayCode( | |||
stored in the <a href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#properties' )" ><span class= "codefrag" | |||
>properties</span ></a> array, by the <span | |||
class="codefrag">PropertyConsts</span> method. |
@@ -4,12 +4,6 @@ | |||
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | |||
<title>Generating Initial Values</title> | |||
<link type="text/css" href="../../../page.css" rel="stylesheet"> | |||
<script type="text/javascript"> | |||
<!-- | |||
topdoc=window.top.document; | |||
topwin=window.top; | |||
// --> | |||
</script> | |||
</head> | |||
<body marginheight="0" marginwidth="0" topmargin="0" leftmargin="0" text="#000000" bgcolor="#FFFFFF"> | |||
<div class="content"> | |||
@@ -49,7 +43,7 @@ | |||
</h3> | |||
<p> | |||
<a href= "javascript:topwin.displayCode( 'AutoRestore.html' )" | |||
<a href= "javascript:window.top.displayCode( 'AutoRestore.html' )" | |||
><span class="codefrag" | |||
>org.apache.fop.fo.properties.AutoRestore</span></a> is an | |||
example of the next most complex property class. In | |||
@@ -58,48 +52,48 @@ | |||
generation of a PropertyValue instance. | |||
</p> | |||
<p> | |||
The method <a href= "javascript:topwin.displayCode( | |||
The method <a href= "javascript:window.top.displayCode( | |||
'AutoRestore.html#getInitialValue' )" ><span | |||
class="codefrag">PropertyValue getInitialValue(int)</span></a> | |||
returns an instance of PropertyValue of the appropriate | |||
subclass containing the initial value for this property. Like | |||
the static data fields, this value is, in turn, stored in the | |||
array of initial values maintained in the <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'PropertyConsts.html#PropertyConstsClass' )" ><span | |||
class="codefrag">PropertyConsts</span></a> singleton <a href= | |||
"javascript:topwin.displayCode( 'PropertyConsts.html#pconsts' | |||
"javascript:window.top.displayCode( 'PropertyConsts.html#pconsts' | |||
)" ><span class="codefrag">pconsts</span></a>.` As with the | |||
fields, the first invocation of the method <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'PropertyConsts.html#setupProperty' )" ><span | |||
class="codefrag">setupProperty</span></a> on the property | |||
instantiates the singleton instance of the class, and stores | |||
that instance in the in the <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'PropertyConsts.html#properties' )" ><span | |||
class="codefrag">Property[] properties</span></a> array of <a | |||
href= "javascript:topwin.displayCode( | |||
href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#pconsts' )" ><span | |||
class="codefrag">pconsts</span></a>. | |||
</p> | |||
<p> | |||
Unlike the static data fields, however, the initial value is | |||
not immediately generated. It is generated by a call to <a | |||
href= "javascript:topwin.displayCode( | |||
href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#getInitialValue' )" ><span | |||
class="codefrag">PropertyValue getInitialValue(int)</span></a> | |||
in <a href= "javascript:topwin.displayCode( | |||
in <a href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#pconsts' )" ><span | |||
class="codefrag">pconsts</span></a>. This call, in turn, | |||
locates the relevant instance of the particular property class | |||
in the <a href= "javascript:topwin.displayCode( | |||
in the <a href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#properties' )" ><span class= "codefrag" | |||
>properties</span> array of <span class= "codefrag" | |||
>PropertyConsts</span></a>, and invokes the <span class= | |||
"codefrag" >getInitialValue()</span> of that instance. A | |||
side-effect of this call is to store the initial value in <a | |||
href= "javascript:topwin.displayCode( | |||
href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#initialValues' )" ><span | |||
class="codefrag">PropertyValue[] initialValues</span></a>. | |||
</p> | |||
@@ -114,10 +108,10 @@ | |||
As <a href="classes-overview.html#property-classes">noted | |||
previously</a>, all of the property classes extend <span | |||
class="codefrag">org.apache.fop.fo.properties.Property</span>. | |||
<a href= "javascript:topwin.displayCode( | |||
<a href= "javascript:window.top.displayCode( | |||
'Property.html#PropertyClass' )" ><span | |||
class="codefrag">Property</span></a> provides a base <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'Property.html#getInitialValue' )" ><span | |||
class="codefrag">PropertyValue getInitialValue(int)</span></a> | |||
method to which the simple classes fall back. Note that it is |
@@ -4,12 +4,6 @@ | |||
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | |||
<title>Property Expression Parsing</title> | |||
<link type="text/css" href="../../../page.css" rel="stylesheet"> | |||
<script type="text/javascript"> | |||
<!-- | |||
topdoc=window.top.document; | |||
topwin=window.top; | |||
// --> | |||
</script> | |||
</head> | |||
<body marginheight="0" marginwidth="0" topmargin="0" leftmargin="0" text="#000000" bgcolor="#FFFFFF"> | |||
<div class="content"> | |||
@@ -39,25 +33,25 @@ | |||
<p> | |||
The parsing of property value expressions is handled by two | |||
closely related classes: <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'PropertyTokenizer.html#PropertyTokenizerClass' )" ><span | |||
class= "codefrag" >org.apache.fop.fo.expr.PropertyTokenizer</span></a> | |||
and its subclass, <a href= "javascript:topwin.displayCode( | |||
and its subclass, <a href= "javascript:window.top.displayCode( | |||
'PropertyParser.html#PropertyParserClass' )" ><span | |||
class= "codefrag" >org.apache.fop.fo.expr.PropertyParser</span></a>, | |||
and by <span class= "codefrag" >refineParsing(int, FONode, | |||
PropertyValue)</span> methods in the individual property | |||
classes. <span class= "codefrag" >PropertyTokenizer</span>, as | |||
the name suggests, handles the tokenizing of the expression, | |||
handing <a href= "javascript:topwin.displayCode( | |||
handing <a href= "javascript:window.top.displayCode( | |||
'PropertyTokenizer.html#EOF' )" ><em>tokens</em></a> back to | |||
its subclass, <span | |||
class= "codefrag" >PropertyParser</span>. <span | |||
class= "codefrag" >PropertyParser</span>, in turn, returns a <a | |||
href= "javascript:topwin.displayCode( | |||
href= "javascript:window.top.displayCode( | |||
'PropertyValueList.html#PropertyValueListClass' )" ><span | |||
class= "codefrag">PropertyValueList</span></a>, a list of <a | |||
href= "javascript:topwin.displayCode( | |||
href= "javascript:window.top.displayCode( | |||
'PropertyValue.html#PropertyValueInterface' )" ><span class= | |||
"codefrag">PropertyValue</span></a>s. | |||
</p> | |||
@@ -65,7 +59,7 @@ | |||
The tokenizer and parser rely in turn on the datatype | |||
definitions from the <span | |||
class= "codefrag" >org.apache.fop.datatypes</span> package, | |||
which include the <a href= "javascript:topwin.displayCode( | |||
which include the <a href= "javascript:window.top.displayCode( | |||
'PropertyValue.html#NO_TYPE' )" ><span class= "codefrag" | |||
>PropertyValue</span> datatype constant definitions</a>. | |||
</p> | |||
@@ -331,7 +325,7 @@ | |||
<p> | |||
As mentioned above, the <span class= "codefrag" | |||
>PropertyTokenizer</span> hands <a href= | |||
"javascript:topwin.displayCode( 'PropertyTokenizer.html#EOF' | |||
"javascript:window.top.displayCode( 'PropertyTokenizer.html#EOF' | |||
)" ><em>tokens</em></a> back to its subclass, <span class= | |||
"codefrag" >PropertyParser</span>. Most of these tokens are | |||
self-explanatory, but a few need further comment. | |||
@@ -385,11 +379,11 @@ | |||
<a name="N1029C"></a> | |||
<h4>Parser</h4> | |||
<p> | |||
The parser returns a <a href= "javascript:topwin.displayCode( | |||
The parser returns a <a href= "javascript:window.top.displayCode( | |||
'PropertyValueList.html#PropertyValueListClass' )" ><span | |||
class= "codefrag" >PropertyValueList</span ></a>, necessary | |||
because of the possibility that a list of <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'PropertyValue.html#PropertyValueInterface' )" ><span class= | |||
"codefrag" >PropertyValue</span ></a> elements may be returned | |||
from the expressions of some properties. |
@@ -4,12 +4,6 @@ | |||
<META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> | |||
<title>Simple <property> Classes</title> | |||
<link type="text/css" href="../../../page.css" rel="stylesheet"> | |||
<script type="text/javascript"> | |||
<!-- | |||
topdoc=window.top.document; | |||
topwin=window.top; | |||
// --> | |||
</script> | |||
</head> | |||
<body marginheight="0" marginwidth="0" topmargin="0" leftmargin="0" text="#000000" bgcolor="#FFFFFF"> | |||
<div class="content"> | |||
@@ -38,7 +32,7 @@ | |||
data are represented within properties. Iit is important to | |||
keep in mind that the primary avenue of access to the data and | |||
the methods of property classes is the <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'PropertyConsts.html#PropertyConstsClass' )" ><span | |||
class="codefrag">PropertyConsts</span></a> class and its | |||
singleton object. | |||
@@ -48,7 +42,7 @@ | |||
<h3>Common data</h3> | |||
<p> | |||
<a href= "javascript:topwin.displayCode( 'Character.html' )" ><span | |||
<a href= "javascript:window.top.displayCode( 'Character.html' )" ><span | |||
class="codefrag">org.apache.fop.fo.properties.Character</span></a> | |||
is an example of a basic property class. The data fields | |||
common to all properties are: | |||
@@ -65,7 +59,7 @@ | |||
This field defines the allowable data types which may be | |||
assigned to the property. The value is chosen from the data | |||
type constants defined in <a href= | |||
"javascript:topwin.displayCode( 'Property.html#NOTYPE' )" | |||
"javascript:window.top.displayCode( 'Property.html#NOTYPE' )" | |||
><span | |||
class="codefrag">org.apache.fop.fo.properties.Property</span></a>, | |||
and may consist of more than one of those constants, | |||
@@ -82,7 +76,7 @@ | |||
This field defines the mapping of properties to traits in | |||
the <span class="codefrag">Area tree</span>. The value is | |||
chosen from the trait mapping constants defined in <a href= | |||
"javascript:topwin.displayCode( 'Property.html#NO_TRAIT' )" | |||
"javascript:window.top.displayCode( 'Property.html#NO_TRAIT' )" | |||
><span | |||
class="codefrag">org.apache.fop.fo.properties.Property</span></a>, | |||
and may consist of more than one of those constants, | |||
@@ -99,7 +93,7 @@ | |||
This field defines the data type of the initial value | |||
assigned to the property. The value is chosen from the | |||
initial value type constants defined in <a href= | |||
"javascript:topwin.displayCode( 'Property.html#NOTYPE_IT' )" | |||
"javascript:window.top.displayCode( 'Property.html#NOTYPE_IT' )" | |||
><span | |||
class="codefrag">org.apache.fop.fo.properties.Property</span></a>. | |||
In the simplest property classes, such as <span | |||
@@ -117,7 +111,7 @@ | |||
This field defines the kind of inheritance applicable to the | |||
property. The value is chosen from the inheritance | |||
constants defined in <a href= | |||
"javascript:topwin.displayCode( 'Property.html#NO' )" ><span | |||
"javascript:window.top.displayCode( 'Property.html#NO' )" ><span | |||
class="codefrag">org.apache.fop.fo.properties.Property</span></a>. | |||
</dd> | |||
@@ -127,25 +121,25 @@ | |||
<h3>Accessing <property> Data Constants</h3> | |||
<p> | |||
The constants above are generally accessed through the arrays | |||
maintained in the <a href= "javascript:topwin.displayCode( | |||
maintained in the <a href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#PropertyConstsClass' )" ><span | |||
class="codefrag">PropertyConsts</span></a> singleton <a href= | |||
"javascript:topwin.displayCode( 'PropertyConsts.html#pconsts' | |||
"javascript:window.top.displayCode( 'PropertyConsts.html#pconsts' | |||
)" ><span class="codefrag">pconsts</span></a>. The first | |||
invocation of the method <a href= | |||
"javascript:topwin.displayCode( | |||
"javascript:window.top.displayCode( | |||
'PropertyConsts.html#setupProperty' )" ><span | |||
class="codefrag">setupProperty</span></a> on the property | |||
generates a <span class="codefrag">Class</span> instance for | |||
the class, and stores it in the array <a href= | |||
"javascript:topwin.displayCode( 'PropertyConsts.html#classes' | |||
"javascript:window.top.displayCode( 'PropertyConsts.html#classes' | |||
)" ><span class="codefrag">classes</span></a>. This <span | |||
class="codefrag">Class</span> object is used, in turn, to | |||
instantiate the singleton instance of the class, which is | |||
stored in the <a href= "javascript:topwin.displayCode( | |||
stored in the <a href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#properties' )" ><span | |||
class="codefrag">Property[] properties</span></a> array of <a | |||
href= "javascript:topwin.displayCode( | |||
href= "javascript:window.top.displayCode( | |||
'../PropertyConsts.html#pconsts' )" ><span | |||
class="codefrag">pconsts</span></a>. | |||
</p> | |||
@@ -160,7 +154,7 @@ | |||
<dt> | |||
<a href= "javascript:topwin.displayCode( | |||
<a href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#datatypes' )" ><span | |||
class="codefrag">int[] datatypes</span></a> | |||
@@ -168,7 +162,7 @@ | |||
<dd> | |||
<a href= "javascript:topwin.displayCode( | |||
<a href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#getDataTypes' )" ><span | |||
class="codefrag">int getDataTypes(int)</span></a> | |||
@@ -176,7 +170,7 @@ | |||
<dt> | |||
<a href= "javascript:topwin.displayCode( | |||
<a href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#traitMappings' )" ><span | |||
class="codefrag">int[] traitMappings</span></a> | |||
@@ -190,7 +184,7 @@ | |||
<dt> | |||
<a href= "javascript:topwin.displayCode( | |||
<a href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#initialValueTypes' )" ><span | |||
class="codefrag">int[] initialValueTypes</span></a> | |||
@@ -198,7 +192,7 @@ | |||
<dd> | |||
<a href= "javascript:topwin.displayCode( | |||
<a href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#getInitialValueType' )" ><span | |||
class="codefrag">int getInitialValueType(int)</span></a> | |||
@@ -206,7 +200,7 @@ | |||
<dt> | |||
<a href= "javascript:topwin.displayCode( | |||
<a href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#inherited' )" ><span | |||
class="codefrag">int[] inherited</span></a> | |||
@@ -214,7 +208,7 @@ | |||
<dd> | |||
<a href= "javascript:topwin.displayCode( | |||
<a href= "javascript:window.top.displayCode( | |||
'PropertyConsts.html#inheritance' )" ><span | |||
class="codefrag">int inheritance(int)</span></a> | |||