View Javadoc

1   /*
2    * $Id: ContextBean.java 651946 2008-04-27 13:41:38Z apetrelli $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *  http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  package org.apache.struts2.components;
23  
24  import org.apache.struts2.views.annotations.StrutsTagAttribute;
25  
26  import com.opensymphony.xwork2.util.ValueStack;
27  
28  /***
29   * Base class for control and data tags
30   */
31  public abstract class ContextBean extends Component {
32      protected String var;
33      
34      public ContextBean(ValueStack stack) {
35          super(stack);
36      }
37  
38      protected void putInContext(Object value) {
39          if (var != null && var.length() > 0) {
40              stack.getContext().put(var, value);
41          }
42      }
43      
44      @StrutsTagAttribute(description="Name used to reference the value pushed into the Value Stack")
45      public void setVar(String var) {
46          if (var != null) {
47              this.var = findString(var);
48          }
49      }
50      
51      /***
52       * To keep backward compatibility 
53       * TODO remove after 2.1
54       */
55      @StrutsTagAttribute(description="Deprecated. Use 'var' instead")
56      public void setId(String id) {
57          setVar(id);
58      }
59      
60      protected String getVar() {
61          return this.var;
62      }
63  }