Class javax.help.FavoritesItem

java.lang.Object
    |
    +----javax.help.TreeItem
            |
            +----javax.help.FavoritesItem

public class FavoritesItem
extends TreeItem
implements java.awt.datatransfer.Transferable, java.io.Serializable
A class for individual favorites items.


FAVORITES_FLAVOR

public static final java.awt.datatransfer.DataFlavor FAVORITES_FLAVOR

FavoritesItem

public FavoritesItem(java.lang.String name)
Creates item with name
Parameters:
name - The name of item

FavoritesItem

public FavoritesItem()
Creates empty item

FavoritesItem

public FavoritesItem(java.lang.String name,
                     java.lang.String target,
                     java.lang.String url,
                     java.lang.String title,
                     java.util.Locale locale)
Creates FavoritesItem.
Parameters:
name - The name of item
target - The target of item
url - The external representation of url
title - The title of the HelpSet
locale - The Locale of this item

setVisible

public void setVisible(boolean visible)

isVisible

public boolean isVisible()

getTarget

public java.lang.String getTarget()
Returns the id for this item.

getURLSpec

public java.lang.String getURLSpec()
Returns the external representation of url for this item.

getURL

public java.net.URL getURL()
Return the URL for this item
Overrides:
getURL in class TreeItem

getHelpSetTitle

public java.lang.String getHelpSetTitle()
Returns the title of HelpSet

setAsFolder

public void setAsFolder()
Sets this item as folder.

allowsChildren

public boolean allowsChildren()
Returns wheter item allows children or not

isLeaf

public boolean isLeaf()
Returns whether or not this item is leaf

isFolder

public boolean isFolder()
Returns whether or not this item is folder.

add

public void add(FavoritesItem item)
Adds FavoritesItem as a child.
Parameters:
item - The FavoritesItem.

emptyInitState

public boolean emptyInitState()
Returns true if item was initialized as empty

remove

public void remove(FavoritesItem item)
Removes FavoritesItem from vector of children.
Parameters:
item - The FavoritesItem to remove.

getParent

public FavoritesItem getParent()
Returns parent of FavoritesItem.

setParent

public void setParent(FavoritesItem parent)
Sets the parent of this item.
Parameters:
parent - The FavoritesItem.

getChildren

public java.util.Vector getChildren()
Returns children of this FavoritesItem.

clone

public java.lang.Object clone()
Overrides:
clone in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class TreeItem

getTransferData

public java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor df) throws java.awt.datatransfer.UnsupportedFlavorException, java.io.IOException
Returns an object which represents the data to be transferred.
Implements:
getTransferData in interface java.awt.datatransfer.Transferable

getTransferDataFlavors

public java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()
Returns an array of DataFlavor objects indicating the flavors the data can be provided in.
Implements:
getTransferDataFlavors in interface java.awt.datatransfer.Transferable

isDataFlavorSupported

public boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor df)
Returns whether or not the specified data flavor is supported for this object.
Implements:
isDataFlavorSupported in interface java.awt.datatransfer.Transferable