fop 0.92beta

org.apache.fop.area.inline
Class UnresolvedPageNumber

java.lang.Object
  |
  +--org.apache.fop.area.Area
        |
        +--org.apache.fop.area.inline.InlineArea
              |
              +--org.apache.fop.area.inline.InlineParent
                    |
                    +--org.apache.fop.area.inline.AbstractTextArea
                          |
                          +--org.apache.fop.area.inline.TextArea
                                |
                                +--org.apache.fop.area.inline.UnresolvedPageNumber
All Implemented Interfaces:
Resolvable, java.io.Serializable

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

Inner classes inherited from class org.apache.fop.area.inline.AbstractTextArea
AbstractTextArea.TextAdjustingInfo
 
Inner classes inherited from class org.apache.fop.area.inline.InlineArea
InlineArea.InlineAdjustingInfo
 
Fields inherited from class org.apache.fop.area.inline.InlineParent
autoSize, inlines
 
Fields inherited from class org.apache.fop.area.inline.InlineArea
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
 
Constructor Summary
UnresolvedPageNumber(java.lang.String id, Font f)
          Create a new unresolvable 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, updateIPD
 
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
getOffset, getParentArea, hasLineThrough, hasOverline, hasUnderline, increaseIPD, isBlinking, notifyIPDVariation, 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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

UnresolvedPageNumber

public UnresolvedPageNumber(java.lang.String id,
                            Font f)
Create a new unresolvable page number.
Parameters:
id - the id reference for resolving this
f - the font for formatting the page number
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.92beta

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