Package com.nomagic.magicreport.engine.tools

Class BookmarkTool

java.lang.Object

java.util.Observable

com.nomagic.magicreport.engine.Tool

com.nomagic.magicreport.engine.tools.BookmarkTool

All Implemented Interfaces:

ITool, IVariable, Serializable, Cloneable

@OpenApiAll
public class BookmarkTool
extends Tool

Contains utilities functions for bookmark. Context name of this class is "bookmark". Public functions of this class are able to access via template by using $bookmark

Since:

Jun 19, 2007

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.nomagic.magicreport.engine.ITool

ITool.HTMLString, ITool.RetainedString, ITool.Void

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTEXT_NAME	Contains a context name.

Fields inherited from class com.nomagic.magicreport.engine.Tool

context, properties

Fields inherited from interface com.nomagic.magicreport.engine.ITool

VOID

Constructor Summary

Constructors

Constructor	Description
BookmarkTool()

Method Summary

Modifier and Type	Method	Description
Bookmark	create(Object bookmarkObject)	Function to create bookmark.
Bookmark	create(String bookmarkId, Object bookmarkObject)	Function to create bookmark.
Bookmark	create(String bookmarkId, Object bookmarkObject, String elementType)	Function to create bookmark with the specified element type.
TextReference	createRef(String refId)	Return a bookmark for REF from given string.
TextReference	createRef(String refId, String content)	Return a bookmark for REF from given string.
String	getBookmarkId(String id)	Return a bookmark id from given string.
Link	open(Object content)	Function to create hyperlink for bookmark.
Link	open(String bookmarkId, Object content)	Function to create hyperlink for bookmark.
TextReference	openRef(String refId)	Return a reference to REF.
TextReference	openRef(String refId, String refText)	eturn a reference to REF.
Link	openURL(String url, Object content)	Function to create hyperlink for open an URL.
Link	openURL(URI uri, Object content)	Function to create hyperlink for open an URL.
Link	openURL(URL url, Object content)	Function to create hyperlink for open an URL.

Methods inherited from class com.nomagic.magicreport.engine.Tool

clone, getContext, getProperties, getProperty, getProperty, notifyObservers, setContext, setProperties

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.nomagic.magicreport.engine.ITool

clearTool

Field Details

CONTEXT_NAME

public static final String CONTEXT_NAME

Contains a context name.

See Also:

• Constant Field Values

Constructor Details

BookmarkTool

public BookmarkTool()

Method Details

openURL

public Link openURL(String url,
 Object content)

Function to create hyperlink for open an URL.

 <code>
 $bookmark.openURL("http://www.nomagicasia.com", "NoMagic Asia")
 </code>
 

Parameters:

url - the url text. If null, empty string will be used.

content - the text content. If null, empty string will be used.

Returns:

content with hyperlink in document format.

See Also:

• open(String, Object)
• create(Object)

openURL

public Link openURL(URL url,
 Object content)

Function to create hyperlink for open an URL.

 <code>
 $bookmark.openURL($url, "NoMagic Asia")
 </code>
 

Parameters:

url - the URL instance. If null, empty string will be used.

content - text content. If null, empty string will be used.

Returns:

content with hyperlink in RTF format.

See Also:

• open(String, Object)
• create(Object)

openURL

public Link openURL(URI uri,
 Object content)

Function to create hyperlink for open an URL.

 <code>
 $bookmark.openURL($uri, "NoMagic Asia")
 </code>
 

Parameters:

uri - the URI instance. If null, empty string will be used.

content - text content. If null, empty string will be used.

Returns:

content with hyperlink in RTF format.

See Also:

• open(String, Object)
• create(Object)

open

public Link open(Object content)

Function to create hyperlink for bookmark. The bookmark ID will be automatically generated from content.

 <code>
    #foreach ($uc in $UseCase)
       $bookmark.open($uc.name)
    #end
    #foreach ($uc in $UseCase)
       $bookmark.create($uc.name)
    #end
 </code>
 

Parameters:

content - text content. If null, ID will be a digest of "0" and name will be a hash code of object.

Returns:

content with hyperlink in RTF format.

See Also:

• open(String, Object)
• create(Object)

open

public Link open(String bookmarkId,
 Object content)

Function to create hyperlink for bookmark. bookmarkID value must match with parameter bookmarkID that pass into create(String, Object) function.

 <code>
    #foreach ($uc in $UseCase)
       $bookmark.open($uc.name)
    #end
    #foreach ($uc in $UseCase)
       $bookmark.create($uc.name)
    #end
 </code>
 

Parameters:

bookmarkId - the bookmark id. If null, digest of empty string will be used.

content - text content. If null, empty string will be used.

Returns:

content with hyperlink in RTF format.

See Also:

• open(Object)
• create(String, Object)

create

public Bookmark create(Object bookmarkObject)

Function to create bookmark. The bookmark ID will be automatically generated from bookmark object.

 <code>
    #foreach ($uc in $UseCase)
       $bookmark.open($uc.name)
    #end
    #foreach ($uc in $UseCase)
       $bookmark.create($uc.name)
    #end
 </code>
 

Parameters:

bookmarkObject - the bookmark object or content. If null, ID will be a digest of "0" and name will be a hash code of object.

Returns:

content with bookmark in RTF format.

create

public Bookmark create(String bookmarkId,
 Object bookmarkObject)

Function to create bookmark. The default element type for this function is "label".

 <code>
    #foreach ($uc in $UseCase)
       $bookmark.open($uc.ID, $uc.name)
    #end
    #foreach ($uc in $UseCase)
       $bookmark.create($uc.ID, $uc.name)
    #end
 </code>
 

Parameters:

bookmarkId - the bookmark. If null, digest of empty string will be used.

bookmarkObject - the bookmark object or content. If null, empty string will be used.

Returns:

content with bookmark in RTF format.

create

public Bookmark create(String bookmarkId,
 Object bookmarkObject,
 String elementType)

Function to create bookmark with the specified element type.

 <code>
    #foreach ($uc in $UseCase)
       $bookmark.open($uc.ID, $uc.name)
    #end
    #foreach ($uc in $UseCase)
       $bookmark.create($uc.ID, $uc.name, "label")
    #end
 </code>
 

Parameters:

bookmarkId - the bookmark id. If null, digest of empty string will be used.

bookmarkObject - the bookmark object or content. If null, empty string will be used.

elementType - name of element type e.g. html tag.

Returns:

content with bookmark in format.

getBookmarkId

public String getBookmarkId(String id)

Return a bookmark id from given string.

Parameters:

id - original string value

Returns:

a bookmark id

See Also:

• UUIDGenerator.createId(String)

createRef

public TextReference createRef(String refId)

Return a bookmark for REF from given string.

Parameters:

refId - the bookmark id. If null, digest of empty string will be used.

Returns:

a bookmark for REF

See Also:

• UUIDGenerator.createId(String)

createRef

public TextReference createRef(String refId,
 String content)

Return a bookmark for REF from given string.

Parameters:

refId - the bookmark id. If null, digest of empty string will be used.

content - text content

Returns:

a bookmark for REF

See Also:

• UUIDGenerator.createId(String)

openRef

public TextReference openRef(String refId)

Return a reference to REF.

Parameters:

refId - the bookmark id. If null, digest of empty string will be used.

Returns:

a reference to REF

openRef

public TextReference openRef(String refId,
 String refText)

eturn a reference to REF.

Parameters:

refId - the bookmark id. If null, digest of empty string will be used.

content - text content

Returns:

a reference to REF