tobago-core/src/main/java/org/apache/myfaces/tobago/internal/taglib/declaration/HasSanitize.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.myfaces.tobago.internal.taglib.declaration;

import org.apache.myfaces.tobago.apt.annotation.TagAttribute;
import org.apache.myfaces.tobago.apt.annotation.UIComponentTagAttribute;
import org.apache.myfaces.tobago.sanitizer.SanitizeMode;

public interface HasSanitize {
  /**
   * Should HTML content sanitized?
   * The effect of sanitizing depends on the configuration.
   * The value "auto" means, that sanitizing take place for
   * <ul>
   *   <li>tc:out when escape="false" or</li>
   *   <li>tc:textarea when attribute data-html-editor is set,</li>
   * </ul>
   * because that are the critical parts.
   */
  @TagAttribute
  @UIComponentTagAttribute(
      type = "org.apache.myfaces.tobago.sanitizer.SanitizeMode",
      defaultValue = SanitizeMode.AUTO,
      allowedValues = {SanitizeMode.AUTO, SanitizeMode.NEVER},
      defaultCode = "org.apache.myfaces.tobago.sanitizer.SanitizeMode.auto")
  void setSanitize(String sanitize);
}