01: /*
02: ItsNat Java Web Application Framework
03: Copyright (C) 2007 Innowhere Software Services S.L., Spanish Company
04: Author: Jose Maria Arranz Santamaria
05:
06: This program is free software: you can redistribute it and/or modify
07: it under the terms of the GNU Affero General Public License as published by
08: the Free Software Foundation, either version 3 of the License, or
09: (at your option) any later version. See the GNU Affero General Public
10: License for more details. See the copy of the GNU Affero General Public License
11: included in this program. If not, see <http://www.gnu.org/licenses/>.
12: */
13:
14: package org.itsnat.comp;
15:
16: import org.w3c.dom.Element;
17:
18: /**
19: * Is used to render list item values as markup into DOM elements.
20: *
21: * @author Jose Maria Arranz Santamaria
22: * @see ItsNatComponentManager#createDefaultItsNatListCellRenderer()
23: * @see ItsNatList#getItsNatListCellRenderer()
24: * @see ItsNatList#setItsNatListCellRenderer(ItsNatListCellRenderer)
25: */
26: public interface ItsNatListCellRenderer {
27: /**
28: * Renders as markup the specified list item value into the specified element, usually
29: * as a text node.
30: *
31: * <p>Default implementation delegates to the default {@link org.itsnat.core.domutil.ElementRenderer}.</p>
32: *
33: * <p>Default implementation ignores <code>isSelected</code> and <code>hasFocus</code>
34: * (current implementation of ItsNat lists does not handle focus on list items, ever is false).</p>
35: *
36: * @param list the list component, may be used to provide contextual information. Default implementation ignores it.
37: * @param index the list item index.
38: * @param value the value to render.
39: * @param isSelected true if the list item is selected.
40: * @param hasFocus true if the list item has the focus.
41: * @param cellContentElem the list item content element to render the value into. Is a hint, if provided should be obtained by calling <code>list.getItsNatListUI().getContentElementAt(index)</code>.
42: * @param isNew true if this is the first time the markup is rendered. Default implementation ignores this parameter.
43: */
44: public void renderListCell(ItsNatList list, int index,
45: Object value, boolean isSelected, boolean hasFocus,
46: Element cellContentElem, boolean isNew);
47:
48: /**
49: * Unrenders the markup of the specified list item. This method is called <i>before</i> the markup
50: * is removed.
51: *
52: * <p>Default implementation does nothing.</p>
53: *
54: * @param list the list component, may be used to provide contextual information. Default implementation ignores it.
55: * @param index the list item index.
56: * @param cellContentElem the list item content element to render the value into. Is a hint, if provided should be obtained by calling <code>list.getItsNatListUI().getContentElementAt(index)</code>.
57: */
58: public void unrenderListCell(ItsNatList list, int index,
59: Element cellContentElem);
60: }
|