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.faces;
043:
044: import javax.faces.context.FacesContext;
045: import com.sun.rave.designtime.DesignBean;
046: import com.sun.rave.designtime.markup.MarkupDesignContext;
047:
048: /**
049: * The FacesDesignContext is an extension to the DesignContext interface (and MarkupDesignContext
050: * interface) that adds JSF-specific functionality. This adds methods for creating new facets and
051: * handling value reference expressions at design-time. A FacesDesignContext can be accessed by
052: * calling the DesignBean.getDesignContext() method and testing the returned DesignContext for
053: * 'instanceof' FacesDesignContext. If the file being designed is a JSF-specific backing file
054: * (eg Page1.jsp + Page1.java), the DesignContext will be an instanceof FacesDesignContext.
055: *
056: * <P><B>IMPLEMENTED BY CREATOR</B> - This interface is implemented by Creator for use by the
057: * component (bean) author.</P>
058: *
059: * @author Joe Nuxoll
060: * @version 1.0
061: * @see DesignContext
062: * @see DesignBean#getDesignContext()
063: */
064: public interface FacesDesignContext extends MarkupDesignContext {
065:
066: /**
067: * Returns the reference name to use in EL expressions to refer to this FacesDesignContext.
068: *
069: * @return The String to use as a reference name (in JSF EL)
070: */
071: public String getReferenceName();
072:
073: /**
074: * Checks if a facet child of type 'facet' using a component of type 'type' on the faces
075: * bean 'parent' can be created. This method should be called as a test before a call to
076: * createFacet.
077: *
078: * @param facetName The desired facet name to create
079: * @param type The desired component type to create as a facet
080: * @param parent The desired parent component to create a facet in
081: * @return <code>true</code> if the creation of this facet would be successful, or
082: * <code>false</code> if not
083: * @see createFacet(String, String, DesignBean)
084: */
085: public boolean canCreateFacet(String facetName, String type,
086: DesignBean parent);
087:
088: /**
089: * Creates a facet child of type 'facet' using a component of type 'type' on the faces
090: * bean 'parent'. Before this method is called, a test call should be made to canCreateFacet.
091: *
092: * @param facetName The desired facet name to create
093: * @param type The desired component type to create as a facet
094: * @param parent The desired parent component to create a facet in
095: * @return The resulting DesignBean representing the new facet
096: * @see canCreateFacet(String, String, DesignBean)
097: */
098: public DesignBean createFacet(String facetName, String type,
099: DesignBean parent);
100:
101: /**
102: * Returns whether a binding expression can be created to point to 'toBean'
103: *
104: * @param toBean the 'target' bean to create a value expression to point to
105: * @return <code>true</code> if a binding expression can be created to point to 'toBean',
106: * <code>false</code> if not
107: */
108: public boolean isValidBindingTarget(DesignBean toBean);
109:
110: /**
111: * Returns a valid reference expression "#{...}" value to point to 'toBean'
112: *
113: * @param toBean the 'target' bean to create a value expression to point to
114: * @return A valid reference expression pointing to 'toBean'
115: */
116: public String getBindingExpr(DesignBean toBean);
117:
118: /**
119: * Returns a valid binding expression "#{...}" value to point to 'toBean' plus the sub-
120: * expression inside of toBean. For example, toBean might be button2 on Page1, and the
121: * desired expression might be to get the value of button2. The call would then be
122: * getReferenceExpr(button2, "value") --> "#{Page1.button2.value}"
123: *
124: * @param toBean the 'target' bean to create a value expression to point to
125: * @param subExpr An optional sub-expression
126: * @return A valid reference expression pointing to 'toBean' plus the specified sub-expression
127: */
128: public String getBindingExpr(DesignBean toBean, String subExpr);
129:
130: /**
131: * Returns the live instance Object (not DesignBean) that the reference expression resolves to
132: * (at the moment called)
133: *
134: * @param expr The EL reference expression to evaluate
135: * @return the live instance Object (not DesignBean) that the reference expression resolves to
136: */
137: public Object resolveBindingExpr(String expr);
138:
139: /**
140: * Returns a result that is resolved to the last DesignBean that can be found, plus the
141: * remaining un-resolvable string (at least doesn't resolve to a DesignBean)
142: *
143: * @param expr The EL reference expression to evaluate
144: * @return A ResolveResult, which includes the deepest DesignBean that could be resolved, plus
145: * the remainder of the EL expression that could not be resolved to a DesignBean
146: */
147: public ResolveResult resolveBindingExprToBean(String expr);
148:
149: /**
150: * Returns the FacesContext that can be used by component designers to retrieve design-time
151: * Faces information.
152: *
153: * @return The 'runtime' FacesContext running at design-time
154: */
155: public FacesContext getFacesContext();
156: }
|