fop 0.95

org.apache.fop.area.inline
Class UnresolvedPageNumber

java.lang.Object
  extended by org.apache.fop.area.AreaTreeObject
      extended by org.apache.fop.area.Area
          extended by org.apache.fop.area.inline.InlineArea
              extended by org.apache.fop.area.inline.InlineParent
                  extended by org.apache.fop.area.inline.AbstractTextArea
                      extended by org.apache.fop.area.inline.TextArea
                          extended by org.apache.fop.area.inline.UnresolvedPageNumber
All Implemented Interfaces:
java.io.Serializable, Resolvable

public class UnresolvedPageNumber
extends TextArea
implements Resolvable

Unresolvable page number area. This is a word area that resolves itself to a page number from an id reference.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.fop.area.inline.AbstractTextArea
AbstractTextArea.TextAdjustingInfo
 
Nested classes/interfaces inherited from class org.apache.fop.area.inline.InlineArea
InlineArea.InlineAdjustingInfo
 
Field Summary
static boolean FIRST
          Indicates that the reference refers to the first area generated by a formatting object.
static boolean LAST
          Indicates that the reference refers to the last area generated by a formatting object.
 
Fields inherited from class org.apache.fop.area.inline.InlineParent
autoSize, inlines
 
Fields inherited from class org.apache.fop.area.inline.InlineArea
adjustingInfo, offset
 
Fields inherited from class org.apache.fop.area.Area
bpd, BT, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, ipd, log, LR, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, props, RL, TB
 
Fields inherited from class org.apache.fop.area.AreaTreeObject
foreignAttributes
 
Constructor Summary
UnresolvedPageNumber(java.lang.String id, Font f)
          Create a new unresolved page number.
UnresolvedPageNumber(java.lang.String id, Font f, boolean type)
          Create a new unresolved page number.
 
Method Summary
 boolean applyVariationFactor(double variationFactor, int lineStretch, int lineShrink)
          recursively apply the variation factor to all descendant areas
 java.lang.String[] getIDRefs()
          Get the id references for this area.
 boolean isResolved()
          Check if this is resolved.
 void resolveIDRef(java.lang.String id, java.util.List pages)
          Resolve the page number idref This resolves the idref for this object by getting the page number string from the first page in the list of pages that apply for this ID.
 
Methods inherited from class org.apache.fop.area.inline.TextArea
addSpace, addWord, addWord, getText, removeText
 
Methods inherited from class org.apache.fop.area.inline.AbstractTextArea
getBaselineOffset, getTextLetterSpaceAdjust, getTextWordSpaceAdjust, setBaselineOffset, setSpaceDifference, setTextLetterSpaceAdjust, setTextWordSpaceAdjust
 
Methods inherited from class org.apache.fop.area.inline.InlineParent
addChildArea, getChildAreas
 
Methods inherited from class org.apache.fop.area.inline.InlineArea
getAdjustingInfo, getOffset, getParentArea, handleIPDVariation, hasLineThrough, hasOverline, hasUnderline, increaseIPD, isBlinking, notifyIPDVariation, setAdjustingInfo, setAdjustment, setOffset, setParentArea
 
Methods inherited from class org.apache.fop.area.Area
addTrait, addTrait, getAllocBPD, getAllocIPD, getAreaClass, getBooleanTrait, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getBPD, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsInteger, getTraits, hasTrait, hasTraits, setAreaClass, setBPD, setIPD, toString
 
Methods inherited from class org.apache.fop.area.AreaTreeObject
getForeignAttributes, getForeignAttributeValue, setForeignAttribute, setForeignAttributes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

FIRST

public static final boolean FIRST
Indicates that the reference refers to the first area generated by a formatting object.

See Also:
Constant Field Values

LAST

public static final boolean LAST
Indicates that the reference refers to the last area generated by a formatting object.

See Also:
Constant Field Values
Constructor Detail

UnresolvedPageNumber

public UnresolvedPageNumber(java.lang.String id,
                            Font f)
Create a new unresolved page number.

Parameters:
id - the id reference for resolving this
f - the font for formatting the page number

UnresolvedPageNumber

public UnresolvedPageNumber(java.lang.String id,
                            Font f,
                            boolean type)
Create a new unresolved page number.

Parameters:
id - the id reference for resolving this
f - the font for formatting the page number
type - indicates whether the reference refers to the first or last area generated by a formatting object
Method Detail

getIDRefs

public java.lang.String[] getIDRefs()
Get the id references for this area.

Specified by:
getIDRefs in interface Resolvable
Returns:
the id reference for this unresolved page number

resolveIDRef

public void resolveIDRef(java.lang.String id,
                         java.util.List pages)
Resolve the page number idref This resolves the idref for this object by getting the page number string from the first page in the list of pages that apply for this ID. The page number text is then set to the String value of the page number.

Specified by:
resolveIDRef in interface Resolvable
Parameters:
id - an id whose PageViewports have been determined
pages - the list of PageViewports associated with this ID

isResolved

public boolean isResolved()
Check if this is resolved.

Specified by:
isResolved in interface Resolvable
Returns:
true when this has been resolved

applyVariationFactor

public boolean applyVariationFactor(double variationFactor,
                                    int lineStretch,
                                    int lineShrink)
recursively apply the variation factor to all descendant areas

Overrides:
applyVariationFactor in class AbstractTextArea
Parameters:
variationFactor - the variation factor that must be applied to adjustment ratios
lineStretch - the total stretch of the line
lineShrink - the total shrink of the line
Returns:
true if there is an UnresolvedArea descendant

fop 0.95

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.