KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > fr > improve > struts > taglib > layout > util > TreeviewInterface


1 /*
2  * Created on 22 mars 2004
3  *
4  * Copyright Improve SA 2004.
5  * All rights reserved.
6  */

7 package fr.improve.struts.taglib.layout.util;
8 import javax.servlet.ServletContext JavaDoc;
9 import javax.servlet.http.HttpServletRequest JavaDoc;
10 import javax.servlet.jsp.JspException JavaDoc;
11
12 import fr.improve.struts.taglib.layout.menu.MenuComponent;
13 import fr.improve.struts.taglib.layout.treeview.TreeItemInfo;
14
15 /**
16  * This interface defines the API to render a treeview.
17  * @author jnribette
18  */

19 public interface TreeviewInterface {
20     
21     /**
22      * Starts an item row.
23      */

24     public abstract void startRow(StringBuffer JavaDoc buffer);
25     
26     /**
27      * Display the tree images in a TD.
28      */

29     public abstract void renderTree(StringBuffer JavaDoc buffer, HttpServletRequest JavaDoc in_request, TreeItemInfo in_info);
30     
31     /**
32      * If the item has subitems, starts a sub menu.
33      */

34     public abstract void startSubMenu(StringBuffer JavaDoc buffer);
35     
36     /**
37      * Render the item icon.
38      */

39     public abstract void renderIcon(StringBuffer JavaDoc buffer, TreeItemInfo in_info, MenuComponent in_item);
40     
41     /**
42      * Starts the TD that contains the item image and title.
43      */

44     public abstract void startLabel(StringBuffer JavaDoc buffer, String JavaDoc in_styleClass, String JavaDoc onclick, String JavaDoc style);
45     
46     /**
47      * Renders the image associated to the item.
48      */

49     public abstract void renderImage(StringBuffer JavaDoc buffer, HttpServletRequest JavaDoc in_request, TreeItemInfo in_info, MenuComponent in_item);
50     
51     /**
52      * Renders in the buffer the title of the item. If a location is associated to the item, the title
53      * is rendered inside a link element.
54      */

55     public abstract void renderLabel(StringBuffer JavaDoc buffer,
56             HttpServletRequest JavaDoc in_request, ServletContext JavaDoc in_servletcontext,
57             TreeItemInfo in_info, MenuComponent in_item) throws JspException JavaDoc;
58     
59     /**
60      * Ends the TD that contains the item image and title.
61      */

62     public abstract void endLabel(StringBuffer JavaDoc buffer);
63
64     /**
65      * Render the actions of the item.
66      */

67     public abstract void renderActions(StringBuffer JavaDoc buffer, HttpServletRequest JavaDoc in_request, ServletContext JavaDoc in_context, TreeItemInfo lc_info, MenuComponent item) throws JspException JavaDoc;
68     
69     
70     public abstract int endSubMenu(StringBuffer JavaDoc buffer,
71             HttpServletRequest JavaDoc in_request, ServletContext JavaDoc in_servletcontext,
72             int lc_numberOfMenusPrinted, MenuComponent menu,
73             TreeItemInfo in_info) throws JspException JavaDoc;
74     
75     /**
76      * Ends an item row.
77      */

78     public abstract void endRow(StringBuffer JavaDoc buffer);
79     
80     
81     /**
82      * Compute the new styleClass:
83      * If the styleClass ends with a digit, increment the digit by one.
84      */

85     public abstract String JavaDoc computeStyleClass(String JavaDoc in_styleClass);
86
87 }
Popular Tags