View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  
20  package org.apache.myfaces.tobago.internal.taglib.declaration;
21  
22  import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
23  import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
24  
25  public interface HasSanitize {
26    /**
27     * Should HTML content sanitized?
28     * The effect of sanitizing depends on the configuration.
29     * The value "auto" means, that sanitizing take place for
30     * <ul>
31     *   <li>tc:out when escape="false" or</li>
32     *   <li>tc:textarea when attribute data-html-editor is set,</li>
33     * </ul>
34     * because that are the critical parts.
35     */
36    @TagAttribute
37    @UIComponentTagAttribute(defaultValue = "auto",
38        allowedValues = {"auto", "never"})
39    void setSanitize(String sanitize);
40  }