public class BookmarkRegistry
extends java.lang.Object
Use getOrCreateBookmarkID(UmlObject)
for UmlObjects that you potentially want to be able
to refer to from others. At present, we do only classes (they are types and super-types) and
enumeration literals (they are potentially used as initial values).
Use markAsAvailableInDocument(String)
in ObjectDoc
subclasses that actually
denote places that you would like to reference (by printing documentation for classes and
enumeration literals). These are like bookmarks.
Constructor and Description |
---|
BookmarkRegistry()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
findID(UmlObject o) |
java.lang.String |
getOrCreateBookmarkID(UmlObject o)
Returns the existing or the newly created bookmark ID for key
o . |
boolean |
isAvailableInDocument(java.lang.String bookmarkID)
Returns whether the bookmark has been added to the document during writing; if so, it can be
used to create hyperlink.
|
void |
markAsAvailableInDocument(java.lang.String bookmarkID)
Called from writer for ObjectDocs that have bookmark ID when actual bookmark is added to the
document; these are then available in the last pass, to insert hyperlinks pointing to those
bookmarks.
|
public java.lang.String getOrCreateBookmarkID(UmlObject o)
o
. Use this for
every object whose documentation you may want to refer to.public java.lang.String findID(UmlObject o)
public void markAsAvailableInDocument(java.lang.String bookmarkID)
public boolean isAvailableInDocument(java.lang.String bookmarkID)
Copyright 2009-2016 Tatjana (Tanja) Kostic