|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.datatypes.IDReferences
public class IDReferences
IDReferences contains a map of IDs and the objects to which they refer. It also contains a list of references to IDs which have yet to be encountered. Modified by Mark Lillywhite mark-fop@inomial.com. Added getInvalidElements() so that StreamRenderer can tell what hasn't been determined yet. Modified by lmckenzi@ca.ibm.com Sometimes IDs are created, but not validated. This code fixes the incorrect complaint that the ID already exists which prevents basic-links from working (sometimes).
Constructor Summary | |
---|---|
IDReferences()
Constructor for IDReferences |
Method Summary | |
---|---|
void |
addToIdValidationList(String id)
Adds id to validation list to be validated. |
void |
addToUnvalidatedIdList(String id)
Adds created id list of unvalidated ids that have already been created. |
void |
configureID(String id,
Area area)
Configures this id |
void |
createID(String id)
Creates id entry |
String |
createInternalLinkGoTo(String id,
int objectNumber)
creates an Internal Link GoTo object for this id |
void |
createNewId(String id)
Adds an id to IDReferences |
void |
createUnvalidatedID(String id)
Creates id entry that hasn't been validated |
boolean |
doesGoToReferenceExist(String id)
Determines whether the GoTo reference for the specified id is defined |
boolean |
doesIDExist(String id)
Determines whether specified id already exists in IDReferences |
boolean |
doesUnvalidatedIDExist(String id)
Determines whether specified id already exists in idUnvalidated |
String |
getDestinationRef(String id)
Returns a destination reference for the node with the specified id. |
String |
getInternalLinkGoToReference(String id)
Returns the reference to the GoTo object used for the internal link |
Iterator |
getInvalidElements()
|
String |
getInvalidIds()
Returns all invalid id's still remaining in the validation list |
String |
getPageNumber(String id)
Returns the page number where the specified id is found |
PDFGoTo |
getPDFGoTo(String id)
Returns the PDFGoTo object for the specified id |
void |
initializeID(String id,
Area area)
Creates and configures the specified id. |
boolean |
isEveryIdValid()
Determines whether all id's are valid |
void |
removeFromIdValidationList(String id)
Removes id from validation list. |
void |
removeFromUnvalidatedIDList(String id)
Removes id from list of unvalidated ids. |
void |
removeID(String id)
Removes id from IDReferences |
void |
setInternalGoToPageReference(String id,
String pageReference)
sets the page reference for the internal link's GoTo. |
void |
setPageNumber(String id,
String pageNumber)
Sets the page number for the specified id |
void |
setPosition(String id,
int x,
int y)
Sets the x and y position of specified id |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IDReferences()
Method Detail |
---|
public void initializeID(String id, Area area) throws FOPException
id
- The id to initializearea
- The area where this id was encountered
FOPException
public void createID(String id) throws FOPException
id
- The id to createarea
- The area where this id was encountered
FOPException
public void createUnvalidatedID(String id)
id
- The id to createpublic void addToUnvalidatedIdList(String id)
id
- The id to createpublic void removeFromUnvalidatedIDList(String id)
id
- The id to removepublic boolean doesUnvalidatedIDExist(String id)
id
- The id to search for
public void configureID(String id, Area area)
id
- The id to configurearea
- The area where the id was encounteredpublic void addToIdValidationList(String id)
id
- id to be addedpublic void removeFromIdValidationList(String id)
id
- the id to removepublic void removeID(String id)
id
- The id to removepublic boolean isEveryIdValid()
public String getInvalidIds()
public boolean doesIDExist(String id)
id
- the id to search for
public boolean doesGoToReferenceExist(String id)
id
- the id to search for
public String getInternalLinkGoToReference(String id)
id
- the id whose reference to use
public String createInternalLinkGoTo(String id, int objectNumber)
id
- The id for which to set the Internal Link Go ToobjectNumber
- The object number to use for the GoTo object
public void createNewId(String id)
id
- the id to addpublic PDFGoTo getPDFGoTo(String id)
id
- the id for which the PDFGoTo to be retrieved is associated
public void setInternalGoToPageReference(String id, String pageReference)
pageReference
- the page reference to which the internal link GoTo should jump
ex. 23 0 Rpublic void setPageNumber(String id, String pageNumber)
id
- The id whose page number is being setpageNumber
- The page number of the specified idpublic String getPageNumber(String id)
id
- The id whose page number to return
public void setPosition(String id, int x, int y)
id
- the id whose position is to be setx
- x position of idy
- y position of idpublic Iterator getInvalidElements()
public String getDestinationRef(String id)
id
- The id whose destination reference to return
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |