Source Code Cross Referenced for MarkupDesignInfo.java in  » IDE-Netbeans » visualweb.api.designer » com » sun » rave » designtime » markup » Java Source Code / Java DocumentationJava Source Code and Java Documentation

001:        /*
002:         * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003:         *
004:         * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005:         *
006:         * The contents of this file are subject to the terms of either the GNU
007:         * General Public License Version 2 only ("GPL") or the Common
008:         * Development and Distribution License("CDDL") (collectively, the
009:         * "License"). You may not use this file except in compliance with the
010:         * License. You can obtain a copy of the License at
011:         * http://www.netbeans.org/cddl-gplv2.html
012:         * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013:         * specific language governing permissions and limitations under the
014:         * License.  When distributing the software, include this License Header
015:         * Notice in each file and include the License file at
016:         * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
017:         * particular file as subject to the "Classpath" exception as provided
018:         * by Sun in the GPL Version 2 section of the License file that
019:         * accompanied this code. If applicable, add the following below the
020:         * License Header, with the fields enclosed by brackets [] replaced by
021:         * your own identifying information:
022:         * "Portions Copyrighted [year] [name of copyright owner]"
023:         *
024:         * Contributor(s):
025:         *
026:         * The Original Software is NetBeans. The Initial Developer of the Original
027:         * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028:         * Microsystems, Inc. All Rights Reserved.
029:         *
030:         * If you wish your version of this file to be governed by only the CDDL
031:         * or only the GPL Version 2, indicate your decision by adding
032:         * "[Contributor] elects to include this software in this distribution
033:         * under the [CDDL or GPL Version 2] license." If you do not indicate a
034:         * single choice of license, a recipient has the option to distribute
035:         * your version of this file under either the CDDL, the GPL Version 2 or
036:         * to extend the choice of license to its licensees as provided above.
037:         * However, if you add GPL Version 2 code and therefore, elected the GPL
038:         * Version 2 license, then the option applies only if the new code is
039:         * made subject to such option by the copyright holder.
040:         */
041:
042:        package com.sun.rave.designtime.markup;
043:
044:        import com.sun.rave.designtime.DesignInfo;
045:
046:        /**
047:         * <P>The MarkupDesignInfo interface is an extension of the DesignInfo interface that adds the
048:         * ability to annotate the render stream of a markup element for design-time, and provide clickable
049:         * sub-regions and context items within the visual markup element.</P>
050:         *
051:         * <P><B>IMPLEMENTED BY THE COMPONENT AUTHOR</B> - This interface is designed to be implemented by
052:         * the component (bean) author.</P>
053:         *
054:         * @author Joe Nuxoll
055:         * @version 1.0
056:         * @see DesignInfo
057:         */
058:        public interface MarkupDesignInfo extends DesignInfo {
059:
060:            /**
061:             * <p>This method is called <b>after</b> a JSF component has been invoked to render itself
062:             * in design-mode, and just <b>before</b> the rendered markup is displayed on the designer
063:             * surface.  The component author may use this hook to modify the design-time rendered content
064:             * for the given component.  They can also associate elements with MarkupMouseRegion
065:             * objects.</p>
066:             *
067:             * <p>For example, the following markup might be emitted when a JSF component is rendered:</p>
068:             *
069:             * <p><pre>
070:             * &lt;table border=&quot;1&quot;&gt;
071:             *   &lt;tr&gt;
072:             *     &lt;th&gt;Name&lt;/th&gt;
073:             *     &lt;th&gt;Address&lt;/th&gt;
074:             *     &lt;th&gt;Phone&lt;/th&gt;
075:             *   &lt;/tr&gt;
076:             *   &lt;tr&gt;
077:             *     &lt;td&gt;John Smith&lt;/td&gt;
078:             *     &lt;td&gt;100 Milky Way&lt;/td&gt;
079:             *     &lt;td&gt;555-1212&lt;/td&gt;
080:             *   &lt;/tr&gt;
081:             *   &lt;tr&gt;
082:             *     &lt;td&gt;Luke Johnson&lt;/td&gt;
083:             *     &lt;td&gt;200 Super Drive&lt;/td&gt;
084:             *     &lt;td&gt;911-1234&lt;/td&gt;
085:             *   &lt;/tr&gt;
086:             *   &lt;tr&gt;
087:             *     &lt;td&gt;Gary Raddo&lt;/td&gt;
088:             *     &lt;td&gt;747 Airport Way&lt;/td&gt;
089:             *     &lt;td&gt;277-9473&lt;/td&gt;
090:             *   &lt;/tr&gt;
091:             * &lt;/table&gt;
092:             * </pre></p>
093:             *
094:             * <p>This markup is parsed into a DOM DocumentFragment, and passed to the 'customizeRender'
095:             * method along with the instance of the DesignBean that rendered it.  The resultant DOM
096:             * DocumentFragment might look like this:</p>
097:             *
098:             * <p><pre>
099:             * &lt;table border=&quot;1&quot;&gt;
100:             *   &lt;tr&gt;
101:             *     &lt;th&gt;Name [CUSTOMER.NAME]&lt;/th&gt;
102:             *     &lt;th&gt;Address [CUSTOMER.ADDRESS]&lt;/th&gt;
103:             *     &lt;th&gt;Phone [CUSTOMER.PHONE]&lt;/th&gt;
104:             *   &lt;/tr&gt;
105:             *   &lt;tr&gt;
106:             *     &lt;td&gt;John Smith&lt;/td&gt;
107:             *     &lt;td&gt;100 Milky Way&lt;/td&gt;
108:             *     &lt;td&gt;555-1212&lt;/td&gt;
109:             *   &lt;/tr&gt;
110:             *   &lt;tr&gt;
111:             *     &lt;td&gt;Luke Johnson&lt;/td&gt;
112:             *     &lt;td&gt;200 Super Drive&lt;/td&gt;
113:             *     &lt;td&gt;911-1234&lt;/td&gt;
114:             *   &lt;/tr&gt;
115:             *   &lt;tr&gt;
116:             *     &lt;td&gt;Gary Raddo&lt;/td&gt;
117:             *     &lt;td&gt;747 Airport Way&lt;/td&gt;
118:             *     &lt;td&gt;277-9473&lt;/td&gt;
119:             *   &lt;/tr&gt;
120:             * &lt;/table&gt;
121:             * </pre></p>
122:             *
123:             * <p>This annotated markup stream would be passed to the designer, where it would be displayed
124:             * as an instance of an HTML table (in this example).  The component author may have also
125:             * 'hooked' the markup elements to instances of MarkupMouseRegion via the
126:             * 'MarkupRenderContext.associateMouseRegion' method.</p>
127:             *
128:             * @param designBean The MarkupDesignBean about to be displayed on the design surface
129:             * @param renderContext The context (including rendered content) representing this component's
130:             *        markup output
131:             */
132:            public void customizeRender(MarkupDesignBean designBean,
133:                    MarkupRenderContext renderContext);
134:        }