Class javax.help.JHelpFavoritesNavigator

java.lang.Object
    |
    +----java.awt.Component
            |
            +----java.awt.Container
                    |
                    +----javax.swing.JComponent
                            |
                            +----javax.help.JHelpNavigator
                                    |
                                    +----javax.help.JHelpFavoritesNavigator

public class JHelpFavoritesNavigator
extends JHelpNavigator
JHelpFavoritesNavigator is a JHelpNavigator for Favorites. All the tree navigation and selection has been delegated to the UI where the JTree is created.


JHelpFavoritesNavigator

public JHelpFavoritesNavigator(NavigatorView view)
Creates an Index navigator.
Parameters:
view - The NavigatorView

JHelpFavoritesNavigator

public JHelpFavoritesNavigator(NavigatorView view,
                               HelpModel model)
Creates a Index navigator.
Parameters:
view - The NavigatorView.
model - The model for the Navigator.

JHelpFavoritesNavigator

public JHelpFavoritesNavigator(HelpSet hs,
                               java.lang.String name,
                               java.lang.String label,
                               java.net.URL data) throws InvalidNavigatorViewException
Creates an Index navigator with explicit arguments. Note that this should not throw an InvalidNavigatorViewException since we are implicitly passing the type.
Parameters:
hs - HelpSet
name - The name identifying this HelpSet.
label - The label to use (for this locale).
data - The "data" part of the parameters, a URL location of the TOC data.

getUIClassID

public java.lang.String getUIClassID()
Gets the UID for this JComponent.
Overrides:
getUIClassID in class JHelpNavigator

canMerge

public boolean canMerge(NavigatorView view)
Determines if this instance of a JHelpNavigator can merge its data with another one.
Parameters:
view - The data to merge
Returns:
Whether it can be merged
Overrides:
canMerge in class JHelpNavigator
See Also:
merge(NavigatorView), remove(NavigatorView)

expandID

public void expandID(java.lang.String target)
Sets state of navigation entry for given target to expanded. Non-empty entry is expanded. Empty entry is visible.
Parameters:
target - The target to expand

collapseID

public void collapseID(java.lang.String target)
Sets state of navigation entry for given target to collapsed if entry is visible. Parent is collapsed if entry is empty.
Parameters:
target - The target to collapse

getAddAction

public javax.swing.Action getAddAction()
Returns an AddAction object for this navigator