## org.autoplot.bookmarks.Bookmark

Internal representation of a Bookmark, containing an Autoplot URI, title, and additional documentation for the URI. This can also be a folder that contains a list of Bookmarks, or a remote folder that is controlled be a remote bookmarks file./

## TITLE_ERROR_OCCURRED

## MSG_NO_REMOTE

## TOOLTIP_NO_REMOTE

## MSG_REMOTE

## TOOLTIP_REMOTE

## MSG_NOT_LOADED

## TOOLTIP_NOT_LOADED

## REMOTE_BOOKMARK_DEPTH_LIMIT

limit on the number of remote containing remote containing remote...

## PROP_ICON

## PROP_PARENT

## addPropertyChangeListener

addPropertyChangeListener( java.beans.PropertyChangeListener l ) → void

Adds a PropertyChangeListener to the listener list.

### Parameters

l - The listener to add.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]
copy( ) → org.autoplot.bookmarks.Bookmark [view source]
formatBookmark( org.w3c.dom.Document doc, org.w3c.dom.Element parent, org.autoplot.bookmarks.Bookmark bookmark ) → void [view source]

## formatBookmark

formatBookmark( org.autoplot.bookmarks.Bookmark bookmark ) → String

format the bookmarks into xml for persistent storage.

### Parameters

bookmark - List of Bookmark.List or Bookmark

### Returns:

string containing formatted bookmarks
[search for examples] [view on GitHub] [view on old javadoc]

## formatBooks

formatBooks( java.util.List bookmarks ) → String

format the bookmarks into xml for persistent storage.

### Parameters

bookmarks - List of Bookmark.List or Bookmark

### Returns:

a String
[search for examples] [view on GitHub] [view on old javadoc]

## formatBooks

formatBooks( java.io.OutputStream out, java.util.List bookmarks ) → void

format the bookmarks into xml for persistent storage.

### Parameters

out - OutputStream for the bookmarks
bookmarks - List of Bookmark.List or Bookmark

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]

## formatBooksOld

formatBooksOld( java.util.List bookmarks ) → String

format the bookmarks into xml for persistent storage.

### Parameters

bookmarks - List of Bookmark.List or Bookmark

### Returns:

a String
[search for examples] [view on GitHub] [view on old javadoc]
getDescription( ) → String [view source]

## getDescriptionUrl

getDescriptionUrl( ) → java.net.URL

returns the URL, or null if one is not available.

### Returns:

a java.net.URL
[search for examples] [view on GitHub] [view on old javadoc]
getIcon( ) → javax.swing.ImageIcon [view source]
getId( ) → String [view source]
getParent( ) → org.autoplot.bookmarks.Bookmark.Folder [view source]
getTitle( ) → String [view source]
isHidden( ) → boolean [view source]
parseBookmark( String data ) → org.autoplot.bookmarks.Bookmark [view source]

## parseBookmark

parseBookmark( org.w3c.dom.Node element, String vers, int remoteLevel ) → org.autoplot.bookmarks.Bookmark

parse the bookmarks in this node.

### Parameters

element - a Node
vers - null, empty string <2011, or version number
remoteLevel - If >0, then allow remote to be retrieved (this many levels). If <0 then assume remote bookmarks have been resolved.

### Returns:

Bookmark. If it's a folder, then bookmark.remoteStatus can be used to determine if it needs to be reloaded.
[search for examples] [view on GitHub] [view on old javadoc]
parseBookmarks( String data ) → java.util.List [view source]
parseBookmarks( String data, int depth ) → java.util.List [view source]

## parseBookmarks

parseBookmarks( java.net.URL url ) → java.util.List

read in the bookmarks file, which should be an xml file with the top node <bookmark-list>.

### Parameters

url - local or remote file.

### Returns:

a java.util.List
[search for examples] [view on GitHub] [view on old javadoc]

## parseBookmarks

parseBookmarks( org.w3c.dom.Element root ) → java.util.List

parse the bookmarks in the element root into a list of folders and bookmarks. The root element should be a bookmark-list containing <bookmark-folder> and <bookmark> A remote level of 1 is implied.

### Parameters

root - the root node, from which the version scheme should be read

### Returns:

the bookmarks, possibly with unresolved remote nodes.
[search for examples] [view on GitHub] [view on old javadoc]

## parseBookmarks

parseBookmarks( org.w3c.dom.Element root, int remoteLevel ) → java.util.List

parse the bookmarks, checking to see what version scheme should be used.

### Parameters

root - the root node, from which the version scheme should be read
remoteLevel - if >0, then allow remote to be retrieved (this many levels). <0 means assume resolve have been resolved.

### Returns:

the bookmarks, possibly with unresolved remote nodes.
[search for examples] [view on GitHub] [view on old javadoc]

## parseBookmarks

parseBookmarks( org.w3c.dom.Element root, String vers, int remoteLevel ) → java.util.List

parse the bookmarks in the element root into a list of folders and bookmarks. The root element should be a bookmark-list containing <bookmark-folder> and <bookmark>

### Parameters

root - an Element
vers - null or the version string. If null, then check for a version attribute.
remoteLevel - if >0, then allow remote to be retrieved (this many levels). <0 means assume resolve have been resolved.

### Returns:

the bookmarks, possibly with unresolved remote nodes.
[search for examples] [view on GitHub] [view on old javadoc]

## removePropertyChangeListener

removePropertyChangeListener( java.beans.PropertyChangeListener l ) → void

Removes a PropertyChangeListener from the listener list.

### Parameters

l - The listener to remove.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc]
setDescription( String description ) → void [view source]
setDescriptionUrl( java.net.URL descriptionUrl ) → void [view source]
setHidden( boolean hidden ) → void [view source]
setIcon( javax.swing.ImageIcon icon ) → void [view source]
setId( String id ) → void [view source]
setParent( org.autoplot.bookmarks.Bookmark.Folder parent ) → void [view source]
setTitle( String title ) → void [view source]
toString( ) → String [view source]