01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: *
17: * $Header:$
18: */
19: package org.apache.beehive.netui.tags;
20:
21: import javax.servlet.jsp.JspException;
22:
23: /**
24: * This interfaces is implemented by tags that allow attributes to be set
25: * externally to the tag. The HTML tags for example, allow certain attributes to
26: * be set by children tags through the use of the <code>attribute</code> tag.
27: */
28: public interface IAttributeConsumer {
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)
41: throws JspException;
42: }
|