IAttributeConsumer


1   /*
2    * Copyright 2004 The Apache Software Foundation.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   * $Header:$
17   */
18  package org.apache.beehive.netui.tags;
19  
20  import javax.servlet.jsp.JspException  ;
21  
22  /**
23   * This interfaces is implemented by tags that allow attributes to be set
24   * externally to the tag.  The HTML tags for example, allow certain attributes to
25   * be set by children tags through the use of the <code>attribute</code> tag.
26   */
27  public interface IAttributeConsumer
28  {
29      /**
30       * Set an attribute value on the implementing class.  The <code>name</code> represents
31       * the name of the attribute.  The <code>value</code> represents the value and may contains
32       * an expression.  The <code>facet</code> is optional and may be used by complex types to
33       * target the attribute to a sub part of the generated markup. This method may result in errors
34       * being generated.
35       * @param name  The name of the attribute.  This value may not be null or the empty string.
36       * @param value The value of the attribute.  This may contain an expression.
37       * @param facet The name of a facet to which the attribute will be applied.  This is optional.
38       * @throws JspException A JspException may be thrown if there is an error setting the attribute.
39       */
40      void setAttribute(String   name, String   value, String   facet) throws JspException  ;
41  }
42
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags