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 java.util.Map;
45: import java.awt.Image;
46: import com.sun.rave.designtime.DesignContext;
47:
48: /**
49: * The MarkupDesignContext is an extension to the DesignContext interface that adds markup-specific
50: * functionality. This adds methods for previewing CSS style changes at design-time. A
51: * MarkupDesignContext can be accessed by calling the DesignBean.getDesignContext() method and
52: * testing the returned DesignContext for 'instanceof' MarkupDesignContext. If the file being
53: * designed is a markup backing file (eg: *.jsp), the DesignContext will be an instanceof
54: * MarkupDesignContext.
55: *
56: * <P><B>IMPLEMENTED BY CREATOR</B> - This interface is implemented by Creator for use by the
57: * component (bean) author.</P>
58: *
59: * @author Joe Nuxoll
60: * @version 1.0
61: * @see DesignContext
62: * @see com.sun.rave.designtime.DesignBean#getDesignContext()
63: */
64: public interface MarkupDesignContext extends DesignContext {
65:
66: /**
67: * Generates and returns a preview image (sized width x height) of the specified MarkupDesignBean
68: * after applying the specified CSS styles and style classes to the rendered markup.
69: *
70: * @param cssStyle The CSS style string to apply to the rendered markup from the
71: * MarkupDesignBean
72: * @param cssStyleClasses The CSS style classes to apply to the rendered markup from the
73: * MarkupDesignBean
74: * @param designBean The MarkupDesignBean to render the image of
75: * @param width The desired width of the resulting image (in pixels)
76: * @param height The desired height of the resulting image (in pixels)
77: * @return The generated Image representing the MarkupDesignBean render output with the applied
78: * styles
79: */
80: public Image getCssPreviewImage(String cssStyle,
81: String[] cssStyleClasses, MarkupDesignBean designBean,
82: int width, int height);
83:
84: /**
85: * Converts a CSS inline style string into a Map of style elements
86: *
87: * @param cssStyle The CSS inline style string to convert
88: * @return A Map containing the parsed CSS styles
89: */
90: public Map convertCssStyleToMap(String cssStyle);
91:
92: /**
93: * Converts a Map of CSS styles into an inline CSS style string
94: *
95: * @param cssStyleMap The Map of CSS styles to convert
96: * @return An inline CSS style string
97: */
98: public String convertMapToCssStyle(Map cssStyleMap);
99: }
|