$bookmark contains utility functions for bookmarking. The functions of this module are accessible from templates through $bookmark.
Information
In RTF reports, the default style of bookmarks depends on the RTF editor used. For example, Microsoft Word 2003 displays hyperlinks in blue.
$bookmark.openURL(url, content)
Create a hyperlink to open a URL.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | url | java.lang.String | A URL text. |
| content | java.lang.Object | The text content. | |
| Return | - | com.nomagic.magicreport.Link | The text content with a hyperlink in the RTF format. |
For example:
$bookmark.openURL("http://www.nomagicasia.com","NoMagic Asia")
$bookmark.openURL(url, content)
Create a hyperlink to open a URL.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | url | java.net.URL | A URL instance. |
| content | java.lang.Object | The text content. | |
| Return | - | com.nomagic.magicreport.Link | The text content |
For example:
$bookmark.openURL($url, "NoMagic Asia")
$bookmark.openURL(uri, content)
Create a hyperlink to open a URI.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | uri | java.net.URI | A URI instance. |
| content | java.lang.Object | The text content. | |
| Return | - | com.nomagic.magicreport.Link | The content with a hyperlink in the RTF format. |
For example:
$bookmark.openURL($uri, "NoMagic Asia")
$bookmark.open(content)
Create a hyperlink for a bookmark. The bookmark ID will be automatically generated from the content.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | content | java.lang.Object | The text content. |
| Return | - | com.nomagic.magicreport.Link | The text content with a hyperlink in the RTF format. |
$bookmark.open(bookmarkId, content)
Create a hyperlink for a bookmark. The bookmark ID value must match the parameter bookmark ID that passes onto the link.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | bookmarkId | java.lang.String | The bookmark ID. |
| content | java.lang.Object | The text content. | |
| Return | - | com.nomagic.magicreport.Link | The text content with a hyperlink in the RTF format. |
For example:
Click this link to: $bookmark.open($element.elementID, "Click here to $element.name")
$bookmark.create(bookmarkObject)
Create a bookmark. The bookmark ID will be automatically generated from the bookmark object.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | bookmarkObject | java.lang.Object | A bookmark object or content. |
| Return | - | com.nomagic.magicreport.Bookmark | The content with a bookmark in the RTF format. |
$bookmark.create(bookmarkId, bookmarkObject)
Create a bookmark. The default element type for this function is "label".
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | bookmarkId | java.lang.String | The bookmark ID. |
| bookmarkObject | java.lang.Object | A bookmark object or content. | |
| Return | - | com.nomagic.magicreport.Bookmark | The content with a bookmark in the RTF format. |
For example:
$bookmark.create($element.elementID, $element.name)
$bookmark.create(bookmarkId, bookmarkObject, elementType)
Create a bookmark by specifying an element type.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | bookmarkId | java.lang.String | The bookmark ID. |
| bookmarkObject | java.lang.Object | A bookmark object or content. | |
| elementType | java.lang.String | An element type name, for example, html tag. | |
| Return | - | com.nomagic.magicreport.Bookmark | The content with a bookmark in the RTF format. |
$bookmark.getBookmarkId(id)
Return a bookmark ID from a given string.
| Name | Type | Description | |
|---|---|---|---|
| Parameter(s) | id | java.lang.String | An original string value. |
| Return | - | com.nomagic.magicreport.Bookmark | The bookmark ID. |