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 label values as markup into DOM elements.
20: *
21: * @author Jose Maria Arranz Santamaria
22: * @see ItsNatComponentManager#createDefaultItsNatLabelRenderer()
23: * @see ItsNatLabel#getItsNatLabelRenderer()
24: * @see ItsNatLabel#setItsNatLabelRenderer(ItsNatLabelRenderer)
25: */
26: public interface ItsNatLabelRenderer {
27: /**
28: * Renders as markup the specified 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: * @param label the label component, may be used to provide contextual information. Default implementation ignores it.
34: * @param value the value to render.
35: * @param labelElem the label element to render the value into. Is a hint, if provided should be obtained by calling {@link ItsNatLabel#getElement()}.
36: * @param isNew true if this is the first time the markup is rendered. Default implementation ignores this parameter.
37: */
38: public void renderLabel(ItsNatLabel label, Object value,
39: Element labelElem, boolean isNew);
40:
41: /**
42: * Unrenders the label markup. This method is called <i>before</i> the markup
43: * is removed.
44: *
45: * <p>Default implementation does nothing.</p>
46: *
47: * @param label the label component, may be used to provide contextual information. Default implementation ignores it.
48: * @param labelElem the label element to render the value into. Is a hint, if provided should be obtained by calling {@link ItsNatLabel#getElement()}.
49: */
50: public void unrenderLabel(ItsNatLabel label, Element labelElem);
51: }
|