com.phloc.html.hc.customize.IHCCustomizer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of phloc-html Show documentation

There is a newer version: 4.4.9

/**
 * Copyright (C) 2006-2015 phloc systems
 * http://www.phloc.com
 * office[at]phloc[dot]com
 *
 * Licensed 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 com.phloc.html.hc.customize;

import java.util.List;

import javax.annotation.Nonnull;

import com.phloc.html.EHTMLVersion;
import com.phloc.html.hc.IHCHasChildrenMutable;
import com.phloc.html.hc.IHCNode;
import com.phloc.html.hc.html.HCBody;
import com.phloc.html.hc.html.HCHead;

/**
 * A special customization interface, that lets you modify existing elements
 * before they are assembled and emitted in the HTML code.
 * 
 * @author Philip Helger
 */
public interface IHCCustomizer
{
  /**
   * Customize HC node with some predefined classes etc.
   * 
   * @param aParentElement
   *        The parent element of the element to be customized. May not be
   *        null.
   * @param aNode
   *        The element to be customized. Never null.
   * @param eHTMLVersion
   *        The HTML version to be used. Never null.
   */
  void customizeNode (@Nonnull IHCHasChildrenMutable  aParentElement,
                      @Nonnull IHCNode aNode,
                      @Nonnull EHTMLVersion eHTMLVersion);

  /**
   * This callback is called, when the main HTML element is assembled, to move
   * the out-of-band nodes to the correct place.
   * 
   * @param aOutOfBandNodes
   *        The non-null list of out-of-band nodes. May be empty.
   * @param aHead
   *        The head element. Never null.
   * @param aBody
   *        The body element. Never null.
   */
  void handleOutOfBandNodes (@Nonnull List  aOutOfBandNodes, @Nonnull HCHead aHead, @Nonnull HCBody aBody);
}