|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.9.0) E52944-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.jdevimpl.bookmarks.BookmarkList
public final class BookmarkList
The BookmarkList
class is the data class for storing a list of bookmarks - it contains public methods for searching for specific bookmarks via URL's. It is also used for persisting a list of code editor bookmarks across JDeveloper sessions.
Constructor Summary | |
---|---|
BookmarkList() Construct a new default BookmarkList instance. |
Method Summary | |
---|---|
Bookmark |
addBookmark(java.net.URL url, int line) Utility method which will add the given bookmark to the list if it does not already exist. |
java.lang.Object |
copyTo(java.lang.Object target) Copies the internal state of this object to the specified copy . |
Bookmark |
findBookmark(java.net.URL url, int line) Utility method which will search for a bookmark in the list with the specified url and line number. |
Bookmark[] |
findBookmarks(java.net.URL url) Utility method which will search for all bookmarks in our list matching the specified url. |
Bookmark |
findNumberedBookmark(int number) Return the bookmark with the given number, or null if one doesn't exist |
Bookmark[] |
getAllBookmarks() Utility method to fetch all of the bookmarks in our current list. |
int |
getBookmarkCount() Utility method to fetch the number of bookmarks in our current list. |
java.util.List<Bookmark> |
getBookmarkList() Fetch the list of bookmarks. |
Bookmark |
getNextBookmark(Bookmark bookmark, boolean thisURLOnly) Utility method which will find the next bookmark in our list after the current one, allowing for wrapping around the list. |
Bookmark |
getNextBookmark(java.net.URL url, int line, boolean thisURLOnly) Utility method which will find the next bookmark in our list after the current line in the given url, allowing for wrapping around the list. |
Bookmark |
getPreviousBookmark(Bookmark bookmark, boolean thisURLOnly) Utility method which will find the previous bookmark in our list before the current one, allowing for wrapping around the list. |
Bookmark |
getPreviousBookmark(java.net.URL url, int line, boolean thisURLOnly) Utility method which will find the previous bookmark in our list before the current line in the given url, allowing for wrapping around the list. |
boolean |
modifyBookmark(Bookmark bookmark, int line) Utility method which will modify the line of the specified bookmark for the purposes of keeping the list in sorted order by bookmark. |
void |
removeAllBookmarks() Utility method which will clear all bookmarks from our bookmark list. |
void |
removeBookmark(Bookmark bookmark) Utility method which will remove the specified bookmark from the list if it is present. |
void |
setBookmarkList(java.util.List<Bookmark> list) Sets the list of bookmarks. |
java.lang.String |
toString() Render a human-readable version of this object into a String for debugging purposes. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public BookmarkList()
BookmarkList
instance.Method Detail |
---|
public java.lang.String toString()
toString
in class java.lang.Object
public Bookmark[] getAllBookmarks()
public int getBookmarkCount()
public Bookmark getNextBookmark(java.net.URL url, int line, boolean thisURLOnly)
url
- the url to start the search fromline
- the line to start fromthisURLOnly
- whether to only locate bookmarks with this urlpublic Bookmark getNextBookmark(Bookmark bookmark, boolean thisURLOnly)
bookmark
- the bookmark to start searching fromthisURLOnly
- whether to only locate bookmarks with the same URL as the bookmark we specifypublic Bookmark getPreviousBookmark(java.net.URL url, int line, boolean thisURLOnly)
url
- the url to start the search fromline
- the line to start fromthisURLOnly
- whether to only locate bookmarks with this urlpublic Bookmark getPreviousBookmark(Bookmark bookmark, boolean thisURLOnly)
bookmark
- the bookmark to start searching fromthisURLOnly
- whether to only locate bookmarks with the same URL as the bookmark we specifypublic Bookmark[] findBookmarks(java.net.URL url)
url
- the url of the bookmark to search forpublic Bookmark findBookmark(java.net.URL url, int line)
url
- the url of the bookmark to search forline
- the line of the bookmark to search forpublic Bookmark addBookmark(java.net.URL url, int line)
url
- the url for the bookmarkline
- the line of the bookmarkpublic boolean modifyBookmark(Bookmark bookmark, int line)
bookmark
- the bookmark to modifyline
- the new line number to setpublic void removeBookmark(Bookmark bookmark)
bookmark
- the bookmark to remove from the listpublic void removeAllBookmarks()
public java.lang.Object copyTo(java.lang.Object target)
this
object to the specified copy
.copyTo
in interface Copyable
this
object was copied. If the target
was non-null
, then the return value is the same as the target
object that was passed in; otherwise, the return value is a new instance of this
class.public java.util.List<Bookmark> getBookmarkList()
public void setBookmarkList(java.util.List<Bookmark> list)
list
- the list of bookmarkspublic Bookmark findNumberedBookmark(int number)
number
-
|
Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference 11g Release 1 (11.1.1.9.0) E52944-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |