Package javax.help
Class FavoritesItem
java.lang.Object
javax.help.TreeItem
javax.help.FavoritesItem
- All Implemented Interfaces:
Transferable
,Serializable
A class for individual favorites items.
- See Also:
-
Field Summary
FieldsFields inherited from class javax.help.TreeItem
COLLAPSE, DEFAULT_EXPANSION, EXPAND, locale
-
Constructor Summary
ConstructorsConstructorDescriptionCreates empty itemFavoritesItem
(String name) Creates item with nameCreates FavoritesItem. -
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(FavoritesItem item) Adds FavoritesItem as a child.boolean
Returns wheter item allows children or notclone()
boolean
Returns true if item was initialized as emptyReturns children of this FavoritesItem.Returns the title of HelpSetReturns parent of FavoritesItem.Returns the id for this item.Returns an object which represents the data to be transferred.Returns an array of DataFlavor objects indicating the flavors the data can be provided in.getURL()
Return the URL for this itemReturns the external representation of url for this item.boolean
Returns whether or not the specified data flavor is supported for this object.boolean
isFolder()
Returns whether or not this item is folder.boolean
isLeaf()
Returns whether or not this item is leafboolean
void
remove
(FavoritesItem item) Removes FavoritesItem from vector of children.void
Sets this item as folder.void
setParent
(FavoritesItem parent) Sets the parent of this item.void
setVisible
(boolean visible) toString()
Returns a String used when displaying the object.Methods inherited from class javax.help.TreeItem
getExpansionType, getHelpSet, getID, getLocale, getMergeType, getName, getPresentation, getPresentationName, setExpansionType, setHelpSet, setID, setMergeType, setName, setPresentation, setPresentationName
-
Field Details
-
FAVORITES_FLAVOR
-
-
Constructor Details
-
FavoritesItem
Creates item with name- Parameters:
name
- The name of item
-
FavoritesItem
public FavoritesItem()Creates empty item -
FavoritesItem
Creates FavoritesItem.- Parameters:
name
- The name of itemtarget
- The target of itemurl
- The external representation of urltitle
- The title of the HelpSetlocale
- The Locale of this item
-
-
Method Details
-
setVisible
public void setVisible(boolean visible) -
isVisible
public boolean isVisible() -
getTarget
Returns the id for this item. -
getURLSpec
Returns the external representation of url for this item. -
getURL
Return the URL for this item -
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
Adds FavoritesItem as a child.- Parameters:
item
- The FavoritesItem.
-
emptyInitState
public boolean emptyInitState()Returns true if item was initialized as empty -
remove
Removes FavoritesItem from vector of children.- Parameters:
item
- The FavoritesItem to remove.
-
getParent
Returns parent of FavoritesItem. -
setParent
Sets the parent of this item.- Parameters:
parent
- The FavoritesItem.
-
getChildren
Returns children of this FavoritesItem. -
clone
-
toString
Description copied from class:TreeItem
Returns a String used when displaying the object. Used by CellRenderers. -
getTransferData
Returns an object which represents the data to be transferred.- Specified by:
getTransferData
in interfaceTransferable
- Throws:
UnsupportedFlavorException
IOException
-
getTransferDataFlavors
Returns an array of DataFlavor objects indicating the flavors the data can be provided in.- Specified by:
getTransferDataFlavors
in interfaceTransferable
-
isDataFlavorSupported
Returns whether or not the specified data flavor is supported for this object.- Specified by:
isDataFlavorSupported
in interfaceTransferable
-