01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package com.sun.rave.designtime.markup;
43:
44: import org.w3c.dom.DocumentFragment;
45: import org.w3c.dom.Element;
46:
47: /**
48: * <P>A MarkupRenderContext represents the context in which a markup bean will be rendering its
49: * markup output. This is a call-back interface used in the MarkupDesignInfo.customizeRender(...)
50: * method. A component (bean) author can use the methods in this interface to alter the markup
51: * stream that will be displayed on the design surface. They can also associate custom behavior
52: * with portions of markup using the associateMouseRegion(...) method.</P>
53: *
54: * <P><B>IMPLEMENTED BY CREATOR</B> - This interface is implemented by Creator for use by the
55: * component (bean) author.</P>
56: *
57: * @author Joe Nuxoll
58: * @version 1.0
59: * @see MarkupDesignInfo#customizeRender(MarkupDesignBean, MarkupRenderContext)
60: */
61: public interface MarkupRenderContext {
62:
63: /**
64: * The 'rendered' DOM document fragment from the JSF component.
65: */
66: public DocumentFragment getDocumentFragment();
67:
68: /**
69: * The starting position within the renderFragment from where nodes were rendered for this
70: * component.
71: */
72: public MarkupPosition getBeginPosition();
73:
74: /**
75: * The ending position within the renderFragment to which nodes were rendered for this
76: * component. If this position is the same as begin, no nodes were rendered for the component.
77: * Note that the end position is NOT inclusive, it points to the NEXT node in the node list.
78: * Note also that the parent node for begin and end will always be the same.
79: */
80: public MarkupPosition getEndPosition();
81:
82: /**
83: * Associates a mouse region with a particular element of rendered markup.
84: *
85: * @param element Element
86: * @param region MarkupMouseRegion
87: */
88: public void associateMouseRegion(Element element,
89: MarkupMouseRegion region);
90: }
|