www.pudn.com > jsptree-1.0-b6-src.zip > JSPTreeNode.java

/* 
 * ==================================================================== 
 * The JSP Tree Software License, Version 1.1 
 * 
 * (this license is derived and fully compatible with the Apache Software 
 * License - see http://www.apache.org/LICENSE.txt) 
 * 
 * Copyright (c) 2002-2005 jsptree.sourceforge.net . All rights reserved. 
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions 
 * are met: 
 * 
 * 1. Redistributions of source code must retain the above copyright 
 *    notice, this list of conditions and the following disclaimer. 
 * 
 * 2. Redistributions in binary form must reproduce the above copyright 
 *    notice, this list of conditions and the following disclaimer in 
 *    the documentation and/or other materials provided with the 
 *    distribution. 
 * 
 * 3. The end-user documentation included with the redistribution, 
 *    if any, must include the following acknowledgment: 
 *       "This product includes software developed by 
 *        jsptree.sourceforge.net (http://jsptree.sourceforge.net/)." 
 *    Alternately, this acknowledgment may appear in the software itself, 
 *    if and wherever such third-party acknowledgments normally appear. 
 * 
 * 4. The name "JSP Tree" must not be used to endorse or promote 
 *    products derived from this software without prior written permission. 
 *    For written permission, please contact modano@users.sourceforge.net . 
 * 
 * 5. Products derived from this software may not be called "JSP Tree", 
 *    nor may "JSP Tree" appear in their name, without prior written 
 *    permission of jsptree.sourceforge.net. 
 * 
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
 * SUCH DAMAGE. 
 * ==================================================================== 
 */ 
 
package net.sf.jsptree.component; 
 
import java.util.Map; 
 
/** 
 * Represents tree data object interface that is responsible for 
 * providing tree renderers with comprehensive informatotion about nodes' 
 * presentation data. The classes which implements this interface can be kept 
 * in {@link net.sf.jsptree.tree.TreeNode} instances. 
 * 
 * @author Vladislav Kamensky 
 */ 
public interface JSPTreeNode extends Cloneable { 
 
    /** 
     * Returns ID of this node. 
     */ 
    String getId(); 
 
    /** 
     * Returns http reference of this node. 
     */ 
    String getHref(); 
 
    /** 
     * Whether {@link #getHref} method returns context 
     * relative reference or not. 
     * 
     * @return true if http reference is context 
     *         relative; otherwise false 
     */ 
    boolean isContextRelative(); 
 
    /** 
     * Returns target page where node's http reference 
     * should be opened. 
     */ 
    String getTarget(); 
 
    /** 
     * Returns label, which should be 
     * displayed at this node in user's Browser. 
     */ 
    String getLabel(); 
 
    /** 
     * Returns custom skin name. If it is not specified 
     * then node is rendered with the help of tree's renderer. 
     */ 
    String getSkinName(); 
 
    /** 
     * Returns custom properties being assigned to this object 
     * in the "name-value" pairs format. 
     */ 
    Map getValues(); 
 
    /** 
     * Creates and returns a copy of this object. 
     * 
     * @throws CloneNotSupportedException 
     */ 
    Object clone() throws CloneNotSupportedException; 
}