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  import org.apache.myfaces.tobago.sanitizer.SanitizeMode;
25  
26  public interface HasSanitize {
27    /**
28     * Should HTML content sanitized?
29     * The effect of sanitizing depends on the configuration.
30     * The value "auto" means, that sanitizing take place for
31     * <ul>
32     *   <li>tc:out when escape="false" or</li>
33     *   <li>tc:textarea when attribute data-html-editor is set,</li>
34     * </ul>
35     * because that are the critical parts.
36     */
37    @TagAttribute
38    @UIComponentTagAttribute(
39        type = "org.apache.myfaces.tobago.sanitizer.SanitizeMode",
40        defaultValue = SanitizeMode.STRING_AUTO,
41        allowedValues = {SanitizeMode.STRING_AUTO, SanitizeMode.STRING_NEVER},
42        defaultCode = "org.apache.myfaces.tobago.sanitizer.SanitizeMode.auto")
43    void setSanitize(String sanitize);
44  }