org.apache.fop.area

Class DestinationData

Implemented Interfaces:
OffDocumentItem, Resolvable

public class DestinationData
extends AbstractOffDocumentItem
implements Resolvable

An instance of this class is named destination from fox:destination

Field Summary

Fields inherited from class org.apache.fop.area.AbstractOffDocumentItem

AFTER_PAGE, END_OF_DOC, IMMEDIATELY, START_OF_DOC, whenToProcess

Fields inherited from interface org.apache.fop.area.OffDocumentItem

AFTER_PAGE, END_OF_DOC, IMMEDIATELY

Constructor Summary

DestinationData(Destination destination)
Create a new pdf destination data object.

Method Summary

String
getIDRef()
Get the idref for this destination
String[]
getIDRefs()
String
getName()
PageViewport
getPageViewport()
Get the PageViewport object that this destination refers to
boolean
isResolved()
Check if this resolvable object has been resolved.
void
resolveIDRef(String id, List pages)
Resolves the idref of this object by getting the PageViewport object that corresponds to the IDRef

Methods inherited from class org.apache.fop.area.AbstractOffDocumentItem

getName, getWhenToProcess

Constructor Details

DestinationData

public DestinationData(Destination destination)
Create a new pdf destination data object. This is used by the destination to create a data object with a idref. During processing, this idref will be subsequently resolved to a particular PageViewport.
Parameters:
destination - the fo:bookmark object

Method Details

getIDRef

public String getIDRef()
Get the idref for this destination
Returns:
the idref for the destination

getIDRefs

public String[] getIDRefs()
Specified by:
getIDRefs in interface Resolvable

getName

public String getName()
Specified by:
getName in interface OffDocumentItem
Overrides:
getName in interface AbstractOffDocumentItem

getPageViewport

public PageViewport getPageViewport()
Get the PageViewport object that this destination refers to
Returns:
the PageViewport that this destination points to

isResolved

public boolean isResolved()
Check if this resolvable object has been resolved. For now, just return true. To do: Find a way to determine whether the destination has been resolved.
Specified by:
isResolved in interface Resolvable
Returns:
true if this object has been resolved

resolveIDRef

public void resolveIDRef(String id,
                         List pages)
Resolves the idref of this object by getting the PageViewport object that corresponds to the IDRef
Specified by:
resolveIDRef in interface Resolvable
To do:
check to make sure it works if multiple bookmark-items have the same idref

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