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: package com.sun.rave.web.ui.component.util.event;
042:
043: import com.sun.rave.web.ui.component.util.descriptors.LayoutElement;
044:
045: import java.util.EventObject;
046:
047: import javax.faces.context.FacesContext;
048:
049: /**
050: *
051: * @author Ken Paulsen (ken.paulsen@sun.com)
052: */
053: public class HandlerContextImpl implements HandlerContext {
054:
055: /**
056: * Constructor
057: */
058: public HandlerContextImpl(FacesContext context,
059: LayoutElement layoutDesc, EventObject event,
060: String eventType) {
061: _facesContext = context;
062: _layoutDesc = layoutDesc;
063: _event = event;
064: _eventType = eventType;
065: }
066:
067: /**
068: * <P> Constructor that gets all its values from the given
069: * HandlerContext.</P>
070: *
071: * @param context The HandlerContext to clone.
072: */
073: public HandlerContextImpl(HandlerContext context) {
074: _facesContext = context.getFacesContext();
075: _layoutDesc = context.getLayoutElement();
076: _event = context.getEventObject();
077: _eventType = context.getEventType();
078: _handler = context.getHandler();
079: }
080:
081: /**
082: * <P> Accessor for the FacesContext.</P>
083: *
084: * @return FacesContext
085: */
086: public FacesContext getFacesContext() {
087: return _facesContext;
088: }
089:
090: /**
091: * <P> Accessor for the LayoutElement associated with this Handler.</P>
092: */
093: public LayoutElement getLayoutElement() {
094: return _layoutDesc;
095: }
096:
097: /**
098: * <P> Accessor for the EventObject associated with this Handler. This
099: * may be null if an EventObject was not created for this handler.
100: * An EventObject, if it does exist, may provide additional details
101: * describing the context in which this Event is invoked.</P>
102: */
103: public EventObject getEventObject() {
104: return _event;
105: }
106:
107: /**
108: * <P> This method provides access to the EventType. This is mostly
109: * helpful for diagnostics, but may be used in a handler to determine
110: * more information about the context in which the code is
111: * executing.</P>
112: */
113: public String getEventType() {
114: return _eventType;
115: }
116:
117: /**
118: * <P> Accessor for the Handler descriptor for this Handler. The Handler
119: * descriptor object contains specific meta information describing
120: * the invocation of this handler. This includes details such as
121: * input values, and where output values are to be set.</P>
122: */
123: public Handler getHandler() {
124: return _handler;
125: }
126:
127: /**
128: * <P> Setter for the Handler descriptor for this Handler.</P>
129: */
130: public void setHandler(Handler handler) {
131: _handler = handler;
132: }
133:
134: /**
135: * <P> Accessor for the Handler descriptor for this Handler. The
136: * HandlerDefinition descriptor contains meta information about the
137: * actual Java handler that will handle the processing. This
138: * includes the inputs required, outputs produces, and the types for
139: * both.</P>
140: */
141: public HandlerDefinition getHandlerDefinition() {
142: return _handler.getHandlerDefinition();
143: }
144:
145: /**
146: * <P> This method returns the value for the named input. Input values
147: * are not stored in this HandlerContext itself, but in the Handler.
148: * If you are trying to set input values for a handler, you must
149: * create a new Handler object and set its input values.</P>
150: *
151: * <P> This method attempts to resolve $...{...} expressions. It also
152: * will return the default value if the value is null. If you don't
153: * want these things to happen, look at
154: * Handler.getInputValue(String).</P>
155: *
156: * @param name The input name
157: *
158: * @return The value of the input (null if not found)
159: */
160: public Object getInputValue(String name) {
161: return getHandler().getInputValue(this , name);
162: }
163:
164: /**
165: * <P> This method retrieves an Output value. Output values must not be
166: * stored in this Context itself (remember HandlerContext objects
167: * are shared). Output values are stored according to what is
168: * specified in the HandlerDefintion.</P>
169: *
170: * @param name The output name
171: *
172: * @return The value of the output (null if not found)
173: */
174: public Object getOutputValue(String name) {
175: return getHandler().getOutputValue(this , name);
176: }
177:
178: /**
179: * <P> This method sets an Output value. Output values must not be
180: * stored in this Context itself (remember HandlerContext objects
181: * are shared). Output values are stored according to what is
182: * specified in the HandlerDefintion.</P>
183: */
184: public void setOutputValue(String name, Object value) {
185: getHandler().setOutputValue(this , name, value);
186: }
187:
188: private String _eventType = null;
189: private FacesContext _facesContext = null;
190: private LayoutElement _layoutDesc = null;
191: private EventObject _event = null;
192: private Handler _handler = null;
193: }
|