@OpenApiAll public class BookmarkTool extends Tool
$bookmark
ITool.HTMLString, ITool.RetainedString, ITool.Void
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CONTEXT_NAME
Contains a context name.
|
context, properties
Constructor and Description |
---|
BookmarkTool() |
Modifier and Type | Method and Description |
---|---|
Bookmark |
create(java.lang.Object bookmarkObject)
Function to create bookmark.
|
Bookmark |
create(java.lang.String bookmarkId,
java.lang.Object bookmarkObject)
Function to create bookmark.
|
Bookmark |
create(java.lang.String bookmarkId,
java.lang.Object bookmarkObject,
java.lang.String elementType)
Function to create bookmark with the specified element type.
|
java.lang.String |
getBookmarkId(java.lang.String id)
Return a bookmark id from given string.
|
Link |
open(java.lang.Object content)
Function to create hyperlink for bookmark.
|
Link |
open(java.lang.String bookmarkId,
java.lang.Object content)
Function to create hyperlink for bookmark.
|
Link |
openURL(java.lang.String url,
java.lang.Object content)
Function to create hyperlink for open an URL.
|
Link |
openURL(java.net.URI uri,
java.lang.Object content)
Function to create hyperlink for open an URL.
|
Link |
openURL(java.net.URL url,
java.lang.Object content)
Function to create hyperlink for open an URL.
|
clone, getContext, getProperties, getProperty, getProperty, notifyObservers, setContext, setProperties
public static final java.lang.String CONTEXT_NAME
public Link openURL(java.lang.String url, java.lang.Object content)
<code> $bookmark.openURL("http://www.nomagicasia.com", "NoMagic Asia") </code>
url
- the url text. If null, empty string will be used.content
- the text content. If null, empty string will be used.open(String, Object)
,
create(Object)
public Link openURL(java.net.URL url, java.lang.Object content)
<code> $bookmark.openURL($url, "NoMagic Asia") </code>
url
- the URL instance. If null, empty string will be used.content
- text content. If null, empty string will be used.open(String, Object)
,
create(Object)
public Link openURL(java.net.URI uri, java.lang.Object content)
<code> $bookmark.openURL($uri, "NoMagic Asia") </code>
uri
- the URI instance. If null, empty string will be used.content
- text content. If null, empty string will be used.open(String, Object)
,
create(Object)
public Link open(java.lang.Object content)
<code> #foreach ($uc in $UseCase) $bookmark.open($uc.name) #end #foreach ($uc in $UseCase) $bookmark.create($uc.name) #end </code>
content
- text content. If null, ID will be a digest of "0" and name will be a hash code of object.open(String, Object)
,
create(Object)
public Link open(java.lang.String bookmarkId, java.lang.Object content)
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>
bookmarkId
- the bookmark id. If null, digest of empty string will be used.content
- text content. If null, empty string will be used.open(Object)
,
create(String, Object)
public Bookmark create(java.lang.Object bookmarkObject)
<code> #foreach ($uc in $UseCase) $bookmark.open($uc.name) #end #foreach ($uc in $UseCase) $bookmark.create($uc.name) #end </code>
bookmarkObject
- the bookmark object or content. If null, ID will be a digest of "0" and name will be a
hash code of object.public Bookmark create(java.lang.String bookmarkId, java.lang.Object bookmarkObject)
<code> #foreach ($uc in $UseCase) $bookmark.open($uc.ID, $uc.name) #end #foreach ($uc in $UseCase) $bookmark.create($uc.ID, $uc.name) #end </code>
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.public Bookmark create(java.lang.String bookmarkId, java.lang.Object bookmarkObject, java.lang.String elementType)
<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>
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.public java.lang.String getBookmarkId(java.lang.String id)
id
- original string valueUUIDGenerator.createId(String)
Copyright © 2010 - No Magic Asia