javax.help.JHelpFavoritesNavigator Maven / Gradle / Ivy
/*
* @(#)JHelpFavoritesNavigator.java 1.4 06/10/30
*
* Copyright (c) 2006 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* CA 95054 USA or visit www.sun.com if you need additional information or
* have any questions.
*/
package javax.help;
import java.net.URL;
import javax.swing.event.ChangeListener;
import javax.swing.event.ChangeEvent;
import javax.swing.Action;
/**
* JHelpFavoritesNavigator is a JHelpNavigator for Favorites.
*
* All the tree navigation and selection has been delegated to the UI
* where the JTree is created.
*
* @author Richard Gregor
* @version 1.4 10/30/06
*/
public class JHelpFavoritesNavigator extends JHelpNavigator {
/**
* Creates an Index navigator.
*
* @param view The NavigatorView
*/
public JHelpFavoritesNavigator(NavigatorView view) {
super(view, null);
}
/**
* Creates a Index navigator.
*
* @param view The NavigatorView.
* @param model The model for the Navigator.
*/
public JHelpFavoritesNavigator(NavigatorView view, HelpModel model) {
super(view, model);
}
// HERE - label & Locale?
// HERE - URL data vs Hashtable?
/**
* Creates an Index navigator with explicit arguments. Note that this should not throw
* an InvalidNavigatorViewException since we are implicitly passing the type.
*
* @param hs HelpSet
* @param name The name identifying this HelpSet.
* @param label The label to use (for this locale).
* @param data The "data" part of the parameters, a URL location of the TOC data.
*/
public JHelpFavoritesNavigator(HelpSet hs,
String name, String label, URL data)
throws InvalidNavigatorViewException {
super(new FavoritesView(hs, name, label, createParams(data)));
}
/**
* Gets the UID for this JComponent.
*/
public String getUIClassID() {
return "HelpFavoritesNavigatorUI";
}
/**
* Determines if this instance of a JHelpNavigator can merge its data with another one.
*
* @param view The data to merge
* @return Whether it can be merged
*
* @see merge(NavigatorView)
* @see remove(NavigatorView)
*/
public boolean canMerge(NavigatorView view) {
return false;
}
/**
* Sets state of navigation entry for given target to expanded. Non-empty entry is expanded. Empty entry is visible.
*
* @param target The target to expand
*/
public void expandID(String target){
firePropertyChange("expand"," ",target);
}
/**
* Sets state of navigation entry for given target to collapsed if entry is visible. Parent is collapsed if entry is empty.
*
* @param target The target to collapse
*/
public void collapseID(String target){
firePropertyChange("collapse"," ",target);
}
/**
* Returns an AddAction object for this navigator
*
*/
public Action getAddAction(){
return this.getUI().getAddAction();
}
private static final boolean debug = false;
private static void debug(String msg) {
if (debug) {
System.err.println("JHelpIndexNavigator: "+msg);
}
}
}