org.nasdanika.html.jstree.JsTreeNode Maven / Gradle / Ivy

Go to download
package org.nasdanika.html.jstree;

import java.util.List;
import java.util.function.Predicate;

import org.json.JSONObject;

/**
 * This interface can be used to build JsTree JSON data. ``toString()`` method of the implementation outputs JSON.
 * @author Pavel Vlasov
 *
 */
public interface JsTreeNode {
	
	default JsTreeNode opened() {
		return opened(true);
	}
	
	JsTreeNode opened(boolean opened);
	
	default JsTreeNode selected() {
		return selected(true);
	}
	
	JsTreeNode selected(boolean selected);
	
	default JsTreeNode disabled() {
		return disabled(true);
	}
	
	JsTreeNode disabled(boolean disabled);
	
	/**
	 * Sets icon - image URL or (glyph) icon class.
	 * @param icon
	 * @return
	 */
	JsTreeNode icon(String icon);	
	
	/**
	 * Used to traverse the tree and collect values.
	 * @author Pavel Vlasov
	 *
	 * @param 
	 */
	interface Collector {
		
		R visit(JsTreeNode node, List childResults);
		
	}
	
	 R accept(Collector collector);
	
	JsTreeNode id(Object id);
	
	Object getId();
	
	JsTreeNode text(Object text);
	
	List children();
	
	/**
	 * Creates a new node and adds to the list of children.
	 * @return
	 */
	JsTreeNode createChild();

	/**
	 * Attribute for the generated LI node.
	 * @param name
	 * @param value
	 * @return
	 */
	JsTreeNode listItemAttribute(String name, Object value);

	/**
	 * Set custom Attribute/property of the JsTree JSON object.
	 * @param name
	 * @param value
	 * @return
	 */
	JsTreeNode attribute(String name, Object value);
	
	/**
	 * Attribute for the generated A node.
	 * @param name
	 * @param value
	 * @return
	 */
	JsTreeNode anchorAttribute(String name, Object value);
	
	JSONObject toJSON();
	
	/**
	 * Outputs to JSON only nodes which match the predicate or contain children matching the predicate.
	 * @param filter predicate or null.
	 * @return JSON object or null if there is no match.
	 */
	JSONObject toJSON(Predicate filter);	
	
	/**
	 * Sets the application defined node data. This data is not used for rendering.
	 * Applications may put arbitrary objects in this field. 
	 * @param data
	 * @return this UI element.
	 */
	JsTreeNode setData(Object data);
	
	/**
	 * Returns the application defined node data, or null if it has not been set. 
	 * @return
	 */
	Object getData();
	
	/**
	 * Sets the application defined property of the node with the specified name to the given value.
	 * Applications may associate arbitrary objects with nodes. This data is not used for rendering.
	 * @param key
	 * @param data
	 * @return this UI element.
	 */
	JsTreeNode setData(Object key, Object data);
	
	/**
	 * If this method is invoked and children collection is empty then toJSON outputs children:true, which can be used in Ajax lazy loading.
	 * @return
	 */
	JsTreeNode hasChildren();
	
	/**
	 * Returns the application defined property of the node with the specified name, or null if it has not been set.
	 * @param Key
	 * @return
	 */
	Object getData(Object key);
	
	
}